diff options
| author | Janne Grunau <janne-vlc@jannau.net> | 2018-11-29 00:22:54 +0300 |
|---|---|---|
| committer | Ronald S. Bultje <rsbultje@gmail.com> | 2018-11-29 02:05:11 +0300 |
| commit | a1fb26646351ce9e1e9953cc1fb9da82418c0d98 (patch) | |
| tree | e3488885712f4d972cd66218e0b5407743d7c6a5 /include/dav1d/dav1d.h | |
| parent | eb31119d0726d1eb2c90e79ce321f03f162d2efc (diff) | |
doc: extend dav1d_flush Doxygen
Diffstat (limited to 'include/dav1d/dav1d.h')
| -rw-r--r-- | include/dav1d/dav1d.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/include/dav1d/dav1d.h b/include/dav1d/dav1d.h index d13ad36..15365e1 100644 --- a/include/dav1d/dav1d.h +++ b/include/dav1d/dav1d.h @@ -172,9 +172,14 @@ DAV1D_API int dav1d_get_picture(Dav1dContext *c, Dav1dPicture *out); 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); |