summaryrefslogtreecommitdiff
path: root/legacy/emotion/doc/emotion.dox.in
blob: 5d9000bc2fd1b1bdcb614ee1cb19f00c8d44aed3 (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
/**
 * @file
 * @brief Emotion Media Library
 *
 * These routines are used for Emotion.
 */

/**
 *
 * @mainpage Emotion Library Documentation
 *
 * @image html e.png
 *
 * Emotion is a library that allows playing audio and video files, using one of
 * its backends (gstreamer or xine).
 *
 * It is integrated into Ecore through its mainloop, and is transparent to the
 * user of the library how the decoding of audio and video is being done. Once
 * the objects are created, the user can set callbacks to the specific events
 * and set options to this object, all in the main loop (no threads are needed).
 *
 * Emotion is also integrated with Evas. The emotion object returned by
 * emotion_object_add() is an Evas smart object, so it can be manipulated with
 * default Evas object functions. Callbacks can be added to the signals emitted
 * by this object with evas_object_smart_callback_add().
 *
 * @version @PACKAGE_VERSION@
 * @author Carsten Haitzler <raster@rasterman.com>
 * @author vtorri (Vincent Torri) <torri@maths.univ-evry.fr>
 * @author Sebastian Dransfeld <sd@tango.flipp.net>
 * @author captainigloo
 * @date 2003-2011
 *
 * @section intro What is Emotion?
 *
 * A media object library for Evas and Ecore.
 *
 * @section work How does Emotion work?
 *
 * The Emotion library uses Evas smart objects to allow you to manipulate the
 * created object as any other Evas object, and to connect to its signals,
 * handling them when needed. It's also possible to swallow Emotion objects
 * inside Edje themes, and expect it to behave as a normal image or rectangle
 * when regarding to its dimensions.
 *
 * To instantiate an Emotion object, the simple code below is enough:
 *
 * @code
 * em = emotion_object_add(e);
 * emotion_object_init(em, NULL);
 *
 * emotion_object_file_set(em, file_path);
 *
 * evas_object_move(em, 0, 0);
 * evas_object_resize(em, WIDTH, HEIGHT);
 * evas_object_show(em);
 *
 * emotion_object_play_set(em, EINA_TRUE);
 * @endcode
 *
 *
 * @todo Complete documentation of API - in progress
 *
 */