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


Field Documentation

const char * AVOption::name

Definition at line 49 of file opt.h.

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

const char * AVOption::help

short English help text

Todo:
What about other languages?
Todo:
What about other languages?

Definition at line 55 of file opt.h.

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

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

the default value for scalar options

Definition at line 67 of file opt.h.

Referenced by av_opt_set_defaults2(), and av_set_string3().

double AVOption::min

minimum valid value for the option

Definition at line 68 of file opt.h.

Referenced by av_set_string3().

double AVOption::max

maximum valid value for the option

Definition at line 69 of file opt.h.

Referenced by av_set_number2(), and av_set_string3().

Definition at line 71 of file opt.h.

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

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

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


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

Generated on Tue Apr 20 17:40:02 2010 for FFmpeg by  doxygen 1.5.6