FFmpeg
Data Fields
AVOption Struct Reference
libavutil » Data Structures » AVOptions

AVOption. More...

#include <opt.h>

Data Fields

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

Detailed Description

AVOption.

Definition at line 346 of file opt.h.

Field Documentation

name

const char* AVOption::name

Definition at line 347 of file opt.h.

Referenced by av_disposition_from_string(), av_disposition_to_string(), av_opt_find2(), av_opt_is_set_to_default(), av_opt_serialize(), av_opt_set_defaults2(), av_opt_set_image_size(), av_opt_set_video_rate(), bsf_list_append_internal(), ff_filter_opt_parse(), get_opt_const_name(), get_opt_flags_string(), libcodec2_init_common(), main(), opt_list(), opt_set_array(), opt_set_elem(), print_option(), print_private_data(), priv_data_size_wrong(), set_string_fmt(), set_string_number(), and write_number().

help

const char* AVOption::help

short English help text

Todo:
What about other languages?

Definition at line 353 of file opt.h.

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

Referenced by av_opt_copy(), av_opt_free(), av_opt_get(), av_opt_get_chlayout(), 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_chlayout(), av_opt_set_defaults2(), av_opt_set_dict_val(), av_opt_set_image_size(), ff_filter_opt_parse(), get_format(), get_number(), set_format(), and set_number().

type

enum AVOptionType AVOption::type

Definition at line 362 of file opt.h.

Referenced by av_opt_copy(), av_opt_find2(), av_opt_free(), av_opt_get(), av_opt_get_chlayout(), av_opt_get_dict_val(), av_opt_get_image_size(), av_opt_is_set_to_default(), av_opt_ptr(), av_opt_serialize(), av_opt_set(), av_opt_set_bin(), av_opt_set_defaults2(), av_opt_set_image_size(), av_opt_set_video_rate(), ff_filter_opt_parse(), 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_elem(), opt_get_elem(), opt_list(), opt_set_array(), opt_set_elem(), option_is_disposition(), print_option(), read_number(), set_format(), set_number(), set_string_number(), show_opts(), and write_number().

i64

int64_t AVOption::i64

Definition at line 369 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 370 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 371 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 373 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 381 of file opt.h.

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

default_val

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

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

Referenced by 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 389 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(), print_private_data(), set_number(), 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 396 of file opt.h.

Referenced by av_opt_find2(), 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 Thu Sep 26 2024 23:16:28 for FFmpeg by   doxygen 1.8.17

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