summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJosh Coalson <jcoalson@users.sourceforce.net>2002-08-08 22:50:31 +0000
committerJosh Coalson <jcoalson@users.sourceforce.net>2002-08-08 22:50:31 +0000
commit43e06aaa8ba478cf995ba8c6aebbb6365b68cb68 (patch)
tree30b568cc67885d5ecd4d58b4eb7aa4459541c241 /include
parent6a56fe9ef9866ce5f6a61d88e3f03bfa9d2639f1 (diff)
downloadflac-43e06aaa8ba478cf995ba8c6aebbb6365b68cb68.tar.gz
minor comments
Diffstat (limited to 'include')
-rw-r--r--include/OggFLAC/stream_encoder.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/include/OggFLAC/stream_encoder.h b/include/OggFLAC/stream_encoder.h
index 483b3f25..f1b97c58 100644
--- a/include/OggFLAC/stream_encoder.h
+++ b/include/OggFLAC/stream_encoder.h
@@ -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