RepoMirrors/ffmpeg
1
0
Fork 0
mirror of https://git.ffmpeg.org/ffmpeg.git synced 2024-12-13 02:34:54 +00:00
Code Issues Projects Releases Wiki Activity

lavf doxy: expand/reword metadata API doxy.

Browse Source
This commit is contained in:
Anton Khirnov 2011-12-10 20:39:39 +01:00
parent eca06cbed9
commit 28b4c06b9d
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
libavformat/avformat.h
View File

@ -94,9 +94,15 @@ struct AVFormatContext;
* @{ * @{
* @ingroup libavf * @ingroup libavf
* The metadata API allows libavformat to export metadata tags to a client * 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, * application when demuxing. Conversely it allows a client application to
* metadata must be stored as UTF-8 encoded Unicode. Note that metadata * 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. * exported by demuxers isn't checked to be valid UTF-8 in most cases.
*
* Important concepts to keep in mind: * Important concepts to keep in mind:
* - Keys are unique; there can never be 2 tags with the same key. This is * - 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 * also meant semantically, i.e., a demuxer should not knowingly produce