Option setting functions

Those functions set the field of obj with the given name to value. 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_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]objA struct whose first element is a pointer to an AVClass.
[in]namethe name of the field to set
[in]valThe 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.
search_flagsflags 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

Function Documentation

◆ av_opt_set()

int av_opt_set ( void *  obj,
const char *  name,
const char *  val,
int  search_flags 
)
Examples:
filter_audio.c.

Referenced by init_filter_graph().

◆ av_opt_set_int()

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

◆ 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 
)

◆ 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.