FFmpeg
Loading...
Searching...
No Matches
Data Fields
AVOption Struct Reference

AVOption. More...

#include <opt.h>

Data Fields

const char *  name
 
const char *  help
  short English help text
 
int  offset
  Native access only.
 
 
union { 
 
   int64_t   i64 
 
   double   dbl 
 
   const char *   str 
 
   AVRational   q 
 
   const AVOptionArrayDef *   arr 
  Used for AV_OPT_TYPE_FLAG_ARRAY options. More...
 
default_val 
  Native access only, except when documented otherwise.
 
  minimum valid value for the option
 
  maximum valid value for the option
 
int  flags
  A combination of AV_OPT_FLAG_*.
 
const char *  unit
  The logical unit to which the option belongs.
 

Detailed Description

AVOption.

Definition at line 428 of file opt.h.

Field Documentation

◆  name

const char* AVOption::name

Definition at line 429 of file opt.h.

Referenced by av_opt_find2(), av_opt_is_set_to_default(), av_opt_set_array(), av_opt_set_defaults2(), av_opt_set_image_size(), bsf_list_append_internal(), bsf_opt_parse(), ff_filter_opt_parse(), ff_parse_opts_from_query_string(), get_opt_const_name(), get_opt_flags_string(), main(), opt_list(), opt_serialize(), opt_set_array(), opt_set_elem(), opt_set_init(), print_option(), print_private_data(), priv_data_size_wrong(), set_string_bool(), set_string_color(), set_string_fmt(), set_string_image_size(), set_string_number(), set_string_video_rate(), and write_number().

◆  help

const char* AVOption::help

short English help text

Todo
What about other languages?

Definition at line 435 of file opt.h.

Referenced by av_opt_get(), opt_list(), opt_set_init(), print_option(), and set_string_number().

◆  offset

int AVOption::offset

Native access only.

The offset relative to the context structure where the option value is stored. It should be 0 for named constants.

Definition at line 443 of file opt.h.

Referenced by av_opt_copy(), av_opt_free(), av_opt_get(), av_opt_get_array(), av_opt_get_array_size(), av_opt_get_chlayout(), av_opt_get_dict_val(), av_opt_get_image_size(), av_opt_is_set_to_default(), av_opt_set_defaults2(), bsf_opt_parse(), ff_filter_opt_parse(), get_format(), get_number(), and opt_set_init().

◆  type

enum AVOptionType AVOption::type

Definition at line 444 of file opt.h.

Referenced by av_opt_copy(), av_opt_find2(), av_opt_free(), av_opt_get(), av_opt_get_array(), av_opt_get_array_size(), av_opt_get_chlayout(), av_opt_get_dict_val(), av_opt_get_image_size(), av_opt_is_set_to_default(), av_opt_query_ranges_default(), av_opt_set(), av_opt_set_array(), av_opt_set_defaults2(), bsf_opt_parse(), ff_filter_opt_parse(), ff_parse_opts_from_query_string(), filter_opt_apply(), get_format(), get_number(), get_opt_const_name(), get_opt_flags_string(), log_default(), log_type(), main(), opt_array_pelem(), opt_array_sep(), opt_copy_array(), opt_free_array(), opt_get_elem(), opt_list(), opt_serialize(), opt_set_array(), opt_set_elem(), opt_set_init(), option_is_disposition(), print_option(), read_number(), set_string_number(), show_opts(), and write_number().

◆  i64

int64_t AVOption::i64

Definition at line 451 of file opt.h.

Referenced by av_opt_is_set_to_default(), av_opt_set_defaults2(), get_opt_const_name(), get_opt_flags_string(), log_default(), log_type(), opt_get_elem(), and read_number().

◆  dbl

double AVOption::dbl

Definition at line 452 of file opt.h.

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

◆  str

const char* AVOption::str

Definition at line 453 of file opt.h.

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

◆  q

AVRational AVOption::q

Definition at line 455 of file opt.h.

◆  arr

const AVOptionArrayDef* AVOption::arr

Used for AV_OPT_TYPE_FLAG_ARRAY options.

May be NULL.

Foreign access to some members allowed, as noted in AVOptionArrayDef documentation.

Definition at line 463 of file opt.h.

Referenced by av_opt_is_set_to_default(), av_opt_set_array(), av_opt_set_defaults2(), log_default(), opt_array_sep(), and opt_set_array().

◆  [union]

union { ... } AVOption::default_val

Native access only, except when documented otherwise.

the default value for scalar options

Referenced by av_opt_is_set_to_default(), av_opt_set_array(), av_opt_set_defaults2(), get_opt_const_name(), get_opt_flags_string(), log_default(), log_type(), opt_array_sep(), opt_get_elem(), opt_set_array(), and read_number().

◆  min

double AVOption::min

minimum valid value for the option

Definition at line 465 of file opt.h.

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

◆  max

double AVOption::max

maximum valid value for the option

Definition at line 466 of file opt.h.

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

◆  flags

int AVOption::flags

A combination of AV_OPT_FLAG_*.

Definition at line 471 of file opt.h.

Referenced by av_opt_find2(), av_opt_get(), av_opt_set_defaults2(), opt_find(), opt_list(), opt_serialize(), opt_set_init(), print_option(), print_private_data(), and set_string_number().

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

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


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

Generated on Sun Sep 6 2026 19:21:25 for FFmpeg by doxygen 1.13.2

AltStyle によって変換されたページ (->オリジナル) /