diff mbox series

[FFmpeg-devel] lavf/avformat.h: document av_guess_codec() parameters

Message ID 20220612162355.147219-1-stefasab@gmail.com
State New
Headers show
Series [FFmpeg-devel] lavf/avformat.h: document av_guess_codec() parameters | expand


Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished
andriy/make_armv7_RPi4 success Make finished
andriy/make_fate_armv7_RPi4 success Make fate finished

Commit Message

Stefano Sabatini June 12, 2022, 4:23 p.m. UTC
Also annotate that some of the parameters were never used.

Fix trac issue:
 libavformat/avformat.h | 9 +++++++++
 1 file changed, 9 insertions(+)
diff mbox series


diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index f12fa7d904..58030f1814 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -2493,6 +2493,15 @@  const AVOutputFormat *av_guess_format(const char *short_name,
  * Guess the codec ID based upon muxer and filename.
+ *
+ * @param fmt        the output format, for example one computed by
+ *                   av_guess_format()
+ * @param short_name currently ignored
+ * @param filename   the filename where the encoded stream is going to be stored
+ * @param mime_type  currently ignored
+ * @param media_type the codec media type
+ * @return the guessed codec ID, or AV_CODEC_ID_NONE in case none could be guessed
+ *
 enum AVCodecID av_guess_codec(const AVOutputFormat *fmt, const char *short_name,
                               const char *filename, const char *mime_type,