Collaboration diagram for Variables:

Modules
	Variable types
	These are the different types a vlc variable can have.

	Additive flags
	These flags are added to the type field of the variable. Most as a result of a var_Change() call, but some may be added at creation time.

	Variable actions
	These are the different actions that can be used with var_Change(). The parameters given are the meaning of the two last parameters of var_Change() when this action is being used.

	Variable actions
	These are the different actions that can be used with var_GetAndSet()

Files
file	vlc_variables.h

Macros
#define	VLC_VAR_TYPE 0x00ff

#define	VLC_VAR_CLASS 0x00f0

#define	VLC_VAR_FLAGS 0xff00

#define	var_Create(a, b, c) var_Create( VLC_OBJECT(a), b, c )

#define	var_Destroy(a, b) var_Destroy( VLC_OBJECT(a), b )

#define	var_Change(a, b, c, d, e) var_Change( VLC_OBJECT(a), b, c, d, e )

#define	var_Type(a, b) var_Type( VLC_OBJECT(a), b )

#define	var_Set(a, b, c) var_Set( VLC_OBJECT(a), b, c )

#define	var_Get(a, b, c) var_Get( VLC_OBJECT(a), b, c )

#define	var_SetChecked(o, n, t, v) var_SetChecked(VLC_OBJECT(o),n,t,v)

#define	var_GetChecked(o, n, t, v) var_GetChecked(VLC_OBJECT(o),n,t,v)

#define	var_AddCallback(a, b, c, d) var_AddCallback( VLC_OBJECT(a), b, c, d )

#define	var_DelCallback(a, b, c, d) var_DelCallback( VLC_OBJECT(a), b, c, d )

#define	var_TriggerCallback(a, b) var_TriggerCallback( VLC_OBJECT(a), b )

#define	var_AddListCallback(a, b, c, d) var_AddListCallback( VLC_OBJECT(a), b, c, d )

#define	var_DelListCallback(a, b, c, d) var_DelListCallback( VLC_OBJECT(a), b, c, d )

#define	var_SetCoords(o, n, x, y) var_SetCoords(VLC_OBJECT(o),n,x,y)

#define	var_SetInteger(a, b, c) var_SetInteger( VLC_OBJECT(a),b,c)

#define	var_SetBool(a, b, c) var_SetBool( VLC_OBJECT(a),b,c)

#define	var_SetFloat(a, b, c) var_SetFloat( VLC_OBJECT(a),b,c)

#define	var_SetString(a, b, c) var_SetString( VLC_OBJECT(a),b,c)

#define	var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)

#define	var_GetCoords(o, n, x, y) var_GetCoords(VLC_OBJECT(o),n,x,y)

#define	var_IncInteger(a, b) var_IncInteger( VLC_OBJECT(a), b )

#define	var_DecInteger(a, b) var_DecInteger( VLC_OBJECT(a), b )

#define	var_OrInteger(a, b, c) var_OrInteger(VLC_OBJECT(a),b,c)

#define	var_NAndInteger(a, b, c) var_NAndInteger(VLC_OBJECT(a),b,c)

#define	var_CreateGetInteger(a, b) var_CreateGetInteger( VLC_OBJECT(a),b)

#define	var_CreateGetBool(a, b) var_CreateGetBool( VLC_OBJECT(a),b)

#define	var_CreateGetFloat(a, b) var_CreateGetFloat( VLC_OBJECT(a),b)

#define	var_CreateGetString(a, b) var_CreateGetString( VLC_OBJECT(a),b)

#define	var_CreateGetNonEmptyString(a, b) var_CreateGetNonEmptyString( VLC_OBJECT(a),b)

#define	var_CreateGetAddress(a, b) var_CreateGetAddress( VLC_OBJECT(a),b)

#define	var_CreateGetIntegerCommand(a, b) var_CreateGetIntegerCommand( VLC_OBJECT(a),b)

#define	var_CreateGetBoolCommand(a, b) var_CreateGetBoolCommand( VLC_OBJECT(a),b)

#define	var_CreateGetFloatCommand(a, b) var_CreateGetFloatCommand( VLC_OBJECT(a),b)

#define	var_CreateGetStringCommand(a, b) var_CreateGetStringCommand( VLC_OBJECT(a),b)

#define	var_CreateGetNonEmptyStringCommand(a, b) var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)

#define	var_CountChoices(a, b) var_CountChoices( VLC_OBJECT(a),b)

#define	var_ToggleBool(a, b) var_ToggleBool( VLC_OBJECT(a),b )

#define	var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)

#define	var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)

#define	var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)

#define	var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)

#define	var_InheritAddress(o, n) var_InheritAddress(VLC_OBJECT(o), n)

