Emotion.h File Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files
- Examples

- File List
- Globals

Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
Emotion.h File Reference

Emotion Media Library. More...

## Data Structures
struct | _Emotion_Version

## Macros
#define | EAPI
#define | EMOTION_CHANNEL_AUTO -1
#define | EMOTION_CHANNEL_DEFAULT 0
#define | EMOTION_VERSION_MAJOR EFL_VERSION_MAJOR
#define | EMOTION_VERSION_MINOR EFL_VERSION_MINOR

## Typedefs
typedef enum _Emotion_Module | Emotion_Module
typedef enum _Emotion_Event | Emotion_Event
typedef enum _Emotion_Meta_Info | Emotion_Meta_Info
| Meta info type to be retrieved. More...
typedef enum _Emotion_Vis | Emotion_Vis
| Type of visualization. More...
typedef enum _Emotion_Aspect | Emotion_Aspect
| Aspect ratio option. More...
typedef struct _Emotion_Version | Emotion_Version
| Represents the current version of Emotion.
typedef struct _Emotion_Webcam | Emotion_Webcam
| Webcam description.

## Enumerations
enum | _Emotion_Module { EMOTION_MODULE_XINE, EMOTION_MODULE_GSTREAMER }
enum | _Emotion_Event { EMOTION_EVENT_MENU1, EMOTION_EVENT_MENU2, EMOTION_EVENT_MENU3, EMOTION_EVENT_MENU4, EMOTION_EVENT_MENU5, EMOTION_EVENT_MENU6, EMOTION_EVENT_MENU7, EMOTION_EVENT_UP, EMOTION_EVENT_DOWN, EMOTION_EVENT_LEFT, EMOTION_EVENT_RIGHT, EMOTION_EVENT_SELECT, EMOTION_EVENT_NEXT, EMOTION_EVENT_PREV, EMOTION_EVENT_ANGLE_NEXT, EMOTION_EVENT_ANGLE_PREV, EMOTION_EVENT_FORCE, EMOTION_EVENT_0, EMOTION_EVENT_1, EMOTION_EVENT_2, EMOTION_EVENT_3, EMOTION_EVENT_4, EMOTION_EVENT_5, EMOTION_EVENT_6, EMOTION_EVENT_7, EMOTION_EVENT_8, EMOTION_EVENT_9, EMOTION_EVENT_10 }
enum | _Emotion_Meta_Info { EMOTION_META_INFO_TRACK_TITLE, EMOTION_META_INFO_TRACK_ARTIST, EMOTION_META_INFO_TRACK_ALBUM, EMOTION_META_INFO_TRACK_YEAR, EMOTION_META_INFO_TRACK_GENRE, EMOTION_META_INFO_TRACK_COMMENT, EMOTION_META_INFO_TRACK_DISC_ID, EMOTION_META_INFO_TRACK_COUNT }
| Used for retrieving information about the media file being played. More...
enum | _Emotion_Vis { EMOTION_VIS_NONE, EMOTION_VIS_GOOM, EMOTION_VIS_LIBVISUAL_BUMPSCOPE, EMOTION_VIS_LIBVISUAL_CORONA, EMOTION_VIS_LIBVISUAL_DANCING_PARTICLES, EMOTION_VIS_LIBVISUAL_GDKPIXBUF, EMOTION_VIS_LIBVISUAL_G_FORCE, EMOTION_VIS_LIBVISUAL_GOOM, EMOTION_VIS_LIBVISUAL_INFINITE, EMOTION_VIS_LIBVISUAL_JAKDAW, EMOTION_VIS_LIBVISUAL_JESS, EMOTION_VIS_LIBVISUAL_LV_ANALYSER, EMOTION_VIS_LIBVISUAL_LV_FLOWER, EMOTION_VIS_LIBVISUAL_LV_GLTEST, EMOTION_VIS_LIBVISUAL_LV_SCOPE, EMOTION_VIS_LIBVISUAL_MADSPIN, EMOTION_VIS_LIBVISUAL_NEBULUS, EMOTION_VIS_LIBVISUAL_OINKSIE, EMOTION_VIS_LIBVISUAL_PLASMA, EMOTION_VIS_LAST }
| Used for displaying a visualization on the emotion object. More...
enum | Emotion_Suspend { EMOTION_WAKEUP, EMOTION_SLEEP, EMOTION_DEEP_SLEEP, EMOTION_HIBERNATE }
| Used for emotion pipeline ressource management. More...
enum | _Emotion_Aspect { EMOTION_ASPECT_KEEP_NONE, EMOTION_ASPECT_KEEP_WIDTH, EMOTION_ASPECT_KEEP_HEIGHT, EMOTION_ASPECT_KEEP_BOTH, EMOTION_ASPECT_CROP, EMOTION_ASPECT_CUSTOM }
| Defines the aspect ratio option. More...

