summaryrefslogtreecommitdiff
path: root/legacy/emotion/src/lib/Emotion.h
diff options
context:
space:
mode:
authorJonas M. Gastal <jgastal@profusion.mobi>2011-06-30 21:38:44 +0000
committerJonas M. Gastal <jgastal@profusion.mobi>2011-06-30 21:38:44 +0000
commit4450930374988cc607bd52565599a5ffe63439b5 (patch)
tree0c8c212952b36be1221646e58ff4f951b5f2a02c /legacy/emotion/src/lib/Emotion.h
parent54a13c07c068d7c1a29b9e6d04ee70fdb4759110 (diff)
Emotion: emotion play control functions documentation.
SVN revision: 60888
Diffstat (limited to '')
-rw-r--r--legacy/emotion/src/lib/Emotion.h126
1 files changed, 119 insertions, 7 deletions
diff --git a/legacy/emotion/src/lib/Emotion.h b/legacy/emotion/src/lib/Emotion.h
index a9fd1d7266..742cefe1cb 100644
--- a/legacy/emotion/src/lib/Emotion.h
+++ b/legacy/emotion/src/lib/Emotion.h
@@ -269,18 +269,134 @@ EAPI Eina_Bool emotion_object_file_set (Evas_Object *obj, const
269 * @ingroup Emotion_Init 269 * @ingroup Emotion_Init
270 */ 270 */
271EAPI const char *emotion_object_file_get (const Evas_Object *obj); 271EAPI const char *emotion_object_file_get (const Evas_Object *obj);
272/**
273 * @defgroup Emotion_Play Play control functions
274 *
275 * @{
276 *
277 * @brief Set play/pause state of the media file.
278 *
279 * @param obj The emotion object whose state will be changed.
280 * @param play EINA_TRUE to play, EINA_FALSE to pause.
281 *
282 * This functions sets the currently playing status of the video. Using this
283 * function to play or pause the video doesn't alter it's current position.
284 */
272EAPI void emotion_object_play_set (Evas_Object *obj, Eina_Bool play); 285EAPI void emotion_object_play_set (Evas_Object *obj, Eina_Bool play);
286/**
287 * @brief Get play/pause state of the media file.
288 *
289 * @param obj The emotion object from which the state will be retrieved.
290 * @return EINA_TRUE if playing. EINA_FALSE if not playing.
291 */
273EAPI Eina_Bool emotion_object_play_get (const Evas_Object *obj); 292EAPI Eina_Bool emotion_object_play_get (const Evas_Object *obj);
293/**
294 * @brief Set the position in the media file.
295 *
296 * @param obj The emotion object whose position will be changed.
297 * @param sec The position(in seconds) to which the media file will be set.
298 *
299 * This functions sets the current position of the media file to @p sec, this
300 * only works on seekable streams. Setting the position doesn't change the
301 * playing state of the media file.
302 *
303 * @see emotion_object_seekable_get
304 */
274EAPI void emotion_object_position_set (Evas_Object *obj, double sec); 305EAPI void emotion_object_position_set (Evas_Object *obj, double sec);
306/**
307 * @brief Get the position in the media file.
308 *
309 * @param obj The emotion object from which the position will be retrieved.
310 * @return The position of the media file.
311 *
312 * The position is returned as the number of seconds since the beggining of the
313 * media file.
314 */
275EAPI double emotion_object_position_get (const Evas_Object *obj); 315EAPI double emotion_object_position_get (const Evas_Object *obj);
276EAPI Eina_Bool emotion_object_video_handled_get (const Evas_Object *obj); 316/**
277EAPI Eina_Bool emotion_object_audio_handled_get (const Evas_Object *obj); 317 * @brief Get whether the media file is seekable.
318 *
319 * @param obj The emotion object from which the seekable status will be
320 * retrieved.
321 * @return EINA_TRUE if the media file is seekable, EINA_FALSE otherwise.
322 */
278EAPI Eina_Bool emotion_object_seekable_get (const Evas_Object *obj); 323EAPI Eina_Bool emotion_object_seekable_get (const Evas_Object *obj);
324/**
325 * @brief Get the length of play for the media file.
326 *
327 * @param obj The emotion object from which the length will be retrieved.
328 * @return The length of the media file in seconds.
329 *
330 * This function returns the length of the media file in seconds.
331 *
332 * @warning This will return 0 if called before the "length_change" signal has,
333 * been emitted.
334 */
279EAPI double emotion_object_play_length_get (const Evas_Object *obj); 335EAPI double emotion_object_play_length_get (const Evas_Object *obj);
336/**
337 * @brief Gets the native aspect ratio of the media file.
338 *
339 * @param obj The emotion object from which the ratio will be retrieved.
340 * @return The aspect ration of the video.
341 *
342 * This function returns the aspect ratio of the video file being played. The
343 * aspect is width divided by height.
344 *
345 * @warning For audio files this function returns 0.
346 */
347EAPI double emotion_object_ratio_get (const Evas_Object *obj);
348/**
349 * @brief Set the play speed of the media file.
350 *
351 * @param obj The emotion object whose speed will be set.
352 * @param speed The speed to be set in the range [0,infinity)
353 *
354 * This function sets the speed with which the media file will be played. 1.0
355 * represents the normal speed, 2 double speed, 0.5 half speed and so on.
356 *
357 * @warning The only backend that implements this is the experimental VLC
358 * backend.
359 */
360EAPI void emotion_object_play_speed_set (Evas_Object *obj, double speed);
361/**
362 * @brief Get the play speed of the media file.
363 *
364 * @param obj The emotion object from which the filename will be retrieved.
365 * @return The current speed of the media file.
366 *
367 * @see emotion_object_play_speed_set
368 */
369EAPI double emotion_object_play_speed_get (const Evas_Object *obj);
370/**
371 * @brief Get how much of the file has been played.
372 *
373 * @param obj The emotion object from which the filename will be retrieved.
374 * @return The progress of the media file.
375 *
376 * @warning Don't change of free the returned string.
377 * @warning gstreamer xine backends don't implement this(will return NULL).
378 */
379EAPI const char *emotion_object_progress_info_get (const Evas_Object *obj);
380/**
381 * @brief Get how much of the file has been played.
382 *
383 * @param obj The emotion object from which the filename will be retrieved
384 * @return The progress of the media file.
385 *
386 * This function gets the progress in playing the file, the return value is in
387 * the [0, 1] range.
388 *
389 * @warning gstreamer xine backends don't implement this(will return 0).
390 */
391EAPI double emotion_object_progress_status_get (const Evas_Object *obj);
392/**
393 * @}
394 */
395EAPI Eina_Bool emotion_object_video_handled_get (const Evas_Object *obj);
396EAPI Eina_Bool emotion_object_audio_handled_get (const Evas_Object *obj);
280EAPI void emotion_object_size_get (const Evas_Object *obj, int *iw, int *ih); 397EAPI void emotion_object_size_get (const Evas_Object *obj, int *iw, int *ih);
281EAPI void emotion_object_smooth_scale_set (Evas_Object *obj, Eina_Bool smooth); 398EAPI void emotion_object_smooth_scale_set (Evas_Object *obj, Eina_Bool smooth);
282EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj); 399EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj);
283EAPI double emotion_object_ratio_get (const Evas_Object *obj);
284EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev); 400EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev);
285 401
286/** 402/**
@@ -370,12 +486,8 @@ EAPI int emotion_object_chapter_count (const Evas_Object *obj);
370EAPI void emotion_object_chapter_set (Evas_Object *obj, int chapter); 486EAPI void emotion_object_chapter_set (Evas_Object *obj, int chapter);
371EAPI int emotion_object_chapter_get (const Evas_Object *obj); 487EAPI int emotion_object_chapter_get (const Evas_Object *obj);
372EAPI const char *emotion_object_chapter_name_get (const Evas_Object *obj, int chapter); 488EAPI const char *emotion_object_chapter_name_get (const Evas_Object *obj, int chapter);
373EAPI void emotion_object_play_speed_set (Evas_Object *obj, double speed);
374EAPI double emotion_object_play_speed_get (const Evas_Object *obj);
375EAPI void emotion_object_eject (Evas_Object *obj); 489EAPI void emotion_object_eject (Evas_Object *obj);
376EAPI const char *emotion_object_title_get (const Evas_Object *obj); 490EAPI const char *emotion_object_title_get (const Evas_Object *obj);
377EAPI const char *emotion_object_progress_info_get (const Evas_Object *obj);
378EAPI double emotion_object_progress_status_get (const Evas_Object *obj);
379EAPI const char *emotion_object_ref_file_get (const Evas_Object *obj); 491EAPI const char *emotion_object_ref_file_get (const Evas_Object *obj);
380EAPI int emotion_object_ref_num_get (const Evas_Object *obj); 492EAPI int emotion_object_ref_num_get (const Evas_Object *obj);
381EAPI int emotion_object_spu_button_count_get (const Evas_Object *obj); 493EAPI int emotion_object_spu_button_count_get (const Evas_Object *obj);