diff options
author | Anton Khirnov <anton@khirnov.net> | 2011-12-10 23:39:39 +0400 |
---|---|---|
committer | Anton Khirnov <anton@khirnov.net> | 2011-12-11 01:02:28 +0400 |
commit | 28b4c06b9dde290ac5a5743edd0eb8f7b4296d1a (patch) | |
tree | 395efc8400e9de3a446bf376c10e8d2c6e13eae4 /libavformat | |
parent | eca06cbed9160a16f5e6c58302f1b9e2ff116283 (diff) |
lavf doxy: expand/reword metadata API doxy.
Diffstat (limited to 'libavformat')
-rw-r--r-- | libavformat/avformat.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 525f8ff3b5..a0d8740566 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -94,9 +94,15 @@ struct AVFormatContext; * @{ * @ingroup libavf * The metadata API allows libavformat to export metadata tags to a client - * application using a sequence of key/value pairs. Like all strings in Libav, - * metadata must be stored as UTF-8 encoded Unicode. Note that metadata + * application when demuxing. Conversely it allows a client application to + * set metadata when muxing. + * + * Metadata is exported or set as pairs of key/value strings in the 'metadata' + * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs + * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav, + * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata * exported by demuxers isn't checked to be valid UTF-8 in most cases. + * * Important concepts to keep in mind: * - Keys are unique; there can never be 2 tags with the same key. This is * also meant semantically, i.e., a demuxer should not knowingly produce |