#define	var_InheritURational(a, b, c, d) var_InheritURational(VLC_OBJECT(a), b, c, d)

#define	var_GetInteger(a, b) var_GetInteger( VLC_OBJECT(a),b)

#define	var_GetBool(a, b) var_GetBool( VLC_OBJECT(a),b)

#define	var_GetFloat(a, b) var_GetFloat( VLC_OBJECT(a),b)

#define	var_GetString(a, b) var_GetString( VLC_OBJECT(a),b)

#define	var_GetNonEmptyString(a, b) var_GetNonEmptyString( VLC_OBJECT(a),b)

#define	var_GetAddress(a, b) var_GetAddress( VLC_OBJECT(a),b)

#define	var_LocationParse(o, m, p) var_LocationParse(VLC_OBJECT(o), m, p)

Functions
int	var_Create (vlc_object_t , const char , int)
	Initialize a vlc variable. More...

void	var_Destroy (_Generic((vlc_object_t ) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t ) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t )), const char )

int	var_Change (vlc_object_t , const char , int, vlc_value_t , vlc_value_t )
	Perform an action on a variable. More...

int	var_Type (vlc_object_t , const char )
	Request a variable's type. More...

int	var_Set (vlc_object_t , const char , vlc_value_t)
	Set a variable's value. More...

int	var_Get (vlc_object_t , const char , vlc_value_t *)
	Get a variable's value. More...

int	var_SetChecked (vlc_object_t , const char , int, vlc_value_t)

int	var_GetChecked (vlc_object_t , const char , int, vlc_value_t *)

int	var_GetAndSet (vlc_object_t , const char , int, vlc_value_t *)
	Perform a Get and Set on a variable. More...

int	var_Inherit (vlc_object_t , const char , int, vlc_value_t *)
	Finds the value of a variable. More...

void	var_FreeList (vlc_value_t , vlc_value_t )
	Free a list and the associated strings. More...

void	var_AddCallback (vlc_object_t , const char , vlc_callback_t, void *)
	Register a callback in a variable. More...

void	var_DelCallback (vlc_object_t , const char , vlc_callback_t, void *)
	Remove a callback from a variable. More...

void	var_TriggerCallback (vlc_object_t , const char )
	Trigger callback on a variable. More...

void	var_AddListCallback (vlc_object_t , const char , vlc_list_callback_t, void *)
	Register a callback for a list variable. More...

void	var_DelListCallback (vlc_object_t , const char , vlc_list_callback_t, void *)
	Remove a callback from a list variable. More...

static int	var_SetInteger (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name, int64_t i)
	Set the value of an integer variable. More...

static int	var_SetBool (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name, bool b)
	Set the value of an boolean variable. More...

static int	var_SetCoords (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name, int32_t x, int32_t y)

static int	var_SetFloat (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name, float f)
	Set the value of a float variable. More...

static int	var_SetString (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name, const char *psz_string)
	Set the value of a string variable. More...

static int	var_SetAddress (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name, void *ptr)
	Set the value of a pointer variable. More...

static int64_t	var_GetInteger (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Get an integer value. More...

static bool	var_GetBool (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Get a boolean value. More...

static void	var_GetCoords (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name, int32_t px, int32_t py)

static float	var_GetFloat (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Get a float value. More...

static char *	var_GetString (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Get a string value. More...

static char *	var_GetNonEmptyString (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)

static void *	var_GetAddress (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)

static int64_t	var_IncInteger (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Increment an integer variable. More...

static int64_t	var_DecInteger (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Decrement an integer variable. More...

static uint64_t	var_OrInteger (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name, unsigned v)

static uint64_t	var_NAndInteger (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name, unsigned v)

static int64_t	var_CreateGetInteger (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a integer variable with inherit and get its value. More...

static bool	var_CreateGetBool (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a boolean variable with inherit and get its value. More...

static float	var_CreateGetFloat (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a float variable with inherit and get its value. More...

static char *	var_CreateGetString (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a string variable with inherit and get its value. More...

static char *	var_CreateGetNonEmptyString (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)

static void *	var_CreateGetAddress (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create an address variable with inherit and get its value. More...

static int64_t	var_CreateGetIntegerCommand (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a integer command variable with inherit and get its value. More...

static bool	var_CreateGetBoolCommand (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a boolean command variable with inherit and get its value. More...

static float	var_CreateGetFloatCommand (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a float command variable with inherit and get its value. More...

static char *	var_CreateGetStringCommand (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)
	Create a string command variable with inherit and get its value. More...

static char *	var_CreateGetNonEmptyStringCommand (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)

static int	var_CountChoices (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)

static bool	var_ToggleBool (_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t p_obj)), const char psz_name)

static bool	var_InheritBool (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name)

static int64_t	var_InheritInteger (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name)

static float	var_InheritFloat (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name)

static char *	var_InheritString (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name)

static void *	var_InheritAddress (_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t obj)), const char name)

int	var_InheritURational (_Generic((vlc_object_t ) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t ) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t )), unsigned num, unsigned den, const char var)

int	var_LocationParse (vlc_object_t , const char mrl, const char *prefix)
	Parses a set of colon-separated or semicolon-separated `name=value` pairs. More...

Detailed Description

VLC object variables and callbacks

Macro Definition Documentation

◆ var_AddCallback

#define var_AddCallback	(	a,
		b,
		c,
		d
	)	var_AddCallback( VLC_OBJECT(a), b, c, d )

◆ var_AddListCallback

#define var_AddListCallback	(	a,
		b,
		c,
		d
	)	var_AddListCallback( VLC_OBJECT(a), b, c, d )

◆ var_Change

#define var_Change	(	a,
		b,
		c,
		d,
		e
	)	var_Change( VLC_OBJECT(a), b, c, d, e )

◆ var_CountChoices

#define var_CountChoices	(	a,
		b
	)	var_CountChoices( VLC_OBJECT(a),b)

◆ var_Create

#define var_Create	(	a,
		b,
		c
	)	var_Create( VLC_OBJECT(a), b, c )

◆ var_CreateGetAddress

#define var_CreateGetAddress	(	a,
		b
	)	var_CreateGetAddress( VLC_OBJECT(a),b)

◆ var_CreateGetBool

#define var_CreateGetBool	(	a,
		b
	)	var_CreateGetBool( VLC_OBJECT(a),b)

◆ var_CreateGetBoolCommand

#define var_CreateGetBoolCommand	(	a,
		b
	)	var_CreateGetBoolCommand( VLC_OBJECT(a),b)

