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

Field Documentation

name

const char* AVOption::name

Definition at line 247 of file opt.h.

Referenced by av_bitstream_filter_filter(), av_opt_find2(), av_opt_is_set_to_default(), av_opt_serialize(), av_opt_set(), av_opt_set_channel_layout(), av_opt_set_defaults2(), av_opt_set_image_size(), av_opt_set_video_rate(), check_video_streams(), dump_video_streams(), ff_decode_bsfs_init(), ff_stream_add_bitstream_filter(), get_opt_const_name(), get_opt_flags_string(), libcodec2_init_common(), main(), new_output_stream(), opt_list(), print_option(), process_options(), set_string_fmt(), set_string_number(), show_stream(), and write_number().

help

const char* AVOption::help

short English help text

Todo:

What about other languages?

Definition at line 253 of file opt.h.

Referenced by av_opt_get(), av_opt_set(), 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 259 of file opt.h.

Referenced by av_opt_copy(), av_opt_free(), av_opt_get(), av_opt_get_channel_layout(), av_opt_get_dict_val(), av_opt_get_image_size(), av_opt_is_set_to_default(), av_opt_ptr(), av_opt_set(), av_opt_set_bin(), av_opt_set_channel_layout(), av_opt_set_defaults2(), av_opt_set_dict_val(), av_opt_set_image_size(), get_format(), get_number(), process_options(), set_format(), and set_number().

type

enum AVOptionType AVOption::type

Definition at line 260 of file opt.h.

Referenced by av_opt_copy(), av_opt_find2(), av_opt_free(), av_opt_get(), av_opt_get_channel_layout(), av_opt_get_dict_val(), av_opt_get_image_size(), av_opt_is_set_to_default(), av_opt_serialize(), av_opt_set(), av_opt_set_bin(), av_opt_set_channel_layout(), av_opt_set_defaults2(), av_opt_set_image_size(), av_opt_set_video_rate(), check_video_streams(), dump_video_streams(), get_format(), get_opt_const_name(), get_opt_flags_string(), opt_list(), print_option(), process_options(), read_number(), set_format(), set_string_number(), show_opts(), and write_number().

i64

int64_t AVOption::i64

Definition at line 266 of file opt.h.

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

dbl

double AVOption::dbl

Definition at line 267 of file opt.h.

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

str

const char* AVOption::str

Definition at line 268 of file opt.h.

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

q

AVRational AVOption::q

Definition at line 270 of file opt.h.

default_val

union { ... } AVOption::default_val

the default value for scalar options

Referenced by av_opt_get(), av_opt_is_set_to_default(), av_opt_set_defaults2(), get_opt_const_name(), get_opt_flags_string(), opt_list(), and read_number().

min

double AVOption::min

minimum valid value for the option

Definition at line 272 of file opt.h.

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

max

double AVOption::max

maximum valid value for the option

Definition at line 273 of file opt.h.

Referenced by av_opt_set(), set_format(), set_string_bool(), set_string_fmt(), set_string_number(), and write_number().

flags

int AVOption::flags

Definition at line 275 of file opt.h.

Referenced by av_opt_find2(), av_opt_get(), av_opt_serialize(), av_opt_set(), av_opt_set_bin(), av_opt_set_defaults2(), av_opt_set_dict_val(), opt_find(), opt_list(), print_option(), set_number(), and show_stream().

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

Referenced by av_opt_find2(), get_opt_const_name(), get_opt_flags_string(), opt_list(), print_option(), and set_string_number().

---

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

• libavutil/opt.h