Old metadata API

The following functions are deprecated, use their equivalents from libavutil/dict.h instead. More...

Defines
#define	AV_METADATA_MATCH_CASE   AV_DICT_MATCH_CASE
#define	AV_METADATA_IGNORE_SUFFIX   AV_DICT_IGNORE_SUFFIX
#define	AV_METADATA_DONT_STRDUP_KEY   AV_DICT_DONT_STRDUP_KEY
#define	AV_METADATA_DONT_STRDUP_VAL   AV_DICT_DONT_STRDUP_VAL
#define	AV_METADATA_DONT_OVERWRITE   AV_DICT_DONT_OVERWRITE
Typedefs
typedef attribute_deprecated AVDictionary	AVMetadata
typedef attribute_deprecated AVDictionaryEntry	AVMetadataTag
typedef struct AVMetadataConv	AVMetadataConv
Functions
attribute_deprecated AVDictionaryEntry *	av_metadata_get (AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
	Get a metadata element with matching key.
attribute_deprecated int	av_metadata_set (AVMetadata **pm, const char *key, const char *value)
	Set the given tag in *pm, overwriting an existing tag.
attribute_deprecated int	av_metadata_set2 (AVDictionary **pm, const char *key, const char *value, int flags)
	Set the given tag in *pm, overwriting an existing tag.
attribute_deprecated void	av_metadata_conv (struct AVFormatContext *ctx, const AVMetadataConv *d_conv, const AVMetadataConv *s_conv)
	This function is provided for compatibility reason and currently does nothing.
attribute_deprecated void	av_metadata_copy (AVDictionary **dst, AVDictionary *src, int flags)
	Copy metadata from one AVDictionary struct into another.
attribute_deprecated void	av_metadata_free (AVDictionary **m)
	Free all the memory allocated for an AVDictionary struct.

---

Detailed Description

The following functions are deprecated, use their equivalents from libavutil/dict.h instead.

---

Define Documentation

#define AV_METADATA_DONT_OVERWRITE   AV_DICT_DONT_OVERWRITE

Definition at line 129 of file avformat.h.

#define AV_METADATA_DONT_STRDUP_KEY   AV_DICT_DONT_STRDUP_KEY

Definition at line 127 of file avformat.h.

#define AV_METADATA_DONT_STRDUP_VAL   AV_DICT_DONT_STRDUP_VAL

Definition at line 128 of file avformat.h.

Referenced by get_meta().

#define AV_METADATA_IGNORE_SUFFIX   AV_DICT_IGNORE_SUFFIX

Definition at line 126 of file avformat.h.

#define AV_METADATA_MATCH_CASE   AV_DICT_MATCH_CASE

Definition at line 125 of file avformat.h.

---

Typedef Documentation

typedef attribute_deprecated AVDictionary AVMetadata

Definition at line 131 of file avformat.h.

typedef struct AVMetadataConv AVMetadataConv

Definition at line 134 of file avformat.h.

typedef attribute_deprecated AVDictionaryEntry AVMetadataTag

Definition at line 132 of file avformat.h.

---

Function Documentation

attribute_deprecated void av_metadata_conv	(	struct AVFormatContext *	ctx,
		const AVMetadataConv *	d_conv,
		const AVMetadataConv *	s_conv
	)

This function is provided for compatibility reason and currently does nothing.

Definition at line 47 of file metadata.c.

attribute_deprecated void av_metadata_copy	(	AVDictionary **	dst,
		AVDictionary *	src,
		int	flags
	)

Copy metadata from one AVDictionary struct into another.

Parameters:

	dst	pointer to a pointer to a AVDictionary struct. If *dst is NULL, this function will allocate a struct for you and put it in *dst
	src	pointer to source AVDictionary struct
	flags	flags to use when setting metadata in *dst

Note:

metadata is read using the AV_DICT_IGNORE_SUFFIX flag

Definition at line 58 of file metadata.c.

attribute_deprecated void av_metadata_free

(

AVDictionary **

m

)

Free all the memory allocated for an AVDictionary struct.

Definition at line 53 of file metadata.c.

Referenced by avformat_free_context(), and prepare_sdp_description().

attribute_deprecated AVDictionaryEntry* av_metadata_get	(	AVDictionary *	m,
		const char *	key,
		const AVDictionaryEntry *	prev,
		int	flags
	)

Get a metadata element with matching key.

Parameters:

	prev	Set to the previous matching element to find the next. If set to NULL the first matching element is returned.
	flags	Allows case as well as suffix-insensitive comparisons.

Returns:

Found tag or NULL, changing key or value leads to undefined behavior.

Definition at line 28 of file metadata.c.

attribute_deprecated int av_metadata_set	(	AVMetadata **	pm,
		const char *	key,
		const char *	value
	)

Set the given tag in *pm, overwriting an existing tag.

Parameters:

	pm	pointer to a pointer to a metadata struct. If *pm is NULL a metadata struct is allocated and put in *pm.
	key	tag key to add to *pm (will be av_strduped)
	value	tag value to add to *pm (will be av_strduped)

Returns:

>= 0 on success otherwise an error code <0

Deprecated:

Use av_metadata_set2() instead.

Definition at line 39 of file metadata.c.

attribute_deprecated int av_metadata_set2	(	AVDictionary **	pm,
		const char *	key,
		const char *	value,
		int	flags
	)

Set the given tag in *pm, overwriting an existing tag.

Parameters:

	pm	pointer to a pointer to a metadata struct. If *pm is NULL a metadata struct is allocated and put in *pm.
	key	tag key to add to *pm (will be av_strduped depending on flags)
	value	tag value to add to *pm (will be av_strduped depending on flags). Passing a NULL value will cause an existing tag to be deleted.

Returns:

>= 0 on success otherwise an error code <0

Definition at line 33 of file metadata.c.

Referenced by av_metadata_set().