◆ var_CreateGetFloat

#define var_CreateGetFloat	(	a,
		b
	)	var_CreateGetFloat( VLC_OBJECT(a),b)

◆ var_CreateGetFloatCommand

#define var_CreateGetFloatCommand	(	a,
		b
	)	var_CreateGetFloatCommand( VLC_OBJECT(a),b)

◆ var_CreateGetInteger

#define var_CreateGetInteger	(	a,
		b
	)	var_CreateGetInteger( VLC_OBJECT(a),b)

◆ var_CreateGetIntegerCommand

#define var_CreateGetIntegerCommand	(	a,
		b
	)	var_CreateGetIntegerCommand( VLC_OBJECT(a),b)

◆ var_CreateGetNonEmptyString

#define var_CreateGetNonEmptyString	(	a,
		b
	)	var_CreateGetNonEmptyString( VLC_OBJECT(a),b)

◆ var_CreateGetNonEmptyStringCommand

#define var_CreateGetNonEmptyStringCommand	(	a,
		b
	)	var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)

◆ var_CreateGetString

#define var_CreateGetString	(	a,
		b
	)	var_CreateGetString( VLC_OBJECT(a),b)

◆ var_CreateGetStringCommand

#define var_CreateGetStringCommand	(	a,
		b
	)	var_CreateGetStringCommand( VLC_OBJECT(a),b)

◆ var_DecInteger

#define var_DecInteger	(	a,
		b
	)	var_DecInteger( VLC_OBJECT(a), b )

◆ var_DelCallback

#define var_DelCallback	(	a,
		b,
		c,
		d
	)	var_DelCallback( VLC_OBJECT(a), b, c, d )

◆ var_DelListCallback

#define var_DelListCallback	(	a,
		b,
		c,
		d
	)	var_DelListCallback( VLC_OBJECT(a), b, c, d )

◆ var_Destroy

#define var_Destroy	(	a,
		b
	)	var_Destroy( VLC_OBJECT(a), b )

◆ var_Get

#define var_Get	(	a,
		b,
		c
	)	var_Get( VLC_OBJECT(a), b, c )

◆ var_GetAddress

#define var_GetAddress	(	a,
		b
	)	var_GetAddress( VLC_OBJECT(a),b)

◆ var_GetBool

#define var_GetBool	(	a,
		b
	)	var_GetBool( VLC_OBJECT(a),b)

◆ var_GetChecked

#define var_GetChecked	(	o,
		n,
		t,
		v
	)	var_GetChecked(VLC_OBJECT(o),n,t,v)

◆ var_GetCoords

#define var_GetCoords	(	o,
		n,
		x,
		y
	)	var_GetCoords(VLC_OBJECT(o),n,x,y)

◆ var_GetFloat

#define var_GetFloat	(	a,
		b
	)	var_GetFloat( VLC_OBJECT(a),b)

◆ var_GetInteger

#define var_GetInteger	(	a,
		b
	)	var_GetInteger( VLC_OBJECT(a),b)

◆ var_GetNonEmptyString

