AVOption Struct Reference

AVOption. More...

#include <opt.h>

Data Fields

const char * name
const char * help
 short English help text
int offset
 The offset relative to the context structure where the option value is stored.
enum AVOptionType type
union {
   double   dbl
   const char *   str
   int64_t   i64
   AVRational   q
default_val
 the default value for scalar options
double min
 minimum valid value for the option
double max
 maximum valid value for the option
int flags
const char * unit
 The logical unit to which the option belongs.

Detailed Description

AVOption.

Definition at line 244 of file opt.h.

Field Documentation

double AVOption::dbl

Definition at line 264 of file opt.h.

Referenced by av_opt_flag_is_set(), av_opt_set_defaults2(), and set_string_number().

union { ... } AVOption::default_val

the default value for scalar options

Referenced by av_opt_flag_is_set(), av_opt_set_defaults2(), and set_string_number().

int AVOption::flags

Definition at line 273 of file opt.h.

Referenced by av_find_opt(), av_opt_find2(), av_opt_set_defaults2(), and opt_list().

const char* AVOption::help

short English help text

Todo:
What about other languages?

Definition at line 251 of file opt.h.

Referenced by opt_list().

int64_t AVOption::i64

Definition at line 267 of file opt.h.

double AVOption::max

maximum valid value for the option

Definition at line 271 of file opt.h.

Referenced by set_string_number(), and write_number().

double AVOption::min

minimum valid value for the option

Definition at line 270 of file opt.h.

Referenced by set_string_number().

const char* AVOption::name
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 257 of file opt.h.

Referenced by av_get_string(), av_opt_free(), av_opt_get(), av_opt_set(), get_number(), and set_number().

AVRational AVOption::q

Definition at line 268 of file opt.h.

const char* AVOption::str

Definition at line 265 of file opt.h.

Referenced by av_opt_set_defaults2().

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 287 of file opt.h.

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


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