ref: a1fb26646351ce9e1e9953cc1fb9da82418c0d98
parent: eb31119d0726d1eb2c90e79ce321f03f162d2efc
author: Janne Grunau <janne-vlc@jannau.net>
date: Wed Nov 28 17:22:54 EST 2018
doc: extend dav1d_flush Doxygen
--- a/include/dav1d/dav1d.h
+++ b/include/dav1d/dav1d.h
@@ -172,9 +172,14 @@
DAV1D_API void dav1d_close(Dav1dContext **c_out);
/**
- * Flush all delayed frames in decoder, to be used when seeking.
+ * Flush all delayed frames in decoder and clear internal decoder state,
+ * to be used when seeking.
*
* @param c Input decoder instance.
+ *
+ * @note Decoding will start only after a valid sequence header OBU is
+ * delivered to dav1d_send_data().
+ *
*/
DAV1D_API void dav1d_flush(Dav1dContext *c);