#define var_GetNonEmptyString	(	a,
		b
	)	var_GetNonEmptyString( VLC_OBJECT(a),b)

◆ var_GetString

#define var_GetString	(	a,
		b
	)	var_GetString( VLC_OBJECT(a),b)

◆ var_IncInteger

#define var_IncInteger	(	a,
		b
	)	var_IncInteger( VLC_OBJECT(a), b )

◆ var_InheritAddress

#define var_InheritAddress	(	o,
		n
	)	var_InheritAddress(VLC_OBJECT(o), n)

◆ var_InheritBool

#define var_InheritBool	(	o,
		n
	)	var_InheritBool(VLC_OBJECT(o), n)

◆ var_InheritFloat

#define var_InheritFloat	(	o,
		n
	)	var_InheritFloat(VLC_OBJECT(o), n)

◆ var_InheritInteger

#define var_InheritInteger	(	o,
		n
	)	var_InheritInteger(VLC_OBJECT(o), n)

◆ var_InheritString

#define var_InheritString	(	o,
		n
	)	var_InheritString(VLC_OBJECT(o), n)

◆ var_InheritURational

#define var_InheritURational	(	a,
		b,
		c,
		d
	)	var_InheritURational(VLC_OBJECT(a), b, c, d)

◆ var_LocationParse

#define var_LocationParse	(	o,
		m,
		p
	)	var_LocationParse(VLC_OBJECT(o), m, p)

◆ var_NAndInteger

#define var_NAndInteger	(	a,
		b,
		c
	)	var_NAndInteger(VLC_OBJECT(a),b,c)

◆ var_OrInteger

#define var_OrInteger	(	a,
		b,
		c
	)	var_OrInteger(VLC_OBJECT(a),b,c)

◆ var_Set

#define var_Set	(	a,
		b,
		c
	)	var_Set( VLC_OBJECT(a), b, c )

◆ var_SetAddress

#define var_SetAddress	(	o,
		n,
		p
	)	var_SetAddress(VLC_OBJECT(o), n, p)

◆ var_SetBool

#define var_SetBool	(	a,
		b,
		c
	)	var_SetBool( VLC_OBJECT(a),b,c)

◆ var_SetChecked

#define var_SetChecked	(	o,
		n,
		t,
		v
	)	var_SetChecked(VLC_OBJECT(o),n,t,v)

◆ var_SetCoords

#define var_SetCoords	(	o,
		n,
		x,
		y
	)	var_SetCoords(VLC_OBJECT(o),n,x,y)

◆ var_SetFloat

#define var_SetFloat	(	a,
		b,
		c
	)	var_SetFloat( VLC_OBJECT(a),b,c)

◆ var_SetInteger

#define var_SetInteger	(	a,
		b,
		c
	)	var_SetInteger( VLC_OBJECT(a),b,c)

◆ var_SetString

#define var_SetString	(	a,
		b,
		c
	)	var_SetString( VLC_OBJECT(a),b,c)

◆ var_ToggleBool

#define var_ToggleBool	(	a,
		b
	)	var_ToggleBool( VLC_OBJECT(a),b )

◆ var_TriggerCallback

#define var_TriggerCallback	(	a,
		b
	)	var_TriggerCallback( VLC_OBJECT(a), b )

◆ var_Type

#define var_Type	(	a,
		b
	)	var_Type( VLC_OBJECT(a), b )

◆ VLC_VAR_CLASS

#define VLC_VAR_CLASS 0x00f0

◆ VLC_VAR_FLAGS

#define VLC_VAR_FLAGS 0xff00

◆ VLC_VAR_TYPE

#define VLC_VAR_TYPE 0x00ff

Function Documentation

◆ var_AddCallback()

void var_AddCallback	(	vlc_object_t *	p_this,
		const char *	psz_name,
		vlc_callback_t	pf_callback,
		void *	p_data
	)

Register a callback in a variable.

We store a function pointer that will be called upon variable modification.

Parameters

p_this	The object that holds the variable
psz_name	The name of the variable
pf_callback	The function pointer
p_data	A generic pointer that will be passed as the last argument to the callback function.

Warning: The callback function is run in the thread that calls var_Set on the variable. Use proper locking. This thread may not have much time to spare, so keep callback functions short.

References AddCallback(), psz_name, and vlc_value_callback.

◆ var_AddListCallback()

void var_AddListCallback	(	vlc_object_t *	p_this,
		const char *	psz_name,
		vlc_list_callback_t	pf_callback,
		void *	p_data
	)

Register a callback for a list variable.

The callback is triggered when an element is added/removed from the list or when the list is cleared.

See var_AddCallback().

References AddCallback(), psz_name, and vlc_list_callback.

◆ var_Change()

