aboutsummaryrefslogtreecommitdiff
path: root/src/encoder_plugin.h
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2012-10-01 23:17:13 +0200
committerMax Kellermann <max@duempel.org>2012-10-02 00:18:18 +0200
commit43d82520502bc0c76fbd11d6e949739235166021 (patch)
tree3157bfc6f63a293509d2f3ca581f11bb6af02267 /src/encoder_plugin.h
parent674b4ab64735dac3b8113e09db4cdb9072ddacb7 (diff)
output/recorder, test/*: invoke encoder_read() after _open()
Make sure the file header gets written at the beginning, before _write() gets called.
Diffstat (limited to 'src/encoder_plugin.h')
-rw-r--r--src/encoder_plugin.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/encoder_plugin.h b/src/encoder_plugin.h
index 33a37911..cae0c804 100644
--- a/src/encoder_plugin.h
+++ b/src/encoder_plugin.h
@@ -119,6 +119,10 @@ encoder_finish(struct encoder *encoder)
* Before you free it, you must call encoder_close(). You may open
* and close (reuse) one encoder any number of times.
*
+ * After this function returns successfully and before the first
+ * encoder_write() call, you should invoke encoder_read() to obtain
+ * the file header.
+ *
* @param encoder the encoder
* @param audio_format the encoder's input audio format; the plugin
* may modify the struct to adapt it to its abilities