Option setting functions

Those functions set the field of obj with the given name to value. More...

Macros
#define	av_opt_set_int_list(obj, name, val, term, flags)
	Set a binary option to an integer list. More...

Functions
int	av_opt_set (void *obj, const char *name, const char *val, int search_flags)
int	av_opt_set_int (void *obj, const char *name, int64_t val, int search_flags)
int	av_opt_set_double (void *obj, const char *name, double val, int search_flags)
int	av_opt_set_q (void *obj, const char *name, AVRational val, int search_flags)
int	av_opt_set_bin (void *obj, const char *name, const uint8_t *val, int size, int search_flags)
int	av_opt_set_image_size (void *obj, const char *name, int w, int h, int search_flags)
int	av_opt_set_pixel_fmt (void *obj, const char *name, enum AVPixelFormat fmt, int search_flags)
int	av_opt_set_sample_fmt (void *obj, const char *name, enum AVSampleFormat fmt, int search_flags)
int	av_opt_set_video_rate (void *obj, const char *name, AVRational val, int search_flags)
attribute_deprecated int	av_opt_set_channel_layout (void *obj, const char *name, int64_t ch_layout, int search_flags)
int	av_opt_set_chlayout (void *obj, const char *name, const AVChannelLayout *layout, int search_flags)
int	av_opt_set_dict_val (void *obj, const char *name, const AVDictionary *val, int search_flags)

Detailed Description

Those functions set the field of obj with the given name to value.

Parameters

[in]	obj	A struct whose first element is a pointer to an AVClass.
[in]	name	the name of the field to set
[in]	val	The value to set. In case of av_opt_set() if the field is not of a string type, then the given string is parsed. SI postfixes and some named scalars are supported. If the field is of a numeric type, it has to be a numeric or named scalar. Behavior with more than one scalar and +- infix operators is undefined. If the field is of a flags type, it has to be a sequence of numeric scalars or named flags separated by '+' or '-'. Prefixing a flag with '+' causes it to be set without affecting the other flags; similarly, '-' unsets a flag. If the field is of a dictionary type, it has to be a ':' separated list of key=value parameters. Values containing ':' special characters must be escaped.
	search_flags	flags passed to av_opt_find2. I.e. if AV_OPT_SEARCH_CHILDREN is passed here, then the option may be set on a child of obj.

Returns

0 if the value has been set, or an AVERROR code in case of error: AVERROR_OPTION_NOT_FOUND if no matching option exists AVERROR(ERANGE) if the value is out of range AVERROR(EINVAL) if the value is not valid

Macro Definition Documentation

av_opt_set_int_list

#define av_opt_set_int_list	(		obj,
			name,
			val,
			term,
			flags
	)

Value:

    (av_int_list_length(val, term) > INT_MAX / sizeof(*(val)) ? \
     AVERROR(EINVAL) : \
     av_opt_set_bin(obj, name, (const uint8_t *)(val), \
                    av_int_list_length(val, term) * sizeof(*(val)), flags))

Set a binary option to an integer list.

Parameters

obj	AVClass object to set options on
name	name of the binary option
val	pointer to an integer list (must have the correct type with regard to the contents of the list)
term	list terminator (usually 0 or -1)
flags	search flags

Examples

filtering_audio.c, and filtering_video.c.

Definition at line 721 of file opt.h.

Function Documentation

av_opt_set()

int av_opt_set	(	void *	obj,
		const char *	name,
		const char *	val,
		int	search_flags
	)

Examples

encode_video.c, filter_audio.c, filtering_audio.c, and transcoding.c.

Referenced by init_filter(), init_filter_graph(), init_filters(), and main().

av_opt_set_int()

int av_opt_set_int	(	void *	obj,
		const char *	name,
		int64_t	val,
		int	search_flags
	)

Examples

filter_audio.c, http_multiclient.c, muxing.c, and resampling_audio.c.

Referenced by init_filter_graph(), main(), open_audio(), and process_client().

av_opt_set_double()

int av_opt_set_double	(	void *	obj,
		const char *	name,
		double	val,
		int	search_flags
	)

av_opt_set_q()

int av_opt_set_q	(	void *	obj,
		const char *	name,
		AVRational	val,
		int	search_flags
	)

Examples

filter_audio.c.

Referenced by init_filter_graph().

av_opt_set_bin()

int av_opt_set_bin	(	void *	obj,
		const char *	name,
		const uint8_t *	val,
		int	size,
		int	search_flags
	)

Examples

transcoding.c.

Referenced by init_filter().

av_opt_set_image_size()

int av_opt_set_image_size	(	void *	obj,
		const char *	name,
		int	w,
		int	h,
		int	search_flags
	)

av_opt_set_pixel_fmt()

int av_opt_set_pixel_fmt	(	void *	obj,
		const char *	name,
		enum AVPixelFormat	fmt,
		int	search_flags
	)

av_opt_set_sample_fmt()

int av_opt_set_sample_fmt	(	void *	obj,
		const char *	name,
		enum AVSampleFormat	fmt,
		int	search_flags
	)

Examples

muxing.c, and resampling_audio.c.

Referenced by main(), and open_audio().

av_opt_set_video_rate()

int av_opt_set_video_rate	(	void *	obj,
		const char *	name,
		AVRational	val,
		int	search_flags
	)

av_opt_set_channel_layout()

attribute_deprecated int av_opt_set_channel_layout	(	void *	obj,
		const char *	name,
		int64_t	ch_layout,
		int	search_flags
	)

av_opt_set_chlayout()

int av_opt_set_chlayout	(	void *	obj,
		const char *	name,
		const AVChannelLayout *	layout,
		int	search_flags
	)

Examples

muxing.c, and resampling_audio.c.

Referenced by main(), and open_audio().

av_opt_set_dict_val()

int av_opt_set_dict_val	(	void *	obj,
		const char *	name,
		const AVDictionary *	val,
		int	search_flags
	)

Note

Any old dictionary present is discarded and replaced with a copy of the new one. The caller still owns val is and responsible for freeing it.