minor comments
authorJosh Coalson <jcoalson@users.sourceforce.net>
Thu, 8 Aug 2002 22:50:31 +0000 (22:50 +0000)
committerJosh Coalson <jcoalson@users.sourceforce.net>
Thu, 8 Aug 2002 22:50:31 +0000 (22:50 +0000)
include/OggFLAC/stream_encoder.h

index 483b3f2..f1b97c5 100644 (file)
@@ -376,6 +376,13 @@ FLAC__bool OggFLAC__stream_encoder_set_metadata(OggFLAC__StreamEncoder *encoder,
 /** Set the write callback.
  *
  * \note
+ * Unlike the FLAC stream encoder write callback, the Ogg stream
+ * encoder write callback will be called twice when writing audio
+ * frames; once for the page header, and once for the page body.
+ * When writing the page header, the \a samples argument to the
+ * write callback will be \c 0.
+ *
+ * \note
  * The callback is mandatory and must be set before initialization.
  *
  * \default \c NULL