avformat/avformat: Improve documentation of av_stream_get_side_data
authorAndreas Rheinhardt <andreas.rheinhardt@gmail.com>
Sun, 21 Jun 2020 04:47:23 +0000 (06:47 +0200)
committerAndreas Rheinhardt <andreas.rheinhardt@gmail.com>
Mon, 22 Jun 2020 10:20:23 +0000 (12:20 +0200)
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>
libavformat/avformat.h

index 21c282a..e91e7f1 100644 (file)
@@ -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,