FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
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 {
   int64_t   i64
 
   double   dbl
 
   const char *   str
 
   AVRational   q
 
default_val
 
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 254 of file opt.h.

Field Documentation

const char* AVOption::name
const char* AVOption::help

short English help text

Todo:
What about other languages?

Definition at line 261 of file opt.h.

Referenced by opt_list(), and print_option().

int AVOption::offset
enum AVOptionType AVOption::type
int64_t AVOption::i64
double AVOption::dbl
const char* AVOption::str

Definition at line 276 of file opt.h.

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

AVRational AVOption::q

Definition at line 278 of file opt.h.

union { ... } AVOption::default_val
double AVOption::min

minimum valid value for the option

Definition at line 280 of file opt.h.

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

double AVOption::max

maximum valid value for the option

Definition at line 281 of file opt.h.

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

int AVOption::flags
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 309 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: