aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/elementary/efl_ui_video.h
blob: d015d1c0d728892bf23c3daffdf6bd84aa676b33 (plain) (blame)
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
/**
 * @defgroup Efl_Ui_Video Video
 * @ingroup Elementary
 *
 * @addtogroup Efl_Ui_Video
 * @{
 *
 * @image html video_inheritance_tree.png
 * @image latex video_inheritance_tree.eps
 *
 * @image html player_inheritance_tree.png
 * @image latex player_inheritance_tree.eps
 *
 * 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 @ref 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
 * @ref Layout:
 * @li @c "focused" : When the video has received focus. (since 1.8)
 * @li @c "unfocused" : When the video has lost focus. (since 1.8)
 *
 * The player widget emits the following signals, besides the ones
 * sent from @ref Layout:
 *  - @c "forward,clicked" - the user clicked the forward button.
 *  - @c "info,clicked" - the user clicked the info button.
 *  - @c "next,clicked" - the user clicked the next button.
 *  - @c "pause,clicked" - the user clicked the pause button.
 *  - @c "play,clicked" - the user clicked the play button.
 *  - @c "prev,clicked" - the user clicked the prev button.
 *  - @c "rewind,clicked" - the user clicked the rewind button.
 *  - @c "stop,clicked" - the user clicked the stop button.
 *
 * Default content parts of the player widget that you can use for are:
 * @li "video" - A video of the player
 *
 */

/**
 * ELM_PLAYER_CLASS
 */

#ifdef EFL_EO_API_SUPPORT
#include "efl_ui_video_eo.h"
#endif
#ifndef EFL_NOLEGACY_API_SUPPORT
#include "efl_ui_video_legacy.h"
#endif
/**
 * @}
 */