Libav
Functions
Option getting functions

Those functions get a value of the option with the given name from an object. More...

Functions

int av_opt_get (void *obj, const char *name, int search_flags, uint8_t **out_val)
 
int av_opt_get_int (void *obj, const char *name, int search_flags, int64_t *out_val)
 
int av_opt_get_double (void *obj, const char *name, int search_flags, double *out_val)
 
int av_opt_get_q (void *obj, const char *name, int search_flags, AVRational *out_val)
 
int av_opt_get_dict_val (void *obj, const char *name, int search_flags, AVDictionary **out_val)
 
int av_opt_copy (void *dest, const void *src)
 Copy options from src object into dest object. More...
 

Detailed Description

Those functions get a value of the option with the given name from an object.

Parameters
[in]obja struct whose first element is a pointer to an AVClass.
[in]namename of the option to get.
[in]search_flagsflags passed to av_opt_find2. I.e. if AV_OPT_SEARCH_CHILDREN is passed here, then the option may be found in a child of obj.
[out]out_valvalue of the option will be written here
Returns
0 on success, a negative error code otherwise

Function Documentation

◆ av_opt_get()

int av_opt_get ( void obj,
const char *  name,
int  search_flags,
uint8_t **  out_val 
)
Note
the returned string will av_malloc()ed and must be av_free()ed by the caller

Definition at line 370 of file opt.c.

Referenced by av_probe_input_buffer(), ff_rtp_chain_mux_open(), parse_playlist(), and save_avio_options().

◆ av_opt_get_int()

int av_opt_get_int ( void obj,
const char *  name,
int  search_flags,
int64_t *  out_val 
)

◆ av_opt_get_double()

int av_opt_get_double ( void obj,
const char *  name,
int  search_flags,
double *  out_val 
)

Definition at line 459 of file opt.c.

◆ av_opt_get_q()

int av_opt_get_q ( void obj,
const char *  name,
int  search_flags,
AVRational out_val 
)

Definition at line 471 of file opt.c.

◆ av_opt_get_dict_val()

int av_opt_get_dict_val ( void obj,
const char *  name,
int  search_flags,
AVDictionary **  out_val 
)
Parameters
[out]out_valThe returned dictionary is a copy of the actual value and must be freed with av_dict_free() by the caller

Definition at line 487 of file opt.c.

Referenced by read_frame_internal().

◆ av_opt_copy()

int av_opt_copy ( void dest,
const void src 
)

Copy options from src object into dest object.

Options that require memory allocation (e.g. string or binary) are malloc'ed in dest object. Original memory allocated for such options is freed unless both src and dest options points to the same memory.

Parameters
destObject to copy from
srcObject to copy into
Returns
0 on success, negative on error

Definition at line 838 of file opt.c.

Referenced by ffurl_open().