summaryrefslogtreecommitdiff
path: root/src/lib/ecore_audio
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-04-18 11:46:06 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-04-18 22:07:31 +0200
commit67147dc331c07abec1119ffd3dae78bd0abaf091 (patch)
tree404cedb8ed8855bb85ce793a8e180ee3bb6becf4 /src/lib/ecore_audio
parent1700e62c16a0f990899c4d7cb8b4182e383f63ce (diff)
ecore_audio: document all ecore_audio_in classes
For the properties we really only need to document the property itself and not its setter and getter functions.
Diffstat (limited to 'src/lib/ecore_audio')
-rw-r--r--src/lib/ecore_audio/ecore_audio_in.eo83
-rw-r--r--src/lib/ecore_audio/ecore_audio_in_sndfile.eo1
-rw-r--r--src/lib/ecore_audio/ecore_audio_in_tone.eo1
3 files changed, 32 insertions, 53 deletions
diff --git a/src/lib/ecore_audio/ecore_audio_in.eo b/src/lib/ecore_audio/ecore_audio_in.eo
index 0d62cdab97..7b0327a9a2 100644
--- a/src/lib/ecore_audio/ecore_audio_in.eo
+++ b/src/lib/ecore_audio/ecore_audio_in.eo
@@ -1,113 +1,90 @@
1class Ecore_Audio_In (Ecore_Audio) 1class Ecore_Audio_In (Ecore_Audio)
2{ 2{
3 [[Ecore Audio input object.]]
3 legacy_prefix: null; 4 legacy_prefix: null;
4 eo_prefix: ecore_audio_obj_in; 5 eo_prefix: ecore_audio_obj_in;
5 data: Ecore_Audio_Input; 6 data: Ecore_Audio_Input;
6 methods { 7 methods {
7 @property speed { 8 @property speed {
8 set { 9 [[Playback speed of the input.
9 [[Set the playback speed of the input.
10 10
11 @since 1.8 11 @since 1.8
12 ]] 12 ]]
13 set {
13 } 14 }
14 get { 15 get {
15 [[Get the playback speed of the input.
16
17 @since 1.8
18 ]]
19 } 16 }
20 values { 17 values {
21 speed: double; [[The speed, 1.0 is the default]] 18 speed: double; [[The speed, 1.0 is the default]]
22 } 19 }
23 } 20 }
24 @property samplerate { 21 @property samplerate {
25 set { 22 [[Sample-rate of the input
26 [[Set the sample-rate of the input
27 23
28 @since 1.8 24 @since 1.8
29 ]] 25 ]]
26 set {
30 } 27 }
31 get { 28 get {
32 [[Get the he sample-rate of the input
33
34 @since 1.8
35 ]]
36 } 29 }
37 values { 30 values {
38 samplerate: int; [[The samplerate in Hz]] 31 samplerate: int; [[The samplerate in Hz]]
39 } 32 }
40 } 33 }
41 @property channels { 34 @property channels {
42 set { 35 [[Amount of channels the input has
43 [[Set the amount of channels the input has
44 36
45 @since 1.8 37 @since 1.8
46 ]] 38 ]]
39 set {
47 } 40 }
48 get { 41 get {
49 [[Get the amount of channels the input has
50
51 @since 1.8
52 ]]
53 } 42 }
54 values { 43 values {
55 channels: int; [[The number of channels]] 44 channels: int; [[The number of channels]]
56 } 45 }
57 } 46 }
58 @property preloaded { 47 @property preloaded {
59 set { 48 [[Preloaded state of the input
60 [[Set the preloaded state of the input
61 49
62 @since 1.8 50 @since 1.8
63 ]] 51 ]]
52 set {
64 } 53 }
65 get { 54 get {
66 [[Get the the preloaded state of the input
67
68 @since 1.8
69 ]]
70 } 55 }
71 values { 56 values {
72 preloaded: bool; [[true if the input should be cached, false otherwise]] 57 preloaded: bool; [[true if the input should be cached, false otherwise]]
73 } 58 }
74 } 59 }
75 @property looped { 60 @property looped {
76 set { 61 [[Looped state of the input
77 [[Set the looped state of the input
78 62
79 If the input is looped and reaches the end it will start from the 63 If the input is looped and reaches the end it will start from the
80 beginning again. At the same time the event 64 beginning again. At the same time the event
81 \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted 65 \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted
82 66
83 @since 1.8 67 @since 1.8
84 ]] 68 ]]
69 set {
85 } 70 }
86 get { 71 get {
87 [[Get the looped state of the input
88
89 @since 1.8
90 ]]
91 } 72 }
92 values { 73 values {
93 looped: bool; [[true if the input should be looped, false otherwise]] 74 looped: bool; [[true if the input should be looped, false otherwise]]
94 } 75 }
95 } 76 }
96 @property length { 77 @property length {
97 set { 78 [[Length of the input
98 [[Set the length of the input
99 79
100 This function is only implemented by some classes 80 This function is only implemented by some classes
101 (i.e. ECORE_AUDIO_OBJ_IN_TONE_CLASS) 81 (i.e. ECORE_AUDIO_OBJ_IN_TONE_CLASS)
102 82
103 @since 1.8 83 @since 1.8
104 ]] 84 ]]
85 set {
105 } 86 }
106 get { 87 get {
107 [[Get the length of the input
108
109 @since 1.8
110 ]]
111 } 88 }
112 values { 89 values {
113 length: double; [[The length of the input in seconds]] 90 length: double; [[The length of the input in seconds]]
diff --git a/src/lib/ecore_audio/ecore_audio_in_sndfile.eo b/src/lib/ecore_audio/ecore_audio_in_sndfile.eo
index 170b3850e5..4396ec99a5 100644
--- a/src/lib/ecore_audio/ecore_audio_in_sndfile.eo
+++ b/src/lib/ecore_audio/ecore_audio_in_sndfile.eo
@@ -1,5 +1,6 @@
1class Ecore_Audio_In_Sndfile (Ecore_Audio_In) 1class Ecore_Audio_In_Sndfile (Ecore_Audio_In)
2{ 2{
3 [[Ecore Audio sndfile input.]]
3 eo_prefix: ecore_audio_obj_in_sndfile; 4 eo_prefix: ecore_audio_obj_in_sndfile;
4 implements { 5 implements {
5 Eo.Base.destructor; 6 Eo.Base.destructor;
diff --git a/src/lib/ecore_audio/ecore_audio_in_tone.eo b/src/lib/ecore_audio/ecore_audio_in_tone.eo
index e0cfebfb68..afa9c3e841 100644
--- a/src/lib/ecore_audio/ecore_audio_in_tone.eo
+++ b/src/lib/ecore_audio/ecore_audio_in_tone.eo
@@ -1,5 +1,6 @@
1class Ecore_Audio_In_Tone (Ecore_Audio_In) 1class Ecore_Audio_In_Tone (Ecore_Audio_In)
2{ 2{
3 [[Ecore Audio tone input.]]
3 eo_prefix: ecore_audio_obj_in_tone; 4 eo_prefix: ecore_audio_obj_in_tone;
4 implements { 5 implements {
5 Eo.Base.constructor; 6 Eo.Base.constructor;