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


Field Documentation

double AVOption::dbl

Definition at line 69 of file opt.h.

Referenced by av_get_number(), av_opt_flag_is_set(), av_opt_set_defaults2(), and av_set_string3().

union { ... } AVOption::default_val

the default value for scalar options

Referenced by av_get_number(), av_opt_flag_is_set(), av_opt_set_defaults2(), and av_set_string3().

const char* AVOption::help

short English help text

Todo:
What about other languages?

Definition at line 56 of file opt.h.

Referenced by opt_list().

int64_t AVOption::i64

Definition at line 72 of file opt.h.

double AVOption::max

maximum valid value for the option

Definition at line 76 of file opt.h.

Referenced by av_set_number2(), and av_set_string3().

double AVOption::min

minimum valid value for the option

Definition at line 75 of file opt.h.

Referenced by av_set_string3().

const char* AVOption::name

Definition at line 50 of file opt.h.

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

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

It should be 0 for named constants.

Definition at line 62 of file opt.h.

Referenced by av_get_number(), av_get_string(), av_opt_free(), av_set_number2(), and av_set_string3().

Definition at line 73 of file opt.h.

const char* AVOption::str

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

Referenced by av_find_opt(), av_opt_find(), av_set_string3(), and opt_list().


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

Generated on Fri Oct 26 02:38:23 2012 for FFmpeg by  doxygen 1.5.8