summaryrefslogtreecommitdiff
path: root/include/FLAC
diff options
context:
space:
mode:
authorJosh Coalson <jcoalson@users.sourceforce.net>2007-01-29 08:27:25 +0000
committerJosh Coalson <jcoalson@users.sourceforce.net>2007-01-29 08:27:25 +0000
commit1c034079312e177920d1c772a267c66713677a36 (patch)
tree7749c623791272962c0c91ae3b3789ecfeca9d7a /include/FLAC
parent8008739dc5acd272dc56a4702493feb3645d5d35 (diff)
downloadflac-1c034079312e177920d1c772a267c66713677a36.tar.gz
in FLAC__stream_encoder_set_metadata(), copy the metadata array of pointers instead of requiring the caller to keep it until initialization; the objects themselves are still owned by caller
Diffstat (limited to 'include/FLAC')
-rw-r--r--include/FLAC/stream_encoder.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/FLAC/stream_encoder.h b/include/FLAC/stream_encoder.h
index 64207f5c..9fca5a48 100644
--- a/include/FLAC/stream_encoder.h
+++ b/include/FLAC/stream_encoder.h
@@ -1104,12 +1104,12 @@ FLAC_API FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__Stream
* the encoder may need to change the \a is_last flag inside them, and
* in some cases update seek point offsets. Otherwise, the encoder will
* not modify or free the blocks. It is up to the caller to free the
- * metadata blocks after encoding.
+ * metadata blocks after encoding finishes.
*
* \note
- * The encoder stores only the \a metadata pointer; the passed-in array
- * must survive at least until after FLAC__stream_encoder_init_*() returns.
- * Do not modify the array or free the blocks until then.
+ * The encoder stores only copies of the pointers in the \a metadata array;
+ * the metadata blocks themselves must survive at least until after
+ * FLAC__stream_encoder_finish() returns. Do not free the blocks until then.
*
* \note
* The STREAMINFO block is always written and no STREAMINFO block may