Documentation for pcm_play_data() API function. Info taken from http://www.rockbox.org/mail/archive/rockbox-dev-archive-2008-07/0059.shtml.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20868 a1c6a512-1295-4272-9138-f99709370657

1 files changed, 4 insertions, 4 deletions

diff --git a/docs/PLUGIN_API.new b/docs/PLUGIN_API.new
index c7fb6551f1..7e597eed58 100644
--- a/docs/PLUGIN_API.new
+++ b/docs/PLUGIN_API.new
@@ -1690,10 +1690,10 @@ bool pcm_is_playing(void)
 void pcm_play_data(pcm_more_callback_type get_more, unsigned char* start, size_t size)
     \group sound
     \conditions (CONFIG_CODEC == SWCODEC)
-    \param get_more
-    \param start
-    \param size
-    \description
+    \param get_more Optional callback
+    \param start is the address of raw 16-16, interleaved PCM data
+    \param size is the size of the data to play
+    \description May be used without the callback parameter in order to play a single clip. If you wish to play sound continuously, then use the callback instead and return the buffer address and size to be played from that callback. Every time that a buffer is played out, the callback is asked for the next buffer to play but without stopping and starting playback. The callback is called asynchronously in interrupt context so what you may do in there is limited. 
 
 void pcm_play_lock(void)
     \group sound