summaryrefslogtreecommitdiff
path: root/src/lib/ecore_audio/ecore_audio_obj_out.h
diff options
context:
space:
mode:
authorDaniel Willmann <d.willmann@samsung.com>2013-05-01 17:45:15 +0100
committerDaniel Willmann <d.willmann@samsung.com>2013-05-01 17:45:15 +0100
commitf8c7f96e0557965e93e1066cb3ef573923b21cfe (patch)
tree8c224ff0bc9d0967410084eda639fdf0c70b1cca /src/lib/ecore_audio/ecore_audio_obj_out.h
parenta101ad286763fad63170013884595d8de8382ccc (diff)
ecore_audio: Add documentation for ecore_audio_obj_out
Signed-off-by: Daniel Willmann <d.willmann@samsung.com>
Diffstat (limited to '')
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out.h40
1 files changed, 34 insertions, 6 deletions
diff --git a/src/lib/ecore_audio/ecore_audio_obj_out.h b/src/lib/ecore_audio/ecore_audio_obj_out.h
index e42581ffd5..0052545306 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_out.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_out.h 22 * @file ecore_audio_obj_out.h
23 * @brief Audio Output Object 23 * @brief Ecore_Audio output object
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
29#endif 29#endif
30 30
31/** 31/**
32 * @addtogroup Ecore_Audio_Group 32 * @defgroup ecore_audio_obj_out - Ecore_Audio output object
33 * @ingroup Ecore_Audio_Group
33 * @{ 34 * @{
34 */ 35 */
35 36
36#define ECORE_AUDIO_OBJ_OUT_CLASS ecore_audio_obj_out_class_get() 37#define ECORE_AUDIO_OBJ_OUT_CLASS ecore_audio_obj_out_class_get() /**< Ecore_Audio output object class */
37 38
39/**
40 * @brief Get the Eo class ID
41 *
42 * @return The Eo class ID
43 */
38const Eo_Class *ecore_audio_obj_out_class_get() EINA_CONST; 44const Eo_Class *ecore_audio_obj_out_class_get() EINA_CONST;
39 45
40extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_BASE_ID; 46extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_BASE_ID;
@@ -49,13 +55,35 @@ enum Ecore_Audio_Obj_Out_Sub_Ids
49 55
50#define ECORE_AUDIO_OBJ_OUT_ID(sub_id) (ECORE_AUDIO_OBJ_OUT_BASE_ID + EO_TYPECHECK(enum Ecore_Audio_Obj_Out_Sub_Ids, sub_id)) 56#define ECORE_AUDIO_OBJ_OUT_ID(sub_id) (ECORE_AUDIO_OBJ_OUT_BASE_ID + EO_TYPECHECK(enum Ecore_Audio_Obj_Out_Sub_Ids, sub_id))
51 57
58/**
59 * @brief Attach an input to an output
60 *
61 * @since 1.8
62 *
63 * @param[in] input The input to attach to the output
64 * @param[out] ret EINA_TRUE if the input was attached, EINA_FALSE otherwise
65 */
52#define ecore_audio_obj_out_input_attach(input, ret) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUT_ATTACH), EO_TYPECHECK(Eo *, input), EO_TYPECHECK(Eina_Bool *, ret) 66#define ecore_audio_obj_out_input_attach(input, ret) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUT_ATTACH), EO_TYPECHECK(Eo *, input), EO_TYPECHECK(Eina_Bool *, ret)
53 67
68/**
69 * @brief Detach an input from an output
70 *
71 * @since 1.8
72 *
73 * @param[in] input The input to detach to the output
74 * @param[out] ret EINA_TRUE if the input was detached, EINA_FALSE otherwise
75 */
54#define ecore_audio_obj_out_input_detach(input, ret) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUT_DETACH), EO_TYPECHECK(Eo *, input), EO_TYPECHECK(Eina_Bool *, ret) 76#define ecore_audio_obj_out_input_detach(input, ret) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUT_DETACH), EO_TYPECHECK(Eo *, input), EO_TYPECHECK(Eina_Bool *, ret)
55 77
56#define ecore_audio_obj_out_inputs_get(input) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUTS_GET), EO_TYPECHECK(Eina_List **, input) 78/**
57 79 * @brief Detach an input from an output
58 80 *
81 * @since 1.8
82 *
83 * @param[out] inputs An @ref Eina_List of the inputs that are attached to
84 * the output
85 */
86#define ecore_audio_obj_out_inputs_get(inputs) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUTS_GET), EO_TYPECHECK(Eina_List **, inputs)
59 87
60/** 88/**
61 * @} 89 * @}