summaryrefslogtreecommitdiff
path: root/src/lib/emotion/Emotion.h
diff options
context:
space:
mode:
authorPhilippe Caseiro <pcaseiro@cadoles.com>2014-10-20 15:27:06 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:32:22 +0200
commitacfd5a82567c39baf1ad5afb4add97653c05cb0c (patch)
tree4ad106f9a8bb1ee58d1880e4d1f1ace6f574afab /src/lib/emotion/Emotion.h
parentde18cf3b8c93f87c2958bbb860e989dc2f6b2a11 (diff)
emotion: updating API documentation.
Diffstat (limited to 'src/lib/emotion/Emotion.h')
-rw-r--r--src/lib/emotion/Emotion.h51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/lib/emotion/Emotion.h b/src/lib/emotion/Emotion.h
index bb41cbeaf9..a776084d38 100644
--- a/src/lib/emotion/Emotion.h
+++ b/src/lib/emotion/Emotion.h
@@ -367,7 +367,19 @@ extern "C" {
367 * @defgroup Emotion_Ressource Video ressource management 367 * @defgroup Emotion_Ressource Video ressource management
368 */ 368 */
369 369
370/**
371 * @brief Initialise Emotion library
372 *
373 * Initialise needed libraries like eina ecore eet
374 * Initialise needed modules like webcam
375 */
370EAPI Eina_Bool emotion_init(void); 376EAPI Eina_Bool emotion_init(void);
377
378/**
379 * @brief Shutdown Emotion library
380 *
381 * Proper shutdown of all loaded modules and initialised libraries.
382 */
371EAPI Eina_Bool emotion_shutdown(void); 383EAPI Eina_Bool emotion_shutdown(void);
372 384
373/** 385/**
@@ -854,6 +866,15 @@ EAPI void emotion_object_smooth_scale_set (Evas_Object *obj, Eina_B
854 * @ingroup Emotion_Video 866 * @ingroup Emotion_Video
855 */ 867 */
856EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj); 868EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj);
869
870/**
871 * @brief Send an Emotion Event to an Evas object
872 *
873 * @param obj The object target of the event.
874 * @param ev The emotion event.
875 *
876 * @see Emotion_Event
877 */
857EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev); 878EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev);
858 879
859/** 880/**
@@ -1004,8 +1025,38 @@ EAPI const char *emotion_object_video_subtitle_file_get (const Evas_Object *ob
1004 * @ingroup Emotion_Video 1025 * @ingroup Emotion_Video
1005 */ 1026 */
1006EAPI int emotion_object_video_channel_count (const Evas_Object *obj); 1027EAPI int emotion_object_video_channel_count (const Evas_Object *obj);
1028
1029/**
1030 * @brief Get the name of a given video channel
1031 *
1032 * @param obj The object which we are retrieving the channel name from
1033 * @param channel the channel number
1034 * @return the channel name.
1035 *
1036 * @see emotion_object_video_channel_count()
1037 *
1038 * @ingroup Emotion_Video
1039 */
1007EAPI const char *emotion_object_video_channel_name_get(const Evas_Object *obj, int channel); 1040EAPI const char *emotion_object_video_channel_name_get(const Evas_Object *obj, int channel);
1041
1042/**
1043 * @brief Set the channel for a given video object
1044 *
1045 * @param obj The target object which we are setting the channel
1046 * @param channel the channel number to be setted.
1047 *
1048 * @ingroup Emotion_Video
1049 */
1008EAPI void emotion_object_video_channel_set (Evas_Object *obj, int channel); 1050EAPI void emotion_object_video_channel_set (Evas_Object *obj, int channel);
1051
1052/**
1053 * @brief Get the channel for a given video object
1054 *
1055 * @param obj The target object which we are getting the channel
1056 * @return The current channel number.
1057 *
1058 * @ingroup Emotion_Video
1059 */
1009EAPI int emotion_object_video_channel_get (const Evas_Object *obj); 1060EAPI int emotion_object_video_channel_get (const Evas_Object *obj);
1010EAPI void emotion_object_spu_mute_set (Evas_Object *obj, Eina_Bool mute); 1061EAPI void emotion_object_spu_mute_set (Evas_Object *obj, Eina_Bool mute);
1011EAPI Eina_Bool emotion_object_spu_mute_get (const Evas_Object *obj); 1062EAPI Eina_Bool emotion_object_spu_mute_get (const Evas_Object *obj);