int var_Change	(	vlc_object_t *	p_this,
		const char *	psz_name,
		int	i_action,
		vlc_value_t *	p_val,
		vlc_value_t *	p_val2
	)

Perform an action on a variable.

Parameters

p_this	The object that holds the variable
psz_name	The name of the variable
i_action	The action to perform. Must be one of Variable actions
p_val	First action parameter
p_val2	Second action parameter

< No error

< Variable not found

< Unspecified error

< No error

< Unspecified error

References CheckValue(), variable_t::choices, variable_t::choices_text, vlc_value_t::f_float, FreeDummy(), vlc_list_t::i_count, vlc_value_t::i_int, variable_t::i_type, vlc_list_t::i_type, Lookup(), variable_t::max, variable_t::min, variable_t::ops, vlc_value_t::p_list, vlc_list_t::p_values, variable_ops_t::pf_cmp, variable_ops_t::pf_dup, variable_ops_t::pf_free, psz_name, vlc_value_t::psz_string, variable_t::psz_text, variable_t::step, strdup(), TAB_APPEND, TAB_ERASE, TriggerListCallback(), variable_t::val, vlc_object_internals::var_lock, VLC_EGENERIC, VLC_ENOVAR, vlc_internals, vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_ADDCHOICE, VLC_VAR_CHOICESCOUNT, VLC_VAR_CLEARCHOICES, VLC_VAR_DELCHOICE, VLC_VAR_FLOAT, VLC_VAR_GETCHOICES, VLC_VAR_GETMAX, VLC_VAR_GETMIN, VLC_VAR_GETSTEP, VLC_VAR_GETTEXT, VLC_VAR_INTEGER, VLC_VAR_SETMINMAX, VLC_VAR_SETSTEP, VLC_VAR_SETTEXT, VLC_VAR_SETVALUE, VLC_VAR_STRING, VLC_VAR_TYPE, and xmalloc().

◆ var_CountChoices()

static int var_CountChoices	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

References count.

◆ var_Create()

int var_Create	(	vlc_object_t *	p_this,
		const char *	psz_name,
		int	i_type
	)

Initialize a vlc variable.

We hash the given string and insert it into the sorted list. The insertion may require slow memory copies, but think about what we gain in the log(n) lookup phase when setting/getting the variable value!

Parameters

p_this	The object in which to create the variable
psz_name	The name of the variable
i_type	The variables type. Must be one of Variable types combined with zero or more Additive flags

< Not enough memory

< No error

< Not enough memory

References addr_ops, vlc_value_t::b_bool, variable_t::b_incallback, bool_ops, variable_t::choices, variable_t::choices_text, vlc_value_t::coords, coords_ops, Destroy(), vlc_value_t::f_float, float_ops, vlc_list_t::i_count, vlc_value_t::i_int, variable_t::i_type, i_type, variable_t::i_usage, int_ops, variable_t::max, variable_t::min, variable_t::ops, vlc_value_t::p_address, vlc_list_t::p_values, variable_t::psz_name, psz_name, vlc_value_t::psz_string, variable_t::psz_text, strdup(), string_ops, tsearch(), unlikely, variable_t::val, variable_t::value_callbacks, var_Inherit(), vlc_object_internals::var_lock, vlc_object_internals::var_root, varcmp(), vlc_assert_unreachable, VLC_ENOMEM, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_ADDRESS, VLC_VAR_BOOL, VLC_VAR_CLASS, VLC_VAR_COORDS, VLC_VAR_DOINHERIT, VLC_VAR_FLOAT, VLC_VAR_INTEGER, VLC_VAR_ISCOMMAND, VLC_VAR_STRING, VLC_VAR_VOID, void_ops, vlc_value_t::x, and vlc_value_t::y.

Referenced by var_OptionParse().

◆ var_CreateGetAddress()

static void* var_CreateGetAddress	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create an address variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

◆ var_CreateGetBool()

static bool var_CreateGetBool	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a boolean variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetBool, VLC_VAR_BOOL, and VLC_VAR_DOINHERIT.

◆ var_CreateGetBoolCommand()

static bool var_CreateGetBoolCommand	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a boolean command variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetBool, VLC_VAR_BOOL, VLC_VAR_DOINHERIT, and VLC_VAR_ISCOMMAND.

◆ var_CreateGetFloat()

static float var_CreateGetFloat	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a float variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetFloat, VLC_VAR_DOINHERIT, and VLC_VAR_FLOAT.

◆ var_CreateGetFloatCommand()

static float var_CreateGetFloatCommand	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a float command variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetFloat, VLC_VAR_DOINHERIT, VLC_VAR_FLOAT, and VLC_VAR_ISCOMMAND.

◆ var_CreateGetInteger()

