[xiph-cvs] cvs commit: vorbis/doc/vorbisfile ov_read_float.html

[Michael Smith]

msmith      02/07/20 18:35:22

  Modified:    doc/vorbisfile ov_read_float.html
  Log:
  Doc fixes for changed ov_read_float()

Revision  Changes    Path
1.3       +6 -3      vorbis/doc/vorbisfile/ov_read_float.html

Index: ov_read_float.html
===================================================================
RCS file: /usr/local/cvsroot/vorbis/doc/vorbisfile/ov_read_float.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ov_read_float.html	2002/07/02 21:40:29	1.2
+++ ov_read_float.html	2002/07/21 01:35:21	1.3
@@ -30,7 +30,7 @@
 <tr bgcolor=#cccccc>
         <td>
 <pre><b>
-long ov_read(OggVorbis_File *vf, float ***pcm_channels, int *bitstream);
+long ov_read_float(OggVorbis_File *vf, float ***pcm_channels, int samples, int *bitstream);
 </b></pre>
         </td>
 </tr>
@@ -43,7 +43,10 @@
 functions.</dd>
 <dt><i>pcm_channels</i></dt>
 <dd>A pointer to an output buffer.  The pointer will be set to the decoded output buffer.</dd>
+<dt><i>samples</i></dt>
+<dd>Maximum number of decoded samples to produce.</dd>
 <dt><i>bitstream</i></dt>
+<dt><i>bitstream</i></dt>
 <dd>A pointer to the number of the current logical bitstream.</dd>
 </dl>
 
@@ -71,10 +74,10 @@
 <p><b>Typical usage:</b>
 <blockquote>
 <tt>float **pcm;
-bytes_read = ov_read_float(&amp;vf,pcm,&amp;current_section)</tt>
+bytes_read = ov_read_float(&amp;vf,pcm, 1024, &amp;current_section)</tt>
 </blockquote>
 
-This decodes one packet's worth of float samples.
+This decodes up to 1024 float samples.
 </p>
 
 <br>

<p><p><p>--- >8 ----
List archives:  http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.