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

[Michael Smith]

msmith      02/07/23 06:33:58

  Modified:    doc/vorbisfile ov_read_float.html
  Log:
  More ov_read_float() doc fixes that I missed last time

Revision  Changes    Path
1.4       +2 -2      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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ov_read_float.html	2002/07/21 01:35:21	1.3
+++ ov_read_float.html	2002/07/23 13:33:58	1.4
@@ -64,7 +64,7 @@
 <dt>0</dt>
   <dd>indicates EOF</dd>
 <dt><i>n</i></dt>
-  <dd>indicates actual number of bytes read.  <tt>ov_read()</tt> will
+  <dd>indicates actual number of samples read.  <tt>ov_read_float()</tt> will
       decode at most one vorbis packet per invocation, so the value
       returned will generally be less than <tt>length</tt>.
 </dl>
@@ -74,7 +74,7 @@
 <p><b>Typical usage:</b>
 <blockquote>
 <tt>float **pcm;
-bytes_read = ov_read_float(&amp;vf,pcm, 1024, &amp;current_section)</tt>
+samples_read = ov_read_float(&amp;vf,pcm, 1024, &amp;current_section)</tt>
 </blockquote>
 
 This decodes up to 1024 float samples.

<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.