static int64_t var_CreateGetInteger	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a integer variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetInteger, VLC_VAR_DOINHERIT, and VLC_VAR_INTEGER.

◆ var_CreateGetIntegerCommand()

static int64_t var_CreateGetIntegerCommand	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a integer command variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetInteger, VLC_VAR_DOINHERIT, VLC_VAR_INTEGER, and VLC_VAR_ISCOMMAND.

◆ var_CreateGetNonEmptyString()

static char* var_CreateGetNonEmptyString	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

◆ var_CreateGetNonEmptyStringCommand()

static char* var_CreateGetNonEmptyStringCommand	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

◆ var_CreateGetString()

static char* var_CreateGetString	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a string variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetString, VLC_VAR_DOINHERIT, and VLC_VAR_STRING.

◆ var_CreateGetStringCommand()

static char* var_CreateGetStringCommand	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Create a string command variable with inherit and get its value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, var_Create, var_GetString, VLC_VAR_DOINHERIT, VLC_VAR_ISCOMMAND, and VLC_VAR_STRING.

◆ var_DecInteger()

static int64_t var_DecInteger	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Decrement an integer variable.

Parameters

p_obj	the object that holds the variable
psz_name	the name of the variable

References vlc_value_t::i_int.

◆ var_DelCallback()

void var_DelCallback	(	vlc_object_t *	p_this,
		const char *	psz_name,
		vlc_callback_t	pf_callback,
		void *	p_data
	)

Remove a callback from a variable.

pf_callback and p_data have to be given again, because different objects might have registered the same callback function.

References DelCallback(), psz_name, and vlc_value_callback.

◆ var_DelListCallback()

void var_DelListCallback	(	vlc_object_t *	p_this,
		const char *	psz_name,
		vlc_list_callback_t	pf_callback,
		void *	p_data
	)

Remove a callback from a list variable.

See var_DelCallback().

References DelCallback(), psz_name, and vlc_list_callback.

◆ var_Destroy()

void var_Destroy	(	_Generic((vlc_object_t ) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t ) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *))	,
		const char *
	)

◆ var_FreeList()

void var_FreeList	(	vlc_value_t *	p_val,
		vlc_value_t *	p_val2
	)

Free a list and the associated strings.

Parameters

p_val	the list variable
p_val2	the variable associated or NULL

References vlc_list_t::i_count, vlc_list_t::i_type, vlc_value_t::p_list, vlc_list_t::p_values, vlc_value_t::psz_string, VLC_VAR_CLASS, and VLC_VAR_STRING.

◆ var_Get()

int var_Get	(	vlc_object_t *	p_this,
		const char *	psz_name,
		vlc_value_t *	p_val
	)

Get a variable's value.

Parameters

p_this	The object that holds the variable
psz_name	The name of the variable
p_val	Pointer to a vlc_value_t that will hold the variable's value after the function is finished

References psz_name, and var_GetChecked().

◆ var_GetAddress()

static void* var_GetAddress	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

◆ var_GetAndSet()

int var_GetAndSet	(	vlc_object_t *	p_this,
		const char *	psz_name,
		int	i_action,
		vlc_value_t *	p_val
	)

Perform a Get and Set on a variable.

Parameters

p_this	The object that hold the variable
psz_name	the name of the variable
i_action	the action to perform
p_val	The action parameter

Returns: vlc error codes

< Variable not found

< Unspecified error

< No error

References vlc_value_t::b_bool, CheckValue(), vlc_value_t::i_int, variable_t::i_type, Lookup(), psz_name, TriggerCallback(), variable_t::val, vlc_object_internals::var_lock, VLC_EGENERIC, VLC_ENOVAR, vlc_internals, vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_BOOL, VLC_VAR_BOOL_TOGGLE, VLC_VAR_INTEGER, VLC_VAR_INTEGER_ADD, VLC_VAR_INTEGER_NAND, VLC_VAR_INTEGER_OR, and WaitUnused().

◆ var_GetBool()

static bool var_GetBool	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Get a boolean value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References vlc_value_t::b_bool, psz_name, var_GetChecked, and VLC_VAR_BOOL.

◆ var_GetChecked()

int var_GetChecked	(	vlc_object_t *	,
		const char *	,
		int	,
		vlc_value_t *
	)

< No error

< Variable not found

References variable_t::i_type, Lookup(), variable_t::ops, variable_ops_t::pf_dup, psz_name, variable_t::val, vlc_object_internals::var_lock, VLC_ENOVAR, vlc_internals, vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_CLASS, and VLC_VAR_VOID.

Referenced by var_Get(), and var_Inherit().

◆ var_GetCoords()

static void var_GetCoords	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name,
		int32_t *	px,
		int32_t *	py
	)

inlinestatic

◆ var_GetFloat()

