diff options
Diffstat (limited to 'src/encoder_plugin.h')
| -rw-r--r-- | src/encoder_plugin.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/encoder_plugin.h b/src/encoder_plugin.h index 33a379115..cae0c8048 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 |