summaryrefslogtreecommitdiff
path: root/src/lib/elm_video_eo.h
blob: 6baa254b6367a8318e64e0d23588c7a6136ee280 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
#define ELM_OBJ_PLAYER_CLASS elm_obj_player_class_get()

const Eo_Class *elm_obj_player_class_get(void) EINA_CONST;

extern EAPI Eo_Op ELM_OBJ_PLAYER_BASE_ID;

enum
{
   ELM_OBJ_PLAYER_SUB_ID_LAST
};

#define ELM_OBJ_PLAYER_ID(sub_id) (ELM_OBJ_PLAYER_BASE_ID + sub_id)

/**
 * ELM_OBJ_VIDEO_CLASS
 */
#define ELM_OBJ_VIDEO_CLASS elm_obj_video_class_get()

const Eo_Class *elm_obj_video_class_get(void) EINA_CONST;

extern EAPI Eo_Op ELM_OBJ_VIDEO_BASE_ID;

enum
{
   ELM_OBJ_VIDEO_SUB_ID_FILE_SET,
   ELM_OBJ_VIDEO_SUB_ID_EMOTION_GET,
   ELM_OBJ_VIDEO_SUB_ID_PLAY,
   ELM_OBJ_VIDEO_SUB_ID_PAUSE,
   ELM_OBJ_VIDEO_SUB_ID_STOP,
   ELM_OBJ_VIDEO_SUB_ID_IS_PLAYING_GET,
   ELM_OBJ_VIDEO_SUB_ID_IS_SEEKABLE_GET,
   ELM_OBJ_VIDEO_SUB_ID_AUDIO_MUTE_GET,
   ELM_OBJ_VIDEO_SUB_ID_AUDIO_MUTE_SET,
   ELM_OBJ_VIDEO_SUB_ID_AUDIO_LEVEL_GET,
   ELM_OBJ_VIDEO_SUB_ID_AUDIO_LEVEL_SET,
   ELM_OBJ_VIDEO_SUB_ID_PLAY_POSITION_GET,
   ELM_OBJ_VIDEO_SUB_ID_PLAY_POSITION_SET,
   ELM_OBJ_VIDEO_SUB_ID_PLAY_LENGTH_GET,
   ELM_OBJ_VIDEO_SUB_ID_TITLE_GET,
   ELM_OBJ_VIDEO_SUB_ID_REMEMBER_POSITION_SET,
   ELM_OBJ_VIDEO_SUB_ID_REMEMBER_POSITION_GET,
   ELM_OBJ_VIDEO_SUB_ID_LAST
};

#define ELM_OBJ_VIDEO_ID(sub_id) (ELM_OBJ_VIDEO_BASE_ID + sub_id)


/**
 * @def elm_obj_video_file_set
 * @since 1.8
 *
 * @brief Define the file or URI that will be the video source.
 *
 * @param[in] filename
 * @param[out] ret
 *
 * @see elm_video_file_set
 *
 * @ingroup Video
 */
#define elm_obj_video_file_set(filename, ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_FILE_SET), EO_TYPECHECK(const char *, filename), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_video_emotion_get
 * @since 1.8
 *
 * @brief Get the underlying Emotion object.
 *
 * @param[out] ret
 *
 * @see elm_video_emotion_get
 *
 * @ingroup Video
 */
#define elm_obj_video_emotion_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_EMOTION_GET), EO_TYPECHECK(Evas_Object **, ret)

/**
 * @def elm_obj_video_play
 * @since 1.8
 *
 * @brief Start to play the video
 *
 *
 * @see elm_video_play
 *
 * @ingroup Video
 */
#define elm_obj_video_play() ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_PLAY)

/**
 * @def elm_obj_video_pause
 * @since 1.8
 *
 * @brief Pause the video
 *
 *
 * @see elm_video_pause
 *
 * @ingroup Video
 */
#define elm_obj_video_pause() ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_PAUSE)

/**
 * @def elm_obj_video_stop
 * @since 1.8
 *
 * @brief Stop the video
 *
 *
 * @see elm_video_stop
 *
 * @ingroup Video
 */
#define elm_obj_video_stop() ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_STOP)

/**
 * @def elm_obj_video_is_playing_get
 * @since 1.8
 *
 * @brief Is the video actually playing.
 *
 * @param[out] ret
 *
 * @see elm_video_is_playing_get
 *
 * @ingroup Video
 */
