summaryrefslogtreecommitdiff
path: root/libavformat/avformat.h
diff options
context:
space:
mode:
authorAndreas Rheinhardt <andreas.rheinhardt@gmail.com>2020-06-21 06:47:23 +0200
committerAndreas Rheinhardt <andreas.rheinhardt@gmail.com>2020-06-22 12:20:23 +0200
commitb8c6aae575f09a1f2eef45e5b9d95b28790bc087 (patch)
treea2e19db5e7861d3b00e71641652fb0e2abeb374d /libavformat/avformat.h
parent45ddf06f54915bfcfb6bdfa8b983f4fdbf7bf4dc (diff)
avformat/avformat: Improve documentation of av_stream_get_side_data
Document that it also sets the size in case the desired side data is absent (if the pointer has been supplied). Reviewed-by: Anton Khirnov <anton@khirnov.net> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
Diffstat (limited to 'libavformat/avformat.h')
-rw-r--r--libavformat/avformat.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 21c282a100..e91e7f1d33 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -2189,7 +2189,8 @@ uint8_t *av_stream_new_side_data(AVStream *stream,
*
* @param stream stream
* @param type desired side information type
- * @param size pointer for side information size to store (optional)
+ * @param size If supplied, *size will be set to the size of the side data
+ * or to zero if the desired side data is not present.
* @return pointer to data if present or NULL otherwise
*/
uint8_t *av_stream_get_side_data(const AVStream *stream,