summaryrefslogtreecommitdiff
path: root/legacy/emotion/src/lib/Emotion.h
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2011-08-03 02:34:32 +0000
committerCarsten Haitzler <raster@rasterman.com>2011-08-03 02:34:32 +0000
commit24d5ac23f9001ebb438396f6227dfec3add1c38b (patch)
treeed291c5ffec8d8e72e125a5739346739f23e27bd /legacy/emotion/src/lib/Emotion.h
parentd5d9b9d32c016d48605827b74c1f537480ad9a3a (diff)
get rid of emotion.dox and move to Emotion.h where all docs should be.
examples.dox is a slight issue atm. SVN revision: 62032
Diffstat (limited to '')
-rw-r--r--legacy/emotion/src/lib/Emotion.h64
1 files changed, 64 insertions, 0 deletions
diff --git a/legacy/emotion/src/lib/Emotion.h b/legacy/emotion/src/lib/Emotion.h
index 9640a4d317..3031b44251 100644
--- a/legacy/emotion/src/lib/Emotion.h
+++ b/legacy/emotion/src/lib/Emotion.h
@@ -1,6 +1,70 @@
1#ifndef EMOTION_H 1#ifndef EMOTION_H
2#define EMOTION_H 2#define EMOTION_H
3 3
4/**
5 * @file
6 * @brief Emotion Media Library
7 *
8 * These routines are used for Emotion.
9 */
10
11/**
12 *
13 * @mainpage Emotion Library Documentation
14 *
15 * @image html e.png
16 *
17 * Emotion is a library that allows playing audio and video files, using one of
18 * its backends (gstreamer or xine).
19 *
20 * It is integrated into Ecore through its mainloop, and is transparent to the
21 * user of the library how the decoding of audio and video is being done. Once
22 * the objects are created, the user can set callbacks to the specific events
23 * and set options to this object, all in the main loop (no threads are needed).
24 *
25 * Emotion is also integrated with Evas. The emotion object returned by
26 * emotion_object_add() is an Evas smart object, so it can be manipulated with
27 * default Evas object functions. Callbacks can be added to the signals emitted
28 * by this object with evas_object_smart_callback_add().
29 *
30 * @version 0.2.0
31 * @author Carsten Haitzler <raster@rasterman.com>
32 * @author Vincent Torri <torri@maths.univ-evry.fr>
33 * @author Nicolas Aguirre <aguirre.nicolas@gmail.com>
34 * @author Sebastian Dransfeld <sd@tango.flipp.net>
35 * @author Cedric Bail <cedric.bail@free.fr>
36 * @date 2003-2011
37 *
38 * @section intro What is Emotion?
39 *
40 * A media object library for Evas and Ecore.
41 *
42 * @section work How does Emotion work?
43 *
44 * The Emotion library uses Evas smart objects to allow you to manipulate the
45 * created object as any other Evas object, and to connect to its signals,
46 * handling them when needed. It's also possible to swallow Emotion objects
47 * inside Edje themes, and expect it to behave as a normal image or rectangle
48 * when regarding to its dimensions.
49 *
50 * To instantiate an Emotion object, the simple code below is enough:
51 *
52 * @code
53 * em = emotion_object_add(e);
54 * emotion_object_init(em, NULL);
55 *
56 * emotion_object_file_set(em, file_path);
57 *
58 * evas_object_move(em, 0, 0);
59 * evas_object_resize(em, WIDTH, HEIGHT);
60 * evas_object_show(em);
61 *
62 * emotion_object_play_set(em, EINA_TRUE);
63 * @endcode
64 *
65 * See the @ref Emotion_API for a better reference.
66 */
67
4#include <Evas.h> 68#include <Evas.h>
5 69
6#ifdef EAPI 70#ifdef EAPI