static float var_GetFloat	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Get a float value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References vlc_value_t::f_float, psz_name, var_GetChecked, and VLC_VAR_FLOAT.

◆ var_GetInteger()

static int64_t var_GetInteger	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Get an integer value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References vlc_value_t::i_int, psz_name, var_GetChecked, and VLC_VAR_INTEGER.

◆ var_GetNonEmptyString()

static char* var_GetNonEmptyString	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

◆ var_GetString()

static char* var_GetString	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Get a string value.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable

References psz_name, vlc_value_t::psz_string, var_GetChecked, and VLC_VAR_STRING.

◆ var_IncInteger()

static int64_t var_IncInteger	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

Increment an integer variable.

Parameters

p_obj	the object that holds the variable
psz_name	the name of the variable

References vlc_value_t::i_int.

◆ var_Inherit()

int var_Inherit	(	vlc_object_t *	p_this,
		const char *	psz_name,
		int	i_type,
		vlc_value_t *	p_val
	)

Finds the value of a variable.

If the specified object does not hold a variable with the specified name, try the parent object, and iterate until the top of the tree. If no match is found, the value is read from the configuration.

< No error

< Object not found

< No error

References vlc_value_t::b_bool, config_GetFloat, config_GetInt, config_GetPsz, vlc_value_t::f_float, vlc_value_t::i_int, i_type, vlc_object_t::obj, vlc_common_members::parent, psz_name, vlc_value_t::psz_string, strdup(), var_GetChecked(), vlc_assert_unreachable, VLC_ENOOBJ, VLC_SUCCESS, VLC_VAR_ADDRESS, VLC_VAR_BOOL, VLC_VAR_CLASS, VLC_VAR_FLOAT, VLC_VAR_INTEGER, and VLC_VAR_STRING.

Referenced by var_Create().

◆ var_InheritAddress()

static void* var_InheritAddress	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name
	)

inlinestatic

◆ var_InheritBool()

static bool var_InheritBool	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name
	)

inlinestatic

◆ var_InheritFloat()

static float var_InheritFloat	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name
	)

inlinestatic

◆ var_InheritInteger()

static int64_t var_InheritInteger	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name
	)

inlinestatic

◆ var_InheritString()

static char* var_InheritString	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name
	)

inlinestatic

◆ var_InheritURational()

int var_InheritURational	(	_Generic((vlc_object_t ) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t ) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *))	,
		unsigned *	num,
		unsigned *	den,
		const char *	var
	)

◆ var_LocationParse()

int var_LocationParse	(	vlc_object_t *	obj,
		const char *	mrl,
		const char *	pref
	)

Parses a set of colon-separated or semicolon-separated name=value pairs.

Some access (or access_demux) plugins uses this scheme in media resource location.

Note: Only trusted/safe variables are allowed. This is intended.

Warning: Only use this for plugins implementing VLC-specific resource location schemes. This would not make any sense for standardized ones.

Parameters

obj	VLC object on which to set variables (and emit error messages)
mrl	string to parse
pref	prefix to prepend to option names in the string

Returns: VLC_ENOMEM on error, VLC_SUCCESS on success.

< No error

< Not enough memory

References likely, var_OptionParse(), VLC_ENOMEM, and VLC_SUCCESS.

◆ var_NAndInteger()

static uint64_t var_NAndInteger	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name,
		unsigned	v
	)

inlinestatic

◆ var_OrInteger()

static uint64_t var_OrInteger	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name,
		unsigned	v
	)

inlinestatic

◆ var_Set()

int var_Set	(	vlc_object_t *	p_this,
		const char *	psz_name,
		vlc_value_t	val
	)

Set a variable's value.

Parameters

p_this	The object that hold the variable
psz_name	The name of the variable
val	the value to set

References psz_name, and var_SetChecked().

Referenced by var_OptionParse().

◆ var_SetAddress()

static int var_SetAddress	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name,
		void *	ptr
	)

inlinestatic

Set the value of a pointer variable.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable
ptr	The new pointer value of this variable

◆ var_SetBool()

static int var_SetBool	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name,
		bool	b
	)

inlinestatic

Set the value of an boolean variable.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable
b	The new boolean value of this variable

References vlc_value_t::b_bool.

◆ var_SetChecked()

int var_SetChecked	(	vlc_object_t *	,
		const char *	,
		int	,
		vlc_value_t
	)

< Variable not found

< No error

References CheckValue(), variable_t::i_type, Lookup(), variable_t::ops, variable_ops_t::pf_dup, variable_ops_t::pf_free, psz_name, TriggerCallback(), variable_t::val, vlc_object_internals::var_lock, VLC_ENOVAR, vlc_internals, vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_CLASS, VLC_VAR_VOID, and WaitUnused().

