GAUDIO - Revision history

Tectu: /* API reference */

2016-02-04T15:50:18Z

‎API reference

2015-02-14T00:17:58Z

‎API reference

2014-07-04T23:50:32Z

‎GDataBuffer

2014-07-04T20:57:24Z

‎Record

2014-07-04T20:48:13Z

‎Record

2014-07-04T20:22:59Z

2014-07-04T20:03:25Z

‎Play back

2014-07-04T20:03:06Z

‎Record

2014-07-04T19:32:38Z

‎Play back

2014-07-04T19:20:53Z

‎GDataBuffer

@@ Line 4: / Line 4: @@
 == API reference ==
-The API reference of the GAUDIO module can be found [http://api.ugfx.org/master/group___g_a_u_d_i_o.html here].
+The API reference of the GAUDIO module can be found [http://api.ugfx.org/group___g_a_u_d_i_o.html here].
 == Board file ==

@@ Line 4: / Line 4: @@
 == API reference ==
-The API reference of the GAUDIO module can be found [http://ugfx.org/images/resources/doxygen/master/group___g_a_u_d_i_o.html here].
+The API reference of the GAUDIO module can be found [http://api.ugfx.org/master/group___g_a_u_d_i_o.html here].
 == Board file ==

@@ Line 14: / Line 14: @@
 The main idea is to create a pool of buffers using <code>gfxBufferAlloc(num, size)</code> where ''num'' is the number of buffers and ''size'' the size per buffer. The user does then fill the buffers sequentially with the audio data and passes them to <code>gaudioPlay()</code> - one after another. As soon as the audio data inside a buffer has been processed, the <code>gaudioPlay()</code> routine will automatically free the buffer so the user can fill it with new data.
-For more information, see [[GQUEUE#Buffer]].
+For more information, see [[GQUEUE#Buffers]].
 == Play back ==

@@ Line 58: / Line 58: @@
 Before any audio can be recorded, the audio device has to be initialized using <code>gaudioRecordInit()</code>. The audio channel, the sample format and the sample frequency are set by this function call.
-After successful initialization, audio recording can be started using <code>gaudioRecordStart()</code>.
+After successful initialization, audio recording can be started using <code>gaudioRecordStart()</code>. The recorded audio data can be retrieved using <code>gaudioRecordGetData()</code>. After processing, the user has to manually free the corresponding buffer using <code>gfxBufferRelease()</code>.
 Calling <code>gaudioRecordStop()</code> will stop the audio recording. All audio recording data that has not yet been retrieved is automatically freed.

@@ Line 56: / Line 56: @@
 == Record ==
-Before any audio can be recorded, the audio device has to be initialized using gaudioRecordInit(). The audio channel, the sample format and the sample frequency are set by this function call.
+Before any audio can be recorded, the audio device has to be initialized using <code>gaudioRecordInit()</code>. The audio channel, the sample format and the sample frequency are set by this function call.
 === GEVENT integration ===

@@ Line 43: / Line 43: @@
 === GEVENT integration ===
-The GAUDIO module can optionally be configured to send events through the [[GEVENT]] module. This feature is enabled by calling <code>gaudioRecordGetSource()</code>, the GAUDIO module will send the following events:
+The GAUDIO module can optionally be configured to send events through the [[GEVENT]] module. If this feature is enabled by calling <code>gaudioPlayGetSource()</code>, the GAUDIO module will send the following events:
 {| class="wikitable"
 |-
@@ Line 57: / Line 57: @@
 == Record ==
 Before any audio can be recorded, the audio device has to be initialized using gaudioRecordInit(). The audio channel, the sample format and the sample frequency are set by this function call.
 [[Category:Module]]

@@ Line 17: / Line 17: @@
 == Play back ==
-Before any audio can be played, the audio device has to be initialized using <code>gaudioPlayInit()</code>. Both, the sample format and the sample frequency are set by this function call. If using an external decoder, see [[#External_decoder]].
+Before any audio can be played, the audio device has to be initialized using <code>gaudioPlayInit()</code>. The audio channel, the sample format and the sample frequency are set by this function call. If using an external decoder, see [[#External_decoder]].
 After successful initialization, <code>gaudioPlay()</code> can be used to output audio data. The function takes a pointer to a [[#GDataBuffer|GDataBuffer]] that holds the audio data to play in the format that has been set by the initialization call. The passed buffer will be freed by the function after the audio content of the buffer has been processed.

@@ Line 12: / Line 12: @@
 <code>GDataBuffer</code> is the container that is used to hold, manipulate and pass audio data. The buffer is provided and handled by the [[GQUEUE]] module.
-The main idea is to create a pool of buffers using <code>gfxBufferAlloc(num, size)</code> where ''num'' is the number of buffers and ''size'' the size per buffer. The user does then fill the buffers sequentially with the audio data and passes them to <code>gaudioPlay()</code>. As soon as the audio data inside a buffer has been processed, the <code>gaudioPlay()</code> routine will automatically free the buffer so the user can fill it with new data.
+The main idea is to create a pool of buffers using <code>gfxBufferAlloc(num, size)</code> where ''num'' is the number of buffers and ''size'' the size per buffer. The user does then fill the buffers sequentially with the audio data and passes them to <code>gaudioPlay()</code> - one after another. As soon as the audio data inside a buffer has been processed, the <code>gaudioPlay()</code> routine will automatically free the buffer so the user can fill it with new data.
 For more information, see [[GQUEUE#Buffer]].