## Functions
EAPI Eina_Bool | emotion_init (void)
| Initialise Emotion library. More...
EAPI Eina_Bool | emotion_shutdown (void)
| Shutdown Emotion library. More...
EAPI Evas_Object * | emotion_object_add (Evas *evas)
| Add an emotion object to the canvas. More...
EAPI void | emotion_object_border_set (Evas_Object *obj, int l, int r, int t, int b)
| Set borders for the emotion object. More...
EAPI void | emotion_object_border_get (const Evas_Object *obj, int *l, int *r, int *t, int *b)
| Get the borders set for the emotion object. More...
EAPI void | emotion_object_bg_color_set (Evas_Object *obj, int r, int g, int b, int a)
| Set a color for the background rectangle of this emotion object. More...
EAPI void | emotion_object_bg_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
| Get the background color set for the emotion object. More...
EAPI void | emotion_object_keep_aspect_set (Evas_Object *obj, Emotion_Aspect a)
| Set whether emotion should keep the aspect ratio of the video. More...
EAPI Emotion_Aspect | emotion_object_keep_aspect_get (const Evas_Object *obj)
| Get the current emotion aspect ratio policy. More...
EAPI Eina_Bool | emotion_object_file_set (Evas_Object *obj, const char *filename)
| Set the file to be played in the Emotion object. More...
EAPI const char * | emotion_object_file_get (const Evas_Object *obj)
| Get the filename of the file associated with the emotion object. More...
EAPI void | emotion_object_play_set (Evas_Object *obj, Eina_Bool play)
| Set play/pause state of the media file. More...
EAPI Eina_Bool | emotion_object_play_get (const Evas_Object *obj)
| Get play/pause state of the media file. More...
EAPI void | emotion_object_position_set (Evas_Object *obj, double sec)
| Set the position in the media file. More...
EAPI double | emotion_object_position_get (const Evas_Object *obj)
| Get the position in the media file. More...
EAPI double | emotion_object_buffer_size_get (const Evas_Object *obj)
| Get the percentual size of the buffering cache. More...
EAPI Eina_Bool | emotion_object_seekable_get (const Evas_Object *obj)
| Get whether the media file is seekable. More...
EAPI double | emotion_object_play_length_get (const Evas_Object *obj)
| Get the length of play for the media file. More...
EAPI void | emotion_object_play_speed_set (Evas_Object *obj, double speed)
| Set the play speed of the media file. More...
EAPI double | emotion_object_play_speed_get (const Evas_Object *obj)
| Get the play speed of the media file. More...
EAPI const char * | emotion_object_progress_info_get (const Evas_Object *obj)
| Get how much of the file has been played. More...
EAPI double | emotion_object_progress_status_get (const Evas_Object *obj)
| Get how much of the file has been played. More...
EAPI Eina_Bool | emotion_object_video_handled_get (const Evas_Object *obj)
EAPI Eina_Bool | emotion_object_audio_handled_get (const Evas_Object *obj)
EAPI double | emotion_object_ratio_get (const Evas_Object *obj)
| Retrieve the video aspect ratio of the media file loaded. More...
EAPI void | emotion_object_size_get (const Evas_Object *obj, int *iw, int *ih)
| Retrieve the video size of the loaded file. More...
EAPI void | emotion_object_smooth_scale_set (Evas_Object *obj, Eina_Bool smooth)
| Sets whether to use of high-quality image scaling algorithm of the given video object. More...
EAPI Eina_Bool | emotion_object_smooth_scale_get (const Evas_Object *obj)
| Gets whether the high-quality image scaling algorithm of the given video object is used. More...
EAPI void | emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev)
| Send an Emotion Event to an Evas object. More...
EAPI void | emotion_object_audio_volume_set (Evas_Object *obj, double vol)
| Set the audio volume. More...
EAPI double | emotion_object_audio_volume_get (const Evas_Object *obj)
| Get the audio volume. More...
EAPI void | emotion_object_audio_mute_set (Evas_Object *obj, Eina_Bool mute)
| Set the mute audio option for this object. More...
EAPI Eina_Bool | emotion_object_audio_mute_get (const Evas_Object *obj)
| Get the mute audio option of this object. More...
EAPI int | emotion_object_audio_channel_count (const Evas_Object *obj)
EAPI const char * | emotion_object_audio_channel_name_get (const Evas_Object *obj, int channel)
EAPI void | emotion_object_audio_channel_set (Evas_Object *obj, int channel)
EAPI int | emotion_object_audio_channel_get (const Evas_Object *obj)
EAPI void | emotion_object_video_mute_set (Evas_Object *obj, Eina_Bool mute)
| Set the mute video option for this object. More...
EAPI Eina_Bool | emotion_object_video_mute_get (const Evas_Object *obj)
| Get the mute video option of this object. More...
EAPI void | emotion_object_video_subtitle_file_set (Evas_Object *obj, const char *filepath)
| Set the video's subtitle file path. More...
EAPI const char * | emotion_object_video_subtitle_file_get (const Evas_Object *obj)
| Get the video's subtitle file path. More...
EAPI int | emotion_object_video_channel_count (const Evas_Object *obj)
| Get the number of available video channel. More...
EAPI const char * | emotion_object_video_channel_name_get (const Evas_Object *obj, int channel)
| Get the name of a given video channel. More...
EAPI void | emotion_object_video_channel_set (Evas_Object *obj, int channel)
| Set the channel for a given video object. More...
EAPI int | emotion_object_video_channel_get (const Evas_Object *obj)
| Get the channel for a given video object. More...
EAPI void | emotion_object_spu_mute_set (Evas_Object *obj, Eina_Bool mute)
EAPI Eina_Bool | emotion_object_spu_mute_get (const Evas_Object *obj)
EAPI int | emotion_object_spu_channel_count (const Evas_Object *obj)
EAPI const char * | emotion_object_spu_channel_name_get (const Evas_Object *obj, int channel)
EAPI void | emotion_object_spu_channel_set (Evas_Object *obj, int channel)
EAPI int | emotion_object_spu_channel_get (const Evas_Object *obj)
EAPI int | emotion_object_chapter_count (const Evas_Object *obj)
EAPI void | emotion_object_chapter_set (Evas_Object *obj, int chapter)
EAPI int | emotion_object_chapter_get (const Evas_Object *obj)
EAPI const char * | emotion_object_chapter_name_get (const Evas_Object *obj, int chapter)
EAPI void | emotion_object_eject (Evas_Object *obj)
EAPI const char * | emotion_object_title_get (const Evas_Object *obj)
| Get the dvd title from this emotion object. More...
EAPI const char * | emotion_object_ref_file_get (const Evas_Object *obj)
EAPI int | emotion_object_ref_num_get (const Evas_Object *obj)
EAPI int | emotion_object_spu_button_count_get (const Evas_Object *obj)
EAPI int | emotion_object_spu_button_get (const Evas_Object *obj)
EAPI const char * | emotion_object_meta_info_get (const Evas_Object *obj, Emotion_Meta_Info meta)
| Retrieve meta information from this file being played. More...
EAPI void | emotion_object_vis_set (Evas_Object *obj, Emotion_Vis visualization)
| Set the visualization to be used with this object. More...
EAPI Emotion_Vis | emotion_object_vis_get (const Evas_Object *obj)
| Get the type of visualization in use by this emotion object. More...
EAPI Eina_Bool | emotion_object_vis_supported (const Evas_Object *obj, Emotion_Vis visualization)
| Query whether a type of visualization is supported by this object. More...
EAPI void | emotion_object_priority_set (Evas_Object *obj, Eina_Bool priority)
| Raise priority of an object so it will have a priviledged access to hardware ressource. More...
EAPI Eina_Bool | emotion_object_priority_get (const Evas_Object *obj)
| Get the actual priority of an object. More...
EAPI void | emotion_object_suspend_set (Evas_Object *obj, Emotion_Suspend state)
| Change the state of an object pipeline. More...
EAPI Emotion_Suspend | emotion_object_suspend_get (Evas_Object *obj)
| Get the current state of the pipeline. More...
EAPI void | emotion_object_last_position_load (Evas_Object *obj)
| Load the last known position if available. More...
EAPI void | emotion_object_last_position_save (Evas_Object *obj)
| Save the lastest position if possible. More...
EAPI Eina_Bool | emotion_object_extension_may_play_fast_get (const char *file)
| Do we have a chance to play that file. More...
EAPI Eina_Bool | emotion_object_extension_may_play_get (const char *file)
| Do we have a chance to play that file. More...
EAPI Evas_Object * | emotion_object_image_get (const Evas_Object *obj)
| Get the actual image object that contains the pixels of the video stream. More...
EAPI const Eina_List * | emotion_webcams_get (void)
| Get a list of active and available webcam. More...
EAPI const char * | emotion_webcam_name_get (const Emotion_Webcam *ew)
| Get the human understandable name of a Webcam. More...
EAPI const char * | emotion_webcam_device_get (const Emotion_Webcam *ew)
| Get the uri of a Webcam that will be understood by emotion. More...

