diff options
Diffstat (limited to 'vpx/vpx_encoder.h')
| -rw-r--r-- | vpx/vpx_encoder.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/vpx/vpx_encoder.h b/vpx/vpx_encoder.h index c45d1a2ba..e65d27221 100644 --- a/vpx/vpx_encoder.h +++ b/vpx/vpx_encoder.h @@ -970,12 +970,21 @@ vpx_codec_err_t vpx_codec_enc_config_set(vpx_codec_ctx_t *ctx, * * Retrieves a stream level global header packet, if supported by the codec. * + * \li VP8: Unsupported + * \li VP9: Returns a buffer of <tt>ID (1 byte)|Length (1 byte)|Length + * bytes</tt> values. The function should be called after encoding to retrieve + * the most accurate information. + * * \param[in] ctx Pointer to this instance's context * * \retval NULL * Encoder does not support global header * \retval Non-NULL - * Pointer to buffer containing global header packet + * Pointer to buffer containing global header packet. The buffer pointer + * and its contents are only valid for the lifetime of \a ctx. The contents + * may change in subsequent calls to the function. + * \sa + * https://www.webmproject.org/docs/container/#vp9-codec-feature-metadata-codecprivate */ vpx_fixed_buf_t *vpx_codec_get_global_headers(vpx_codec_ctx_t *ctx); |