Referenced by var_Set().

◆ var_SetCoords()

static int var_SetCoords	(	_Generic((vlc_object_t obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *obj))	,
		const char *	name,
		int32_t	x,
		int32_t	y
	)

inlinestatic

◆ var_SetFloat()

static int var_SetFloat	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name,
		float	f
	)

inlinestatic

Set the value of a float variable.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable
f	The new float value of this variable

References vlc_value_t::f_float, psz_name, var_SetChecked, and VLC_VAR_FLOAT.

◆ var_SetInteger()

static int var_SetInteger	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name,
		int64_t	i
	)

inlinestatic

Set the value of an integer variable.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable
i	The new integer value of this variable

References vlc_value_t::i_int, psz_name, var_SetChecked, and VLC_VAR_INTEGER.

◆ var_SetString()

static int var_SetString	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name,
		const char *	psz_string
	)

inlinestatic

Set the value of a string variable.

Parameters

p_obj	The object that holds the variable
psz_name	The name of the variable
psz_string	The new string value of this variable

References psz_name, vlc_value_t::psz_string, var_SetChecked, and VLC_VAR_STRING.

◆ var_ToggleBool()

static bool var_ToggleBool	(	_Generic((vlc_object_t p_obj) ->obj, vlc_object_t:(vlc_object_t )(&(vlc_object_t p_obj) ->obj), struct vlc_common_members:(vlc_object_t )(vlc_object_t *p_obj))	,
		const char *	psz_name
	)

inlinestatic

◆ var_TriggerCallback()

void var_TriggerCallback	(	vlc_object_t *	p_this,
		const char *	psz_name
	)

Trigger callback on a variable.

Parameters

p_this	The object that hold the variable
psz_name	The name of the variable

References Lookup(), psz_name, TriggerCallback(), variable_t::val, vlc_object_internals::var_lock, vlc_internals, vlc_mutex_unlock(), and WaitUnused().

◆ var_Type()

int var_Type	(	vlc_object_t *	p_this,
		const char *	psz_name
	)

Request a variable's type.

Returns: The variable type if it exists, or 0 if the variable could not be found.

See also: Variable types

References variable_t::choices, vlc_list_t::i_count, variable_t::i_type, i_type, Lookup(), psz_name, vlc_object_internals::var_lock, vlc_internals, vlc_mutex_unlock(), and VLC_VAR_HASCHOICE.

Modules

Files

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ var_AddCallback

◆ var_AddListCallback

◆ var_Change

◆ var_CountChoices

◆ var_Create

◆ var_CreateGetAddress

◆ var_CreateGetBool

◆ var_CreateGetBoolCommand

◆ var_CreateGetFloat

◆ var_CreateGetFloatCommand

◆ var_CreateGetInteger

◆ var_CreateGetIntegerCommand

◆ var_CreateGetNonEmptyString

◆ var_CreateGetNonEmptyStringCommand

◆ var_CreateGetString

◆ var_CreateGetStringCommand

◆ var_DecInteger

◆ var_DelCallback

◆ var_DelListCallback

◆ var_Destroy

◆ var_Get

◆ var_GetAddress

◆ var_GetBool

◆ var_GetChecked

◆ var_GetCoords

◆ var_GetFloat

◆ var_GetInteger

◆ var_GetNonEmptyString

◆ var_GetString

◆ var_IncInteger

◆ var_InheritAddress

◆ var_InheritBool

◆ var_InheritFloat

◆ var_InheritInteger

◆ var_InheritString

◆ var_InheritURational

◆ var_LocationParse

◆ var_NAndInteger

◆ var_OrInteger

◆ var_Set

◆ var_SetAddress

◆ var_SetBool

◆ var_SetChecked

◆ var_SetCoords

◆ var_SetFloat

◆ var_SetInteger

◆ var_SetString

◆ var_ToggleBool

◆ var_TriggerCallback

◆ var_Type

◆ VLC_VAR_CLASS

◆ VLC_VAR_FLAGS

◆ VLC_VAR_TYPE

Function Documentation

◆ var_AddCallback()

◆ var_AddListCallback()

◆ var_Change()

◆ var_CountChoices()

◆ var_Create()

◆ var_CreateGetAddress()

◆ var_CreateGetBool()

◆ var_CreateGetBoolCommand()

◆ var_CreateGetFloat()

◆ var_CreateGetFloatCommand()

◆ var_CreateGetInteger()

◆ var_CreateGetIntegerCommand()

◆ var_CreateGetNonEmptyString()

◆ var_CreateGetNonEmptyStringCommand()

◆ var_CreateGetString()

◆ var_CreateGetStringCommand()

◆ var_DecInteger()

◆ var_DelCallback()

◆ var_DelListCallback()

◆ var_Destroy()