summaryrefslogtreecommitdiff
path: root/src/lib/ecore_audio/ecore_audio.eo
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-04-18 22:05:22 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-04-18 22:07:31 +0200
commitc5b00c5974c6a1afcac024c3e9c9edf76322f29f (patch)
tree444fe227e55fc466862ec2c052e2069fc0779c9f /src/lib/ecore_audio/ecore_audio.eo
parenta8a0c2b4a1d9f4ca5418cdabced4b89cc0641ee0 (diff)
ecore_audio: document ecore_audio core class
Merging some property descriptions and some smaller changes.
Diffstat (limited to 'src/lib/ecore_audio/ecore_audio.eo')
-rw-r--r--src/lib/ecore_audio/ecore_audio.eo61
1 files changed, 24 insertions, 37 deletions
diff --git a/src/lib/ecore_audio/ecore_audio.eo b/src/lib/ecore_audio/ecore_audio.eo
index 38cfe02411..db3379da6b 100644
--- a/src/lib/ecore_audio/ecore_audio.eo
+++ b/src/lib/ecore_audio/ecore_audio.eo
@@ -13,86 +13,73 @@ enum Ecore_Audio_Format {
13 13
14class Ecore_Audio (Eo.Base) 14class Ecore_Audio (Eo.Base)
15{ 15{
16 [[Convenience audio class.]]
17
16 legacy_prefix: null; 18 legacy_prefix: null;
17 eo_prefix: ecore_audio_obj; 19 eo_prefix: ecore_audio_obj;
18 data: Ecore_Audio_Object; 20 data: Ecore_Audio_Object;
19 methods { 21 methods {
20 @property name { 22 @property name {
21 set { 23 [[Name of the object
22 [[Set the name of the object
23 24
24 @since 1.8 25 @since 1.8
25 ]] 26 ]]
27 set {
26 } 28 }
27 get { 29 get {
28 [[Get the name of the object
29
30 @since 1.8
31 ]]
32 } 30 }
33 values { 31 values {
34 name: const(char)*; 32 name: const(char)*; [[Name]]
35 } 33 }
36 } 34 }
37 @property paused { 35 @property paused {
38 set { 36 [[Pause state of the object
39 [[Set the pause state of the object
40 37
41 @since 1.8 38 @since 1.8
42 ]] 39 ]]
40 set {
43 } 41 }
44 get { 42 get {
45 [[Get the pause state of the object
46
47 @since 1.8
48 ]]
49 } 43 }
50 values { 44 values {
51 paused: bool; [[true if object is paused, false if not]] 45 paused: bool; [[true if object is paused, false if not]]
52 } 46 }
53 } 47 }
54 @property volume { 48 @property volume {
55 set { 49 [[Volume of the object
56 [[Set the volume of the object
57 50
58 @since 1.8 51 @since 1.8
59 ]] 52 ]]
53 set {
60 } 54 }
61 get { 55 get {
62 [[Get the volume of the object
63
64 @since 1.8
65 ]]
66 } 56 }
67 values { 57 values {
68 volume: double; [[the volume]] 58 volume: double; [[The volume]]
69 } 59 }
70 } 60 }
71 @property source { 61 @property source {
72 set { 62 [[Source of the object
73 [[Set the source of the object
74 63
75 What sources are supported depends on the actual object. 64 What sources are supported depends on the actual object.
76 For example, the libsndfile class accepts WAV, OGG, FLAC 65 For example, the libsndfile class accepts WAV, OGG, FLAC
77 files as source. 66 files as source.
78 67
79 @since 1.8 68 @since 1.8
80 ]] 69 ]]
70 set {
81 return: bool; [[true if the source was set correctly (i.e. the file 71 return: bool; [[true if the source was set correctly (i.e. the file
82 was opened), EINA_FALSE otherwise 72 was opened), EINA_FALSE otherwise
83 ]] 73 ]]
84 } 74 }
85 get { 75 get {
86 [[Get the source of the object
87
88 @since 1.8
89 ]]
90 } 76 }
91 values { 77 values {
92 source: const(char)*; [[the source to set to (i.e. file, URL, device)]] 78 source: const(char)*; [[the source to set to (i.e. file, URL, device)]]
93 } 79 }
94 } 80 }
95 @property format { 81 @property format {
82 [[Format of the object.]]
96 set { 83 set {
97 [[Set the format of the object 84 [[Set the format of the object
98 85