FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
Option getting functions
AVOptions

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_image_size (void *obj, const char *name, int search_flags, int *w_out, int *h_out)
 
int av_opt_get_pixel_fmt (void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt)
 
int av_opt_get_sample_fmt (void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt)
 
int av_opt_get_video_rate (void *obj, const char *name, int search_flags, AVRational *out_val)
 
int av_opt_get_channel_layout (void *obj, const char *name, int search_flags, int64_t *ch_layout)
 
int av_opt_get_dict_val (void *obj, const char *name, int search_flags, AVDictionary **out_val)
 

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

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

Definition at line 679 of file opt.c.

Referenced by av_opencl_get_option(), av_probe_input_buffer2(), ff_rtp_chain_mux_open(), hls_read_header(), parse_playlist(), and show_stream().

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 
)

Definition at line 819 of file opt.c.

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

Definition at line 831 of file opt.c.

int av_opt_get_image_size ( void obj,
const char *  name,
int  search_flags,
int *  w_out,
int *  h_out 
)

Definition at line 847 of file opt.c.

int av_opt_get_pixel_fmt ( void obj,
const char *  name,
int  search_flags,
enum AVPixelFormat out_fmt 
)

Definition at line 899 of file opt.c.

int av_opt_get_sample_fmt ( void obj,
const char *  name,
int  search_flags,
enum AVSampleFormat out_fmt 
)

Definition at line 904 of file opt.c.

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

Definition at line 865 of file opt.c.

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

Definition at line 909 of file opt.c.

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 926 of file opt.c.

Referenced by read_frame_internal().