variable_t Struct Reference

The structure describing a variable. More...

Collaboration diagram for variable_t:

Data Fields
char *	psz_name
	The variable unique name (must be first)
vlc_value_t	val
	The variable's exported value.
char *	psz_text
	The variable display name, mainly for use by the interfaces.
const variable_ops_t *	ops
int	i_type
	The type of the variable.
unsigned	i_usage
	Reference count.
vlc_value_t	min
	If the variable has min/max/step values.
vlc_value_t	max
vlc_value_t	step
int	i_default
	Index of the default choice, if the variable is to be chosen in a list.
vlc_list_t	choices
	List of choices.
vlc_list_t	choices_text
	List of friendly names for the choices.
bool	b_incallback
	Set to TRUE if the variable is in a callback.
int	i_entries
	Number of registered callbacks.
callback_entry_t *	p_entries
	Array of registered callbacks.

Detailed Description

The structure describing a variable.

Note

vlc_value_t is the common union for variable values

Field Documentation

bool variable_t::b_incallback

Set to TRUE if the variable is in a callback.

Referenced by TriggerCallback(), var_Create(), and WaitUnused().

vlc_list_t variable_t::choices

List of choices.

Referenced by CheckValue(), Destroy(), var_Change(), and var_Create().

vlc_list_t variable_t::choices_text

List of friendly names for the choices.

Referenced by Destroy(), var_Change(), and var_Create().

int variable_t::i_default

Index of the default choice, if the variable is to be chosen in a list.

Referenced by CheckValue(), var_Change(), and var_Create().

int variable_t::i_entries

Number of registered callbacks.

Referenced by Destroy(), DumpVariable(), TriggerCallback(), var_AddCallback(), var_Create(), and var_DelCallback().

int variable_t::i_type

The type of the variable.

Referenced by CheckValue(), DumpVariable(), var_Change(), var_Create(), var_GetAndSet(), var_GetChecked(), var_SetChecked(), and var_Type().

unsigned variable_t::i_usage

Reference count.

Referenced by var_Create(), and var_Destroy().

vlc_value_t variable_t::max

Referenced by CheckValue(), and var_Change().

vlc_value_t variable_t::min

If the variable has min/max/step values.

Referenced by CheckValue(), and var_Change().

const variable_ops_t* variable_t::ops

Referenced by CheckValue(), Destroy(), var_Change(), var_Create(), var_GetChecked(), and var_SetChecked().

callback_entry_t* variable_t::p_entries

Array of registered callbacks.

Referenced by Destroy(), TriggerCallback(), var_AddCallback(), var_Create(), and var_DelCallback().

char* variable_t::psz_name

The variable unique name (must be first)

Referenced by Destroy(), DumpVariable(), var_Create(), and varcmp().

char* variable_t::psz_text

The variable display name, mainly for use by the interfaces.

Referenced by Destroy(), DumpVariable(), var_Change(), and var_Create().

vlc_value_t variable_t::step

Referenced by CheckValue(), and var_Change().

vlc_value_t variable_t::val

The variable's exported value.

Referenced by Destroy(), DumpVariable(), TriggerCallback(), var_Change(), var_Create(), var_GetAndSet(), var_GetChecked(), var_SetChecked(), and var_TriggerCallback().

---

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

• src/misc/variables.h