FFmpeg
Data Fields
AVOption Struct Reference

AVOption. More...

#include <opt.h>

Data Fields

const char * name
 
const char * help
 short English help text More...
 
int offset
 Native access only. More...
 
enum AVOptionType type
 
union {
   int64_t   i64
 
   double   dbl
 
   const char *   str
 
   AVRational   q
 
   const AVOptionArrayDef *   arr
 Used for AV_OPT_TYPE_FLAG_ARRAY options. More...
 
default_val
 Native access only, except when documented otherwise. More...
 
double min
 minimum valid value for the option More...
 
double max
 maximum valid value for the option More...
 
int flags
 A combination of AV_OPT_FLAG_*. More...
 
const char * unit
 The logical unit to which the option belongs. More...
 

Detailed Description

AVOption.

Definition at line 346 of file opt.h.

Field Documentation

◆ name

const char* AVOption::name

◆ help

const char* AVOption::help

short English help text

Todo:
What about other languages?

Definition at line 353 of file opt.h.

Referenced by av_opt_get(), av_opt_set(), opt_list(), print_option(), and set_string_number().

◆ offset

int AVOption::offset

Native access only.

The offset relative to the context structure where the option value is stored. It should be 0 for named constants.

Definition at line 361 of file opt.h.

Referenced by av_opt_copy(), av_opt_free(), av_opt_get(), av_opt_get_chlayout(), av_opt_get_dict_val(), av_opt_get_image_size(), av_opt_is_set_to_default(), av_opt_ptr(), av_opt_set(), av_opt_set_bin(), av_opt_set_chlayout(), av_opt_set_defaults2(), av_opt_set_dict_val(), av_opt_set_image_size(), ff_filter_opt_parse(), get_format(), get_number(), set_format(), and set_number().

◆ type

enum AVOptionType AVOption::type

◆ i64

int64_t AVOption::i64

◆ dbl

double AVOption::dbl

Definition at line 370 of file opt.h.

Referenced by av_opt_is_set_to_default(), av_opt_set_defaults2(), and log_default().

◆ str

const char* AVOption::str

Definition at line 371 of file opt.h.

Referenced by av_opt_is_set_to_default(), av_opt_set_defaults2(), and log_default().

◆ q

AVRational AVOption::q

Definition at line 373 of file opt.h.

◆ arr

const AVOptionArrayDef* AVOption::arr

Used for AV_OPT_TYPE_FLAG_ARRAY options.

May be NULL.

Foreign access to some members allowed, as noted in AVOptionArrayDef documentation.

Definition at line 381 of file opt.h.

Referenced by av_opt_is_set_to_default(), av_opt_set_defaults2(), log_default(), opt_array_sep(), and opt_set_array().

◆ default_val

union { ... } AVOption::default_val

Native access only, except when documented otherwise.

the default value for scalar options

Referenced by av_opt_is_set_to_default(), av_opt_set_defaults2(), get_opt_const_name(), get_opt_flags_string(), log_default(), log_type(), opt_array_sep(), opt_get_elem(), opt_set_array(), and read_number().

◆ min

double AVOption::min

minimum valid value for the option

Definition at line 383 of file opt.h.

Referenced by opt_set_elem(), set_format(), set_string_fmt(), set_string_number(), and write_number().

◆ max

double AVOption::max

maximum valid value for the option

Definition at line 384 of file opt.h.

Referenced by opt_set_elem(), set_format(), set_string_bool(), set_string_fmt(), set_string_number(), and write_number().

◆ flags

int AVOption::flags

◆ unit

const char* AVOption::unit

The logical unit to which the option belongs.

Non-constant options and corresponding named constants share the same unit. May be NULL.

Definition at line 396 of file opt.h.

Referenced by av_opt_find2(), get_opt_const_name(), get_opt_flags_string(), log_default(), opt_list(), option_is_disposition(), print_option(), and set_string_number().


The documentation for this struct was generated from the following file: