summaryrefslogtreecommitdiff
path: root/src/lib/emotion/Emotion.h
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-10 03:43:32 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-10 03:43:32 +0000
commitdfb84c1657bfb14a5236b881193b81f4c0b8a69b (patch)
treeb51b210fc88a21eec8e5907b8bbfe12ebc669f90 /src/lib/emotion/Emotion.h
parent532284dbbe4259a9f2291f44d3eff376849e8031 (diff)
efl: merge emotion.
this one was quite a huge work, but hopefully it's correct. NOTES: * removed vlc generic module, it should go into a separate package. * gstreamer is enabled by default (see --disable-gstreamer) * xine is disabled by default (see --enable-gstreamer) * generic is always built statically if supported * gstreamer and xine can't be configured as static (just lacks command line options, build system supports it) * v4l2 is enabled by default on linux if eeze is built (see --disable-v4l2) * emotion_test moved to src/tests/emotion and depends on EFL_ENABLE_TESTS (--with-tests), but is still installed if enabled. TODO (need your help!): * fix warnings with gstreamer and xine engine * call engine shutdown functions if building as static * remove direct usage of PACKAGE_*_DIR and use eina_prefix * add eina_prefix checkme file as evas and others * add support for $EFL_RUN_IN_TREE * create separate package for emotion_generic_modules * check docs hierarchy (doxygen is segv'in here) SVN revision: 82501
Diffstat (limited to '')
-rw-r--r--src/lib/emotion/Emotion.h (renamed from legacy/emotion/src/lib/Emotion.h)88
1 files changed, 53 insertions, 35 deletions
diff --git a/legacy/emotion/src/lib/Emotion.h b/src/lib/emotion/Emotion.h
index 4c97f63cc7..454ee0f42e 100644
--- a/legacy/emotion/src/lib/Emotion.h
+++ b/src/lib/emotion/Emotion.h
@@ -10,17 +10,24 @@
10 10
11/** 11/**
12 * 12 *
13 * @mainpage Emotion Library Documentation 13 * @page emotion_main Emotion
14 * 14 *
15 * @version 1.7.0 15 * @date 2003 (created)
16 * @date 2003-2012
17 * 16 *
18 * @section intro What is Emotion? 17 * @section toc Table of Contents
18 *
19 * @li @ref emotion_main_intro
20 * @li @ref emotion_main_work
21 * @li @ref emotion_main_compiling
22 * @li @ref emotion_main_next_steps
23 * @li @ref emotion_main_intro_example
24 *
25 * @section emotion_main_intro Introduction
19 * 26 *
20 * A media object library for Evas and Ecore. 27 * A media object library for Evas and Ecore.
21 * 28 *
22 * Emotion is a library that allows playing audio and video files, using one of 29 * Emotion is a library that allows playing audio and video files, using one of
23 * its backends (gstreamer or xine). 30 * its backends (gstreamer, xine or generic shm player).
24 * 31 *
25 * It is integrated into Ecore through its mainloop, and is transparent to the 32 * It is integrated into Ecore through its mainloop, and is transparent to the
26 * user of the library how the decoding of audio and video is being done. Once 33 * user of the library how the decoding of audio and video is being done. Once
@@ -32,7 +39,7 @@
32 * default Evas object functions. Callbacks can be added to the signals emitted 39 * default Evas object functions. Callbacks can be added to the signals emitted
33 * by this object with evas_object_smart_callback_add(). 40 * by this object with evas_object_smart_callback_add().
34 * 41 *
35 * @section work How does Emotion work? 42 * @section emotion_main_work How does Emotion work?
36 * 43 *
37 * The Emotion library uses Evas smart objects to allow you to manipulate the 44 * The Emotion library uses Evas smart objects to allow you to manipulate the
38 * created object as any other Evas object, and to connect to its signals, 45 * created object as any other Evas object, and to connect to its signals,
@@ -40,40 +47,48 @@
40 * inside Edje themes, and expect it to behave as a normal image or rectangle 47 * inside Edje themes, and expect it to behave as a normal image or rectangle
41 * when regarding to its dimensions. 48 * when regarding to its dimensions.
42 * 49 *
43 * To instantiate an Emotion object, the simple code below is enough: 50 * @section emotion_main_compiling How to compile
44 * 51 *
45 * @code 52 * Emotion is a library your application links to. The procedure for this is
46 * em = emotion_object_add(e); 53 * very simple. You simply have to compile your application with the
47 * emotion_object_init(em, NULL); 54 * appropriate compiler flags that the @c pkg-config script outputs. For
55 * example:
48 * 56 *
49 * emotion_object_file_set(em, file_path); 57 * Compiling C or C++ files into object files:
50 * 58 *
51 * evas_object_move(em, 0, 0); 59 * @verbatim
52 * evas_object_resize(em, WIDTH, HEIGHT); 60 gcc -c -o main.o main.c `pkg-config --cflags emotion`
53 * evas_object_show(em); 61 @endverbatim
54 * 62 *
55 * emotion_object_play_set(em, EINA_TRUE); 63 * Linking object files into a binary executable:
56 * @endcode
57 * 64 *
58 * See the @ref Emotion_API for a better reference. 65 * @verbatim
59 * 66 gcc -o my_application main.o `pkg-config --libs emotion`
60 * Please see the @ref authors page for contact details. 67 @endverbatim
61 * 68 *
62 */ 69 * See @ref pkgconfig
63 70 *
64/** 71 * @section emotion_main_next_steps Next Steps
65 * 72 *
66 * @page authors Authors 73 * After you understood what Emotion is and installed it in your
67 * 74 * system you should proceed understanding the programming
68 * @author Carsten Haitzler <raster@rasterman.com> 75 * interface. We'd recommend you to take a while to learn @ref Ecore and
69 * @author Vincent Torri <torri@maths.univ-evry.fr> 76 * @ref Evas to get started.
70 * @author Nicolas Aguirre <aguirre.nicolas@gmail.com> 77 *
71 * @author Sebastian Dransfeld <sd@tango.flipp.net> 78 * Recommended reading:
72 * @author Cedric Bail <cedric.bail@free.fr> 79 *
73 * 80 * @li @ref Emotion_Init to initialize the library.
74 * Please contact <enlightenment-devel@lists.sourceforge.net> to get in 81 * @li @ref Emotion_Video to control video parameters.
75 * contact with the developers and maintainers. 82 * @li @ref Emotion_Audio to control audio parameters.
76 * 83 * @li @ref Emotion_Play to control playback.
84 * @li @ref Emotion_Webcam to show cameras.
85 * @li @ref Emotion_API for general programming interface.
86 *
87 * @section emotion_main_intro_example Introductory Example
88 *
89 * @include emotion_basic_example.c
90 *
91 * More examples can be found at @ref emotion_examples.
77 */ 92 */
78 93
79#include <Evas.h> 94#include <Evas.h>
@@ -266,6 +281,7 @@ extern "C" {
266 * @brief How to create, initialize, manipulate and connect to signals of an 281 * @brief How to create, initialize, manipulate and connect to signals of an
267 * Emotion object. 282 * Emotion object.
268 * @defgroup Emotion_API API available for manipulating Emotion object. 283 * @defgroup Emotion_API API available for manipulating Emotion object.
284 * @ingroup Emotion
269 * 285 *
270 * @{ 286 * @{
271 * 287 *
@@ -604,6 +620,7 @@ EAPI Eina_Bool emotion_object_file_set (Evas_Object *obj, const
604EAPI const char *emotion_object_file_get (const Evas_Object *obj); 620EAPI const char *emotion_object_file_get (const Evas_Object *obj);
605/** 621/**
606 * @defgroup Emotion_Play Play control functions 622 * @defgroup Emotion_Play Play control functions
623 * @ingroup Emotion
607 * 624 *
608 * @{ 625 * @{
609 */ 626 */
@@ -1265,6 +1282,7 @@ EAPI Evas_Object *emotion_object_image_get(const Evas_Object *obj);
1265 1282
1266/** 1283/**
1267 * @defgroup Emotion_Webcam API available for accessing webcam 1284 * @defgroup Emotion_Webcam API available for accessing webcam
1285 * @ingroup Emotion
1268 */ 1286 */
1269 1287
1270typedef struct _Emotion_Webcam Emotion_Webcam; /**< Webcam description */ 1288typedef struct _Emotion_Webcam Emotion_Webcam; /**< Webcam description */