[AD] docs: play_audio_stream clarification

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


Just was confused one too many times about how to count samples in
play_audio_stream. The docs speak of alternating left/right - samples,
yet one sentence before one sample means the complete pair. The new
wording should be clear.

-- 
Elias Pschernig <elias@xxxxxxxxxx>
Index: docs/src/allegro._tx
===================================================================
RCS file: /cvsroot/alleg/allegro/docs/src/allegro._tx,v
retrieving revision 1.210
diff -u -r1.210 allegro._tx
--- docs/src/allegro._tx	19 Jan 2004 17:30:55 -0000	1.210
+++ docs/src/allegro._tx	8 Feb 2004 09:58:06 -0000
@@ -6633,7 +6633,7 @@
 @@AUDIOSTREAM *@play_audio_stream(int len, bits, stereo, freq, vol, pan);
 @xref install_sound, get_audio_stream_buffer, stop_audio_stream
 @eref exstream
-   This function creates a new audio stream and starts it playing. The 
+   This function creates a new audio stream and starts playing it. The 
    length is the size of each transfer buffer (in samples), which should 
    normally (but doesn't have to) be a power of two somewhere around 1k in
    size. Larger buffers are more efficient and require fewer updates, but
@@ -6646,7 +6646,8 @@
    you can use the regular voice_*() functions with stream-&gtvoice as a
    parameter. The sample data is always in unsigned format, with stereo
    waveforms consisting of alternating left/right samples, left sample
-   first.
+   first. The len parameter still counts one left/right pair as one sample
+   in that case.
 
 @@void @stop_audio_stream(AUDIOSTREAM *stream);
 @xref play_audio_stream


Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/