[xiph-commits] r3462 - liboggz/trunk/include/oggz

[conrad at svn.annodex.net]

Author: conrad
Date: 2008-02-14 23:48:30 -0800 (Thu, 14 Feb 2008)
New Revision: 3462

Modified:
   liboggz/trunk/include/oggz/oggz_read.h
Log:
add documentation about the use of oggz_tell_granulepos() for retrieving
calculated granulepos values in OggzReadCallbacks.


Modified: liboggz/trunk/include/oggz/oggz_read.h
===================================================================
--- liboggz/trunk/include/oggz/oggz_read.h	2008-02-15 07:27:34 UTC (rev 3461)
+++ liboggz/trunk/include/oggz/oggz_read.h	2008-02-15 07:48:30 UTC (rev 3462)
@@ -48,8 +48,16 @@
  * logical bitstream in the Ogg bitstream - see the \ref basics section for
  * more detail).
  *
- * See \ref seek_api for information on seeking on interleaved Ogg data.
+ * When using an OGGZ* opened with the OGGZ_AUTO flag set, OGGZ will
+ * internally calculate the granulepos for each packet, even though these
+ * are not all recorded in the file: only the last packet ending on a page
+ * will have its granulepos recorded in the page header.
+ * Within a OggzReadPacket callback, calling oggz_tell_granulepos() will
+ * retrieve the calculated granulepos.
  *
+ * See \ref seek_api for information on seeking on interleaved Ogg data,
+ * and for working with calculated granulepos values.
+ *
  * \{
  */