Functions
Video

Functions

EOAPI void efl_ui_video_remember_position_set (Eo *obj, Eina_Bool remember)
 Set whether the object can remember the last played position. More...
 
EOAPI Eina_Bool efl_ui_video_remember_position_get (const Eo *obj)
 Set whether the object can remember the last played position. More...
 
EOAPI Eina_Bool efl_ui_video_is_playing_get (const Eo *obj)
 Is the video actually playing. More...
 
EOAPI Efl_Canvas_Object * efl_ui_video_emotion_get (const Eo *obj)
 Get the underlying Emotion object. More...
 
EOAPI const char * efl_ui_video_title_get (const Eo *obj)
 Get the title (for instance DVD title) from this emotion object. More...
 
EOAPI void efl_ui_video_play (Eo *obj)
 Start playing a video.
 
EOAPI void efl_ui_video_pause (Eo *obj)
 Pause a video.
 
EOAPI void efl_ui_video_stop (Eo *obj)
 Stop a video.
 
void elm_video_remember_position_set (Efl_Ui_Video *obj, Eina_Bool remember)
 Set whether the object can remember the last played position. More...
 
Eina_Bool elm_video_remember_position_get (const Efl_Ui_Video *obj)
 Set whether the object can remember the last played position. More...
 
Eina_Bool elm_video_is_playing_get (const Efl_Ui_Video *obj)
 Is the video actually playing. More...
 
Efl_Canvas_Object * elm_video_emotion_get (const Efl_Ui_Video *obj)
 Get the underlying Emotion object. More...
 
const char * elm_video_title_get (const Efl_Ui_Video *obj)
 Get the title (for instance DVD title) from this emotion object. More...
 
void elm_video_play (Efl_Ui_Video *obj)
 Start playing a video.
 
void elm_video_pause (Efl_Ui_Video *obj)
 Pause a video.
 
void elm_video_stop (Efl_Ui_Video *obj)
 Stop a video.
 

Detailed Description

video_inheritance_tree.png
player_inheritance_tree.png

Elementary comes with two object that help design application that need to display video.

The first one, Efl_Ui_Video, display a video by using Emotion. It embeds the video inside an Edje object, so you can do some animation depending on the video state change. It also implements a resource management policy to remove this burden from the application.

The second one, Elm_Player is a video player that need to be linked with an Efl_Ui_Video. It take care of updating its content according to Emotion event and provide a way to theme itself. It also automatically raises the priority of the linked Efl_Ui_Video so it will use the video decoder, if available. It also activates the "remember" function on the linked Efl_Ui_Video object.

Both widgets inherit from the Layout one, so that all the functions acting on it also work for video objects.

This widget emits the following signals, besides the ones sent from Layout:

The player widget emits the following signals, besides the ones sent from Layout:

Default content parts of the player widget that you can use for are:

Function Documentation

◆ efl_ui_video_remember_position_set()

EOAPI void efl_ui_video_remember_position_set ( Eo obj,
Eina_Bool  remember 
)

Set whether the object can remember the last played position.

Note
This API only serves as indication. System support is required.
Parameters
[in]rememberThe value.

Referenced by elm_video_remember_position_set().

◆ efl_ui_video_remember_position_get()

EOAPI Eina_Bool efl_ui_video_remember_position_get ( const Eo obj)

Set whether the object can remember the last played position.

Note
This API only serves as indication. System support is required.
Returns
The value.

Referenced by elm_video_remember_position_get().

◆ efl_ui_video_is_playing_get()

EOAPI Eina_Bool efl_ui_video_is_playing_get ( const Eo obj)

Is the video actually playing.

You should consider watching event on the object instead of polling the object state.

Referenced by elm_video_is_playing_get().

◆ efl_ui_video_emotion_get()

EOAPI Efl_Canvas_Object* efl_ui_video_emotion_get ( const Eo obj)

Get the underlying Emotion object.

Returns
the underlying Emotion object.

Referenced by elm_video_emotion_get().

◆ efl_ui_video_title_get()

EOAPI const char* efl_ui_video_title_get ( const Eo obj)

Get the title (for instance DVD title) from this emotion object.

This function is only useful when playing a DVD.

Note
Don't change or free the string returned by this function.
Returns
A string containing the title.

Referenced by elm_video_title_get().

◆ elm_video_remember_position_set()

void elm_video_remember_position_set ( Efl_Ui_Video *  obj,
Eina_Bool  remember 
)

Set whether the object can remember the last played position.

Note
This API only serves as indication. System support is required.
Parameters
[in]rememberThe value.

References efl_ui_video_remember_position_set().

◆ elm_video_remember_position_get()

Eina_Bool elm_video_remember_position_get ( const Efl_Ui_Video *  obj)

Set whether the object can remember the last played position.

Note
This API only serves as indication. System support is required.
Returns
The value.

References efl_ui_video_remember_position_get().

◆ elm_video_is_playing_get()

Eina_Bool elm_video_is_playing_get ( const Efl_Ui_Video *  obj)

Is the video actually playing.

You should consider watching event on the object instead of polling the object state.

References efl_ui_video_is_playing_get().

◆ elm_video_emotion_get()

Efl_Canvas_Object* elm_video_emotion_get ( const Efl_Ui_Video *  obj)

Get the underlying Emotion object.

Returns
the underlying Emotion object.

References efl_ui_video_emotion_get().

◆ elm_video_title_get()

const char* elm_video_title_get ( const Efl_Ui_Video *  obj)

Get the title (for instance DVD title) from this emotion object.

This function is only useful when playing a DVD.

Note
Don't change or free the string returned by this function.
Returns
A string containing the title.

References efl_ui_video_title_get().