Libav
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
 The offset relative to the context structure where the option value is stored. More...
 
enum AVOptionType type
 
union {
   int64_t   i64
 
   double   dbl
 
   const char *   str
 
   AVRational   q
 
default_val
 the default value for scalar options More...
 
double min
 minimum valid value for the option More...
 
double max
 maximum valid value for the option More...
 
int flags
 
const char * unit
 The logical unit to which the option belongs. More...
 

Detailed Description

AVOption.

Definition at line 234 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 241 of file opt.h.

Referenced by opt_list(), and print_option().

§ offset

int AVOption::offset

The offset relative to the context structure where the option value is stored.

It should be 0 for named constants.

Definition at line 247 of file opt.h.

Referenced by av_opt_free(), av_opt_get(), av_opt_get_dict_val(), av_opt_set(), av_opt_set_bin(), av_opt_set_dict_val(), get_number(), and set_number().

§ type

enum AVOptionType AVOption::type

§ i64

int64_t AVOption::i64

Definition at line 254 of file opt.h.

Referenced by av_opt_flag_is_set(), and av_opt_set_defaults().

§ dbl

double AVOption::dbl

Definition at line 255 of file opt.h.

Referenced by av_opt_set_defaults().

§ str

const char* AVOption::str

Definition at line 256 of file opt.h.

Referenced by av_opt_set_defaults().

§ q

AVRational AVOption::q

Definition at line 258 of file opt.h.

§ default_val

union { ... } AVOption::default_val

the default value for scalar options

Referenced by av_opt_flag_is_set(), and av_opt_set_defaults().

§ min

double AVOption::min

minimum valid value for the option

Definition at line 260 of file opt.h.

Referenced by set_string_number().

§ max

double AVOption::max

maximum valid value for the option

Definition at line 261 of file opt.h.

Referenced by 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 288 of file opt.h.

Referenced by av_opt_find2(), av_opt_flag_is_set(), opt_list(), print_option(), and set_string_number().


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