#define elm_obj_video_is_playing_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_IS_PLAYING_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_video_is_seekable_get
 * @since 1.8
 *
 * @brief Is it possible to seek inside the video.
 *
 * @param[out] ret
 *
 * @see elm_video_is_seekable_get
 *
 * @ingroup Video
 */
#define elm_obj_video_is_seekable_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_IS_SEEKABLE_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_video_audio_mute_get
 * @since 1.8
 *
 * @brief Is the audio muted.
 *
 * @param[out] ret
 *
 * @see elm_video_audio_mute_get
 *
 * @ingroup Video
 */
#define elm_obj_video_audio_mute_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_AUDIO_MUTE_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_video_audio_mute_set
 * @since 1.8
 *
 * @brief Change the mute state of the Elm_Video object.
 *
 * @param[in] mute
 *
 * @see elm_video_audio_mute_set
 *
 * @ingroup Video
 */
#define elm_obj_video_audio_mute_set(mute) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_AUDIO_MUTE_SET), EO_TYPECHECK(Eina_Bool, mute)

/**
 * @def elm_obj_video_audio_level_get
 * @since 1.8
 *
 * @brief Get the audio level of the current video.
 *
 * @param[out] ret
 *
 * @see elm_video_audio_level_get
 *
 * @ingroup Video
 */
#define elm_obj_video_audio_level_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_AUDIO_LEVEL_GET), EO_TYPECHECK(double *, ret)

/**
 * @def elm_obj_video_audio_level_set
 * @since 1.8
 *
 * @brief Set the audio level of an Elm_Video object.
 *
 * @param[in] volume
 *
 * @see elm_video_audio_level_set
 *
 * @ingroup Video
 */
#define elm_obj_video_audio_level_set(volume) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_AUDIO_LEVEL_SET), EO_TYPECHECK(double, volume)

/**
 * @def elm_obj_video_play_position_get
 * @since 1.8
 *
 * @brief Get the current position (in seconds) being played in the
 * Elm_Video object.
 *
 * @param[out] ret
 *
 * @see elm_video_play_position_get
 *
 * @ingroup Video
 */
#define elm_obj_video_play_position_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_PLAY_POSITION_GET), EO_TYPECHECK(double *, ret)

/**
 * @def elm_obj_video_play_position_set
 * @since 1.8
 *
 * @brief Set the current position (in seconds) to be played in the
 * Elm_Video object.
 *
 * @param[in] position
 *
 * @see elm_video_play_position_set
 *
 * @ingroup Video
 */
#define elm_obj_video_play_position_set(position) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_PLAY_POSITION_SET), EO_TYPECHECK(double, position)

/**
 * @def elm_obj_video_play_length_get
 * @since 1.8
 *
 * @brief Get the total playing time (in seconds) of the Elm_Video object.
 *
 * @param[out] ret
 *
 * @see elm_video_play_length_get
 *
 * @ingroup Video
 */
#define elm_obj_video_play_length_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_PLAY_LENGTH_GET), EO_TYPECHECK(double *, ret)

/**
 * @def elm_obj_video_title_get
 * @since 1.8
 *
 * @brief Get the title (for instance DVD title) from this emotion object.
 *
 * @param[out] ret
 *
 * @see elm_video_title_get
 *
 * @ingroup Video
 */
#define elm_obj_video_title_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_TITLE_GET), EO_TYPECHECK(const char **, ret)

/**
 * @def elm_obj_video_remember_position_set
 * @since 1.8
 *
 * @brief Set whether the object can remember the last played position.
 *
 * @param[in] remember
 *
 * @see elm_video_remember_position_set
 *
 * @ingroup Video
 */
#define elm_obj_video_remember_position_set(remember) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_REMEMBER_POSITION_SET), EO_TYPECHECK(Eina_Bool, remember)

/**
 * @def elm_obj_video_remember_position_get
 * @since 1.8
 *
 * @brief Set whether the object can remember the last played position.
 *
 * @param[out] ret
 *
 * @see elm_video_remember_position_get
 *
 * @ingroup Video
 */
#define elm_obj_video_remember_position_get(ret) ELM_OBJ_VIDEO_ID(ELM_OBJ_VIDEO_SUB_ID_REMEMBER_POSITION_GET), EO_TYPECHECK(Eina_Bool *, ret)