## Variables
EAPI Emotion_Version * | emotion_version
EAPI int | EMOTION_WEBCAM_UPDATE
| Ecore_Event triggered when a new webcam is plugged or unplugged.
EAPI int | EMOTION_WEBCAM_ADD
| Ecore_Event triggered when a new webcam is plugged in. More...
EAPI int | EMOTION_WEBCAM_DEL
| Ecore_Event triggered when a webcam is unplugged. More...

## Detailed Description

Emotion Media Library.

The file that provides Emotion the API, with functions available for play, seek, change volume, etc.

These routines are used for Emotion.

## Typedef Documentation

typedef enum _Emotion_Meta_Info Emotion_Meta_Info

Meta info type to be retrieved.

typedef enum _Emotion_Vis Emotion_Vis

Type of visualization.

typedef enum _Emotion_Aspect Emotion_Aspect

Aspect ratio option.

## Enumeration Type Documentation

enum _Emotion_Aspect

Defines the aspect ratio option.

Enumerator
EMOTION_ASPECT_KEEP_NONE | ignore video aspect ratio
EMOTION_ASPECT_KEEP_WIDTH | respect video aspect, fitting its width inside the object width
EMOTION_ASPECT_KEEP_HEIGHT | respect video aspect, fitting its height inside the object height
EMOTION_ASPECT_KEEP_BOTH | respect video aspect, fitting it inside the object area
EMOTION_ASPECT_CROP | respect video aspect, cropping exceding area
EMOTION_ASPECT_CUSTOM | use custom borders/crop for the video