diff options
| author | Michael Niedermayer <michael@niedermayer.cc> | 2016-05-28 16:57:15 +0200 |
|---|---|---|
| committer | Michael Niedermayer <michael@niedermayer.cc> | 2016-06-01 18:12:45 +0200 |
| commit | d1efdd54f2bf034960df5e09165c6b4599e44022 (patch) | |
| tree | 2be4c8fd82d4e314e32cf2e78c5c2eead31a7251 /libavformat/avformat.h | |
| parent | b8426b865edd2f82a26ab7e990dd98a174b9da32 (diff) | |
| download | ffmpeg-d1efdd54f2bf034960df5e09165c6b4599e44022.tar.gz | |
avformat: Document where the AVOption names can be found for the fields of AVFormatContext
Missing docs found by: nevcairiel
RFC: should we add support so that the C field names always work as av option names/keys ?
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavformat/avformat.h')
| -rw-r--r-- | libavformat/avformat.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 3eeeb9a139..f66c39b1c1 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -1305,6 +1305,12 @@ typedef struct AVFormatInternal AVFormatInternal; * version bump. * sizeof(AVFormatContext) must not be used outside libav*, use * avformat_alloc_context() to create an AVFormatContext. + * + * Fields can be accessed through AVOptions (av_opt*), + * the name string used matches the associated command line parameter name and + * can be found in libavformat/options_table.h. + * The AVOption/command line parameter names differ in some cases from the C + * structure field names for historic reasons or brevity. */ typedef struct AVFormatContext { /** |