summaryrefslogtreecommitdiff
path: root/src/lib/ecore_audio/ecore_audio.eo
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-18 16:37:01 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-18 16:37:01 +0100
commit4384efec2e90714d6943568699dbd00b64fc9a48 (patch)
treee0fb1a345a7c9945e69d8316b8074cc0139ccd6a /src/lib/ecore_audio/ecore_audio.eo
parent4b0b8960b628fe9fdbe285de1978fc96f61c30a0 (diff)
ecore_audio: convert docs
Diffstat (limited to 'src/lib/ecore_audio/ecore_audio.eo')
-rw-r--r--src/lib/ecore_audio/ecore_audio.eo133
1 files changed, 71 insertions, 62 deletions
diff --git a/src/lib/ecore_audio/ecore_audio.eo b/src/lib/ecore_audio/ecore_audio.eo
index c22f12473d..47f3d1bf4d 100644
--- a/src/lib/ecore_audio/ecore_audio.eo
+++ b/src/lib/ecore_audio/ecore_audio.eo
@@ -6,16 +6,16 @@ class Ecore_Audio (Eo.Base)
6 methods { 6 methods {
7 @property name { 7 @property name {
8 set { 8 set {
9 /*@ 9 [[Set the name of the object
10 Set the name of the object 10
11 11 @since 1.8
12 @since 1.8 */ 12 ]]
13 } 13 }
14 get { 14 get {
15 /*@ 15 [[Get the name of the object
16 Get the name of the object 16
17 17 @since 1.8
18 @since 1.8 */ 18 ]]
19 } 19 }
20 values { 20 values {
21 name: const(char)*; 21 name: const(char)*;
@@ -23,92 +23,101 @@ class Ecore_Audio (Eo.Base)
23 } 23 }
24 @property paused { 24 @property paused {
25 set { 25 set {
26 /*@ 26 [[Set the pause state of the object
27 Set the pause state of the object 27
28 28 @since 1.8
29 @since 1.8 */ 29 ]]
30 } 30 }
31 get { 31 get {
32 /*@ 32 [[Get the pause state of the object
33 Get the pause state of the object 33
34 34 @since 1.8
35 @since 1.8 */ 35 ]]
36 } 36 }
37 values { 37 values {
38 paused: bool; /*@ ret EINA_TRUE if object is paused, EINA_FALSE if not*/ 38 paused: bool; [[true if object is paused, false if not]]
39 } 39 }
40 } 40 }
41 @property volume { 41 @property volume {
42 set { 42 set {
43 /*@ 43 [[Set the volume of the object
44 Set the volume of the object 44
45 45 @since 1.8
46 @since 1.8 */ 46 ]]
47 } 47 }
48 get { 48 get {
49 /*@ 49 [[Get the volume of the object
50 Get the volume of the object 50
51 51 @since 1.8
52 @since 1.8 */ 52 ]]
53 } 53 }
54 values { 54 values {
55 volume: double; /*@ The volume */ 55 volume: double; [[the volume]]
56 } 56 }
57 } 57 }
58 @property source { 58 @property source {
59 set { 59 set {
60 /*@ 60 [[Set the source of the object
61 Set the source of the object 61
62 62 What sources are supported depends on the actual object.
63 What sources are supported depends on the actual object. For example, 63 For example, the libsndfile class accepts WAV, OGG, FLAC
64 the libsndfile class accepts WAV, OGG, FLAC files as source. 64 files as source.
65 65
66 @since 1.8 */ 66 @since 1.8
67 return: bool; /*@ EINA_TRUE if the source was set correctly (i.e. the file was opened), EINA_FALSE otherwise*/ 67 ]]
68 return: bool; [[true if the source was set correctly (i.e. the file
69 was opened), EINA_FALSE otherwise
70 ]]
68 } 71 }
69 get { 72 get {
70 /*@ 73 [[Get the source of the object
71 Get the source of the object 74
72 75 @since 1.8
73 @since 1.8 */ 76 ]]
74 } 77 }
75 values { 78 values {
76 source: const(char)*; /*@ The source to set to (i.e. file, URL, device)*/ 79 source: const(char)*; [[the source to set to (i.e. file, URL, device)]]
77 } 80 }
78 } 81 }
79 @property format { 82 @property format {
80 set { 83 set {
81 /*@ 84 [[Set the format of the object
82 Set the format of the object 85
83 86 What formats are supported depends on the actual object. Default
84 What formats are supported depends on the actual object. Default is 87 is ECORE_AUDIO_FORMAT_AUTO
85 ECORE_AUDIO_FORMAT_AUTO 88
86 89 @since 1.8
87 @since 1.8 */ 90 ]]
88 return: bool; /*@ EINA_TRUE if the format was supported, EINA_FALSE otherwise*/ 91 return: bool; [[true if the format was supported, false otherwise]]
89 } 92 }
90 get { 93 get {
91 /*@ 94 [[Get the format of the object
92 Get the format of the object 95
93 96 After setting the source if the format was ECORE_AUDIO_FORMAT_AUTO
94 After setting the source if the format was ECORE_AUDIO_FORMAT_AUTO this 97 this function will now return the actual format.
95 function will now return the actual format. 98
96 99 @since 1.8
97 @since 1.8 */ 100 ]]
98 } 101 }
99 values { 102 values {
100 format: Ecore_Audio_Format; /*@ The format of the object*/ 103 format: Ecore_Audio_Format; [[the format of the object]]
101 } 104 }
102 } 105 }
103 vio_set { 106 vio_set {
104 /*@ 107 [[Set the virtual IO functions
105 Set the virtual IO functions 108
106 109 @since 1.8
107 @since 1.8 */ 110 ]]
108 params { 111 params {
109 vio: Ecore_Audio_Vio *; /*@ The @ref Ecore_Audio_Vio struct with the function callbacks*/ 112 vio: Ecore_Audio_Vio *; [[the @Ecore_Audio_Vio struct with the
110 data: void *; /*@ User data to pass to the VIO functions*/ 113 function callbacks
111 free_func: eo_key_data_free_func; /*@ This function takes care to clean up @ref data when he VIO is destroyed. NULL means do nothing.*/ 114 ]]
115 data: void *; [[user data to pass to the VIO functions]]
116 free_func: eo_key_data_free_func; [[this function takes care to
117 clean up @data when he VIO is
118 destroyed. NULL means do
119 nothing.
120 ]]
112 } 121 }
113 } 122 }
114 } 123 }