rte_option_info Struct Reference
[Context and Codec Options]


Data Fields

rte_option_type type
char * keyword
char * label
rte_option_value def
rte_option_value min
rte_option_value max
rte_option_value step
rte_option_value_ptr menu
char * tooltip

Detailed Description

Although export options can be accessed by a static keyword they are by definition opaque: the client can present them to the user and manipulate them without knowing about their presence or purpose. To do so, some information about the option is necessary, given in this structure.

You can obtain this information with rte_context_option_info_enum() or rte_codec_option_info_enum().


Field Documentation

rte_option_type rte_option_info::type
 

See also:
rte_option_type

char* rte_option_info::keyword
 

Unique (within the respective context or codec) keyword to identify this option. Can be stored in configuration files.

char* rte_option_info::label
 

Name of the option to be shown to the user. This can be NULL to indicate this option shall not be listed. Can be localized with dgettext("rte", label).

rte_option_value rte_option_info::def
 

See also:
rte_option_type

rte_option_value rte_option_info::min
 

See also:
rte_option_type

rte_option_value rte_option_info::max
 

See also:
rte_option_type

rte_option_value rte_option_info::step
 

See also:
rte_option_type

rte_option_value_ptr rte_option_info::menu
 

See also:
rte_option_type

char* rte_option_info::tooltip
 

A brief description (or NULL) for the user. Can be localized with dgettext("rte", tooltip).


Generated on Tue Apr 11 18:23:04 2006 for RTE Library by  doxygen 1.4.6