Variables

Functions for using the object variables in vlc. More...

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.
	Variable actions
	These are the different actions that can be used with var_Change().

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_Command(a, b, c, d, e)   var_Command( VLC_OBJECT( a ), b, c, d, e )
#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_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_SetTime(a, b, c)   var_SetTime( 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_CreateGetTime(a, b)   var_CreateGetTime( 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_CreateGetTimeCommand(a, b)   var_CreateGetTimeCommand( 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_InheritTime(o, n)   var_InheritTime(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_GetTime(a, b)   var_GetTime( 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 *)(vlc_object_t *)), const char *, int)
int	var_Destroy (((vlc_object_t *)(vlc_object_t *)), const char *)
int	var_Change (((vlc_object_t *)(vlc_object_t *)), const char *, int, vlc_value_t *, vlc_value_t *)
int	var_Type (((vlc_object_t *)(vlc_object_t *)), const char *)
int	var_Set (((vlc_object_t *)(vlc_object_t *)), const char *, vlc_value_t)
int	var_Get (((vlc_object_t *)(vlc_object_t *)), const char *, vlc_value_t *)
int	var_SetChecked (((vlc_object_t *)(vlc_object_t *)), const char *, int, vlc_value_t)
int	var_GetChecked (((vlc_object_t *)(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.
int	var_Inherit (vlc_object_t *, const char *, int, vlc_value_t *)
	Finds the value of a variable.
int	var_Command (((vlc_object_t *)(vlc_object_t *)), const char *, const char *, const char *, char **)
void	var_FreeList (vlc_value_t *, vlc_value_t *)
	Free a list and the associated strings.
int	var_AddCallback (((vlc_object_t *)(vlc_object_t *)), const char *, vlc_callback_t, void *)
int	var_DelCallback (((vlc_object_t *)(vlc_object_t *)), const char *, vlc_callback_t, void *)
int	var_TriggerCallback (((vlc_object_t *)(vlc_object_t *)), const char *)
static int	var_SetInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, int64_t i)
	Set the value of an integer variable.
static int	var_SetBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, bool b)
	Set the value of an boolean variable.
static int	var_SetTime (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, int64_t i)
	Set the value of a time variable.
static int	var_SetCoords (((vlc_object_t *)(vlc_object_t *obj)), const char *name, int32_t x, int32_t y)
static int	var_SetFloat (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, float f)
	Set the value of a float variable.
static int	var_SetString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, const char *psz_string)
	Set the value of a string variable.
static int	var_SetAddress (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, void *ptr)
	Set the value of a pointer variable.
static int64_t	var_GetInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Get an integer value.
static bool	var_GetBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Get a boolean value.
static int64_t	var_GetTime (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Get a time value.
static void	var_GetCoords (((vlc_object_t *)(vlc_object_t *obj)), const char *name, int32_t *px, int32_t *py)
static float	var_GetFloat (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Get a float value.
static char *	var_GetString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Get a string value.
static char *	var_GetNonEmptyString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
static void *	var_GetAddress (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
static int64_t	var_IncInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Increment an integer variable.
static int64_t	var_DecInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Decrement an integer variable.
static uint64_t	var_OrInteger (((vlc_object_t *)(vlc_object_t *obj)), const char *name, unsigned v)
static uint64_t	var_NAndInteger (((vlc_object_t *)(vlc_object_t *obj)), const char *name, unsigned v)
static int64_t	var_CreateGetInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a integer variable with inherit and get its value.
static bool	var_CreateGetBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a boolean variable with inherit and get its value.
static int64_t	var_CreateGetTime (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a time variable with inherit and get its value.
static float	var_CreateGetFloat (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a float variable with inherit and get its value.
static char *	var_CreateGetString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a string variable with inherit and get its value.
static char *	var_CreateGetNonEmptyString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
static void *	var_CreateGetAddress (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create an address variable with inherit and get its value.
static int64_t	var_CreateGetIntegerCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a integer command variable with inherit and get its value.
static bool	var_CreateGetBoolCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a boolean command variable with inherit and get its value.
static int64_t	var_CreateGetTimeCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a time command variable with inherit and get its value.
static float	var_CreateGetFloatCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a float command variable with inherit and get its value.
static char *	var_CreateGetStringCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
	Create a string command variable with inherit and get its value.
static char *	var_CreateGetNonEmptyStringCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
static int	var_CountChoices (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
static bool	var_ToggleBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
static bool	var_InheritBool (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
static int64_t	var_InheritInteger (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
static float	var_InheritFloat (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
static char *	var_InheritString (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
static mtime_t	var_InheritTime (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
static void *	var_InheritAddress (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
int	var_InheritURational (((vlc_object_t *)(vlc_object_t *)), unsigned *num, unsigned *den, const char *var)
int	var_LocationParse (((vlc_object_t *)(vlc_object_t *)), const char *mrl, const char *prefix)

Detailed Description

Functions for using the object variables in vlc.

Vlc have a very powerful "object variable" infrastructure useful for many things.

Macro Definition Documentation

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

Referenced by aout_FiltersNew(), aout_New(), aout_OutputNew(), aout_volume_New(), input_ControlVarNavigation(), input_ControlVarTitle(), InputAddCallbacks(), intf_Create(), PlayItem(), spu_Attach(), VariablesInit(), vlc_custom_create(), vlc_InitActions(), vlm_ControlMediaInstanceStart(), vlm_OnMediaUpdate(), vout_InitInterlacingSupport(), vout_IntfInit(), and vout_OpenWrapper().

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

Referenced by AddCustomRatios(), aout_New(), aout_OutputNew(), EsOutESVarUpdateGeneric(), input_ControlVarInit(), input_ControlVarNavigation(), input_ControlVarTitle(), input_SendEventAudioDelay(), input_SendEventCache(), input_SendEventLength(), input_SendEventPosition(), input_SendEventRate(), input_SendEventRecord(), input_SendEventSeekpoint(), input_SendEventSignal(), input_SendEventState(), input_SendEventSubtitleDelay(), input_SendEventTitle(), intf_Create(), NavigationCallback(), PositionCallback(), SeekpointCallback(), SubtitleAdd(), TimeCallback(), TitleCallback(), UpdateBookmarksOption(), var_CountChoices(), VarListAdd(), VarListDel(), VarListSelect(), vout_InitInterlacingSupport(), vout_IntfInit(), and vout_SendEventSourceCrop().

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

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

Referenced by EsOutSetRecord().

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

Referenced by aout_New(), aout_OutputNew(), config_ChainParse(), config_LoadCmdLine(), config_PrintHelp(), EqualizerCallback(), input_ConfigVarInit(), input_ControlVarInit(), input_ControlVarNavigation(), input_ControlVarTitle(), intf_Create(), libvlc_InternalInit(), LoadSubtitles(), sout_NewInstance(), spu_Attach(), SpuRenderCreateAndLoadText(), var_CreateGetAddress(), var_CreateGetBool(), var_CreateGetBoolCommand(), var_CreateGetFloat(), var_CreateGetFloatCommand(), var_CreateGetInteger(), var_CreateGetIntegerCommand(), var_CreateGetNonEmptyString(), var_CreateGetNonEmptyStringCommand(), var_CreateGetString(), var_CreateGetStringCommand(), var_CreateGetTime(), var_CreateGetTimeCommand(), var_OptionParse(), VariablesInit(), VisualizationCallback(), vlc_custom_create(), vlc_InitActions(), vlm_ControlMediaInstanceStart(), vlm_New(), vlm_OnMediaUpdate(), vout_InitInterlacingSupport(), vout_IntfInit(), and vout_OpenWrapper().

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

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

Referenced by MainLoop(), ThreadStart(), vout_new_buffer(), and VoutGetDisplayCfg().

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

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

Referenced by LoadSubtitles(), and VoutGetDisplayCfg().

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

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

Referenced by AddressCreate(), input_EsOutTimeshiftNew(), LoadSubtitles(), vout_OpenWrapper(), and VoutGetDisplayCfg().

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

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

Referenced by config_GetConfigFile(), EsOutSetRecord(), input_EsOutTimeshiftNew(), InputSourceInit(), libvlc_InternalAddIntf(), libvlc_InternalCleanup(), libvlc_InternalInit(), vout_InitInterlacingSupport(), vout_IntfInit(), and vout_OpenWrapper().

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

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

Referenced by aout_ChangeFilterString(), DeinterlaceCallback(), intf_Create(), and vlm_New().

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

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

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

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

Referenced by aout_PolicyNotify().

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

Referenced by aout_Destroy(), aout_FiltersDelete(), aout_FiltersNew(), aout_OutputDelete(), aout_volume_Delete(), input_ControlVarStop(), InputDelCallbacks(), LoopInput(), spu_Attach(), vlc_DeinitActions(), vlc_object_destroy(), vlm_ControlMediaInstanceStart(), vlm_MediaInstanceDelete(), vlm_OnMediaUpdate(), and vout_CloseWrapper().

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

Referenced by aout_ChangeFilterString(), aout_DecDelete(), aout_DecNew(), config_GetConfigFile(), input_ControlVarNavigation(), input_ControlVarTitle(), libvlc_InternalAddIntf(), libvlc_InternalInit(), LoadSubtitles(), and spu_Attach().

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

Referenced by config_ChainParse(), input_ControlVarInit(), UpdateSPU(), and vout_IntfInit().

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

Referenced by var_CreateGetAddress().

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

Referenced by DeinterlaceCallback(), EsSelect(), InitPrograms(), input_item_add_subitem_tree(), input_vaControl(), InputSourceInit(), libvlc_InternalInit(), LoadSubtitles(), LoopRequest(), MainLoop(), NextItem(), PlaylistVAControl(), ResetCurrentlyPlaying(), SpuRenderText(), StartTitle(), var_CreateGetBool(), var_CreateGetBoolCommand(), vout_SendEventDisplayFilled(), vout_SendEventOnTop(), and VoutCreate().

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

Referenced by var_Get(), var_GetAddress(), var_GetBool(), var_GetCoords(), var_GetFloat(), var_GetInteger(), var_GetNonEmptyString(), var_GetString(), var_GetTime(), and var_Inherit().

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

Referenced by vout_SendEventMousePressed().

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

Referenced by aout_VolumeGet(), Control(), input_vaControl(), PositionCallback(), RateOffsetCallback(), StartTitle(), str_format_meta(), var_CreateGetFloat(), var_CreateGetFloatCommand(), VideoSplitterCallback(), vlm_ControlMediaInstanceGets(), vlm_ControlMediaInstanceGetTimePosition(), and vout_SendEventZoom().

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

Referenced by aout_OutputNew(), CropBorderCallback(), DeinterlaceCallback(), EsUnselect(), input_ControlVarInit(), input_EsOutNew(), input_SendEventProgramScrambled(), input_vaControl(), InputEvent(), InputSourceInit(), MainLoopTryRepeat(), PlayItem(), playlist_fetcher_New(), PlaylistVAControl(), SeekpointCallback(), sout_MuxSendBuffer(), str_format_meta(), subtitles_Detect(), TitleCallback(), UpdatePtsDelay(), UpdateSPU(), var_CreateGetInteger(), var_CreateGetIntegerCommand(), vlm_ControlMediaInstanceGets(), vlm_ControlMediaInstancePause(), vlm_ControlMediaInstanceStart(), vout_InitInterlacingSupport(), VoutCreate(), and VoutSaveSnapshot().

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

Referenced by aout_DeviceGet(), aout_New(), Create(), DeinterlaceAdd(), DeinterlaceIsPresent(), DeinterlaceRemove(), demux_New(), EsOutSelect(), InitPrograms(), InputMetaUser(), InputSourceInit(), LoadSlaves(), LoadSubtitles(), str_format_meta(), var_CreateGetNonEmptyString(), var_CreateGetNonEmptyStringCommand(), vlc_sdp_Start(), and vout_InitInterlacingSupport().

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

Referenced by aout_ChangeFilterString(), DeinterlaceCallback(), input_EsOutNew(), var_CreateGetString(), var_CreateGetStringCommand(), vout_EnableFilter(), and vout_SendEventSourceAspect().

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

Referenced by Control(), input_SendEventLength(), input_vaControl(), PositionCallback(), str_format_meta(), TimeCallback(), UpdatePtsDelay(), var_CreateGetTime(), var_CreateGetTimeCommand(), vlm_ControlMediaInstanceGets(), and vlm_ControlMediaInstanceGetTimePosition().

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

Referenced by aout_PolicyNotify().

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

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

Referenced by aout_FiltersNew(), aout_MuteGet(), aout_ReplayGainSelect(), config_PrintHelp(), CorksCallback(), Create(), decoder_SynchroInit(), libvlc_InternalCleanup(), libvlc_InternalInit(), ListModules(), LoopInput(), OSDWidget(), playlist_Create(), sout_NewInstance(), system_Configure(), ThreadInit(), Usage(), vlc_threads_setup(), vlc_xlib_init(), vout_NewDisplayWindow(), vout_OSDText(), vout_window_New(), VoutDisplayNewWindow(), VoutOsdSnapshot(), and VoutSaveSnapshot().

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

Referenced by aout_ReplayGainSelect(), and Init().

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

Referenced by aout_new_buffer(), EsOutControlLocked(), httpd_HostCreate(), libvlc_InternalInit(), net_Connect(), net_ConnectDgram(), playlist_preparser_New(), playlist_VolumeUp(), spu_Create(), vlc_InitActions(), vlc_threads_setup(), vlc_tls_ClientSessionCreate(), and vout_GetSnapshot().

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

Referenced by aout_FiltersDelete(), aout_FiltersNew(), config_PrintHelp(), httpd_HostCreate(), libvlc_InternalInit(), net_Connect(), net_ConnectDgram(), net_Socket(), playlist_Create(), SelectClockSource(), var_GetIfIndex(), var_InheritURational(), vlc_https_HostNew(), vlc_InitAction(), vlc_module_load(), VoutCreate(), and VoutSaveSnapshot().

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

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

Referenced by VoutGetDisplayCfg().

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

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

Referenced by vout_SendEventMouseReleased().

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

Referenced by vout_SendEventMousePressed().

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

Referenced by config_ChainParse(), var_Copy(), var_OptionParse(), and vout_IntfInit().

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

Referenced by ChangeToNode(), dialog_ExtensionUpdate(), dialog_Login(), dialog_ProgressCreate(), dialog_Question(), dialog_VFatal(), extension_DialogCommand(), input_item_changed(), PlayItem(), playlist_SendAddNotify(), Preparse(), Thread(), Trigger(), TriggerInstanceState(), vlm_ControlMediaInstanceStart(), and vlm_OnMediaUpdate().

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

Referenced by aout_MuteNotify(), config_LoadCmdLine(), config_PrintHelp(), Init(), input_ConfigVarInit(), input_SendEventProgramScrambled(), input_vaControl(), InputSourceInit(), libvlc_InternalInit(), playlist_MuteSet(), SpuRenderText(), var_Command(), VariablesInit(), vout_SendEventDisplayFilled(), vout_SendEventFullscreen(), vout_SendEventMousePressed(), vout_SendEventOnTop(), and vout_SetInterlacingState().

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

Referenced by var_Set(), var_SetAddress(), var_SetBool(), var_SetCoords(), var_SetFloat(), var_SetInteger(), var_SetString(), and var_SetTime().

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

Referenced by vout_SendEventMouseMoved(), and vout_SendEventMousePressed().

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

Referenced by aout_Destroy(), aout_VolumeNotify(), config_LoadCmdLine(), input_ConfigVarInit(), input_vaControl(), LoadSubtitles(), PositionCallback(), RateCallback(), RateOffsetCallback(), var_Command(), VariablesInit(), VideoSplitterCallback(), vlm_ControlMediaInstanceSetTimePosition(), vout_SendEventZoom(), and ZoomCallback().

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

Referenced by config_LoadCmdLine(), EsOutProgramSelect(), EsOutUpdateInfo(), Init(), input_ConfigVarInit(), input_item_add_subitem_tree(), input_vaControl(), libvlc_InternalInit(), MainLoopTryRepeat(), playlist_NodeDelete(), PlaylistVAControl(), TimeCallback(), Trigger(), var_Command(), VariablesInit(), vlc_key_to_action(), vlm_ControlMediaInstancePause(), vlm_ControlMediaInstanceStart(), vout_InitInterlacingSupport(), vout_IntfInit(), vout_SendEventKey(), and VoutSaveSnapshot().

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

Referenced by aout_ChangeFilterString(), aout_DeviceNotify(), aout_New(), config_LoadCmdLine(), DeinterlaceAdd(), DeinterlaceCallback(), DeinterlaceRemove(), EqualizerCallback(), Init(), libvlc_InternalInit(), LoadSubtitles(), var_Command(), VisualizationCallback(), vlm_ControlMediaInstanceStart(), vout_EnableFilter(), vout_SendEventSourceAspect(), and VoutSaveSnapshot().

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

Referenced by input_vaControl(), LoadSubtitles(), SpuRenderText(), TimeCallback(), and vlm_ControlMediaInstanceSetTimePosition().

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

Referenced by vout_SendEventMouseDoubleClick(), and vout_SendEventMousePressed().

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

Referenced by aout_volume_New(), DeinterlaceCallback(), LoopInput(), PlayItem(), and vout_IntfInit().

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

Referenced by aout_OutputNew(), input_ControlVarTitle(), and var_Command().

#define VLC_VAR_CLASS   0x00f0

Referenced by DumpVariable(), FreeList(), var_Command(), var_Create(), var_GetChecked(), var_Inherit(), and var_SetChecked().

#define VLC_VAR_FLAGS   0xff00

#define VLC_VAR_TYPE   0x00ff

Referenced by CheckValue(), and DumpVariable().

Function Documentation

int var_AddCallback	(	((vlc_object_t *)(vlc_object_t *))	,
		const char *	,
		vlc_callback_t	,
		void *
	)

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

int var_Command	(	((vlc_object_t *)(vlc_object_t *))	,
		const char *	,
		const char *	,
		const char *	,
		char **
	)

static int var_CountChoices ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

References count, vlc_value_t::i_int, var_Change, and VLC_VAR_CHOICESCOUNT.

int var_Create	(	((vlc_object_t *)(vlc_object_t *))	,
		const char *	,
		int
	)

static void* var_CreateGetAddress ( ((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

References var_Create, var_GetAddress, VLC_VAR_ADDRESS, and VLC_VAR_DOINHERIT.

static bool var_CreateGetBool ( ((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 var_Create, var_GetBool, VLC_VAR_BOOL, and VLC_VAR_DOINHERIT.

static bool var_CreateGetBoolCommand ( ((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 var_Create, var_GetBool, VLC_VAR_BOOL, VLC_VAR_DOINHERIT, and VLC_VAR_ISCOMMAND.

static float var_CreateGetFloat ( ((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 var_Create, var_GetFloat, VLC_VAR_DOINHERIT, and VLC_VAR_FLOAT.

static float var_CreateGetFloatCommand ( ((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 var_Create, var_GetFloat, VLC_VAR_DOINHERIT, VLC_VAR_FLOAT, and VLC_VAR_ISCOMMAND.

static int64_t var_CreateGetInteger ( ((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 var_Create, var_GetInteger, VLC_VAR_DOINHERIT, and VLC_VAR_INTEGER.

static int64_t var_CreateGetIntegerCommand ( ((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 var_Create, var_GetInteger, VLC_VAR_DOINHERIT, VLC_VAR_INTEGER, and VLC_VAR_ISCOMMAND.

static char* var_CreateGetNonEmptyString ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

References var_Create, var_GetNonEmptyString, VLC_VAR_DOINHERIT, and VLC_VAR_STRING.

static char* var_CreateGetNonEmptyStringCommand ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

References var_Create, var_GetNonEmptyString, VLC_VAR_DOINHERIT, VLC_VAR_ISCOMMAND, and VLC_VAR_STRING.

static char* var_CreateGetString ( ((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 var_Create, var_GetString, VLC_VAR_DOINHERIT, and VLC_VAR_STRING.

static char* var_CreateGetStringCommand ( ((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 var_Create, var_GetString, VLC_VAR_DOINHERIT, VLC_VAR_ISCOMMAND, and VLC_VAR_STRING.

static int64_t var_CreateGetTime ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

Create a time variable with inherit and get its value.

Parameters

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

References var_Create, var_GetTime, VLC_VAR_DOINHERIT, and VLC_VAR_TIME.

static int64_t var_CreateGetTimeCommand ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

Create a time 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 var_Create, var_GetTime, VLC_VAR_DOINHERIT, VLC_VAR_ISCOMMAND, and VLC_VAR_TIME.

static int64_t var_DecInteger ( ((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_GetAndSet(), and VLC_VAR_INTEGER_ADD.

int var_DelCallback	(	((vlc_object_t *)(vlc_object_t *))	,
		const char *	,
		vlc_callback_t	,
		void *
	)

int var_Destroy	(	((vlc_object_t *)(vlc_object_t *))	,
		const char *
	)

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 FreeList(), vlc_list_t::i_count, vlc_value_t::p_list, vlc_list_t::p_values, vlc_list_t::pi_types, and vlc_value_t::psz_string.

Referenced by SubtitleAdd().

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

static void* var_GetAddress ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

References vlc_value_t::p_address, var_GetChecked, and VLC_VAR_ADDRESS.

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

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

Referenced by var_DecInteger(), var_IncInteger(), var_NAndInteger(), var_OrInteger(), and var_ToggleBool().

static bool var_GetBool ( ((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, var_GetChecked, and VLC_VAR_BOOL.

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

static void var_GetCoords ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name, int32_t *  px, int32_t *  py  )

inlinestatic

References vlc_value_t::coords, likely, var_GetChecked, VLC_VAR_COORDS, vlc_value_t::x, and vlc_value_t::y.

static float var_GetFloat ( ((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, var_GetChecked, and VLC_VAR_FLOAT.

static int64_t var_GetInteger ( ((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, var_GetChecked, and VLC_VAR_INTEGER.

static char* var_GetNonEmptyString ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

References vlc_value_t::psz_string, var_GetChecked, and VLC_VAR_STRING.

static char* var_GetString ( ((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 vlc_value_t::psz_string, var_GetChecked, and VLC_VAR_STRING.

static int64_t var_GetTime ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

Get a time value.

Parameters

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

References vlc_value_t::i_time, var_GetChecked, and VLC_VAR_TIME.

static int64_t var_IncInteger ( ((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_GetAndSet(), and VLC_VAR_INTEGER_ADD.

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

< No error

< Object not found

< 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, msg_Warn, vlc_object_t::p_parent, vlc_value_t::psz_string, strdup(), var_GetChecked, 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(), var_InheritBool(), var_InheritFloat(), var_InheritInteger(), var_InheritString(), and var_InheritTime().

static void* var_InheritAddress ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name  )

inlinestatic

References vlc_value_t::p_address, var_Inherit(), and VLC_VAR_ADDRESS.

static bool var_InheritBool ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name  )

inlinestatic

References vlc_value_t::b_bool, var_Inherit(), and VLC_VAR_BOOL.

static float var_InheritFloat ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name  )

inlinestatic

References vlc_value_t::f_float, var_Inherit(), and VLC_VAR_FLOAT.

static int64_t var_InheritInteger ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name  )

inlinestatic

References vlc_value_t::i_int, var_Inherit(), and VLC_VAR_INTEGER.

static char* var_InheritString ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name  )

inlinestatic

References vlc_value_t::psz_string, var_Inherit(), and VLC_VAR_STRING.

static mtime_t var_InheritTime ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name  )

inlinestatic

References vlc_value_t::i_time, var_Inherit(), and VLC_VAR_TIME.

int var_InheritURational	(	((vlc_object_t *)(vlc_object_t *))	,
		unsigned *	num,
		unsigned *	den,
		const char *	var
	)

int var_LocationParse	(	((vlc_object_t *)(vlc_object_t *))	,
		const char *	mrl,
		const char *	prefix
	)

static uint64_t var_NAndInteger ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name, unsigned  v  )

inlinestatic

References vlc_value_t::i_int, var_GetAndSet(), and VLC_VAR_INTEGER_NAND.

static uint64_t var_OrInteger ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name, unsigned  v  )

inlinestatic

References vlc_value_t::i_int, var_GetAndSet(), and VLC_VAR_INTEGER_OR.

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

static int var_SetAddress ( ((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

References vlc_value_t::p_address, var_SetChecked, and VLC_VAR_ADDRESS.

static int var_SetBool ( ((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, and VLC_VAR_BOOL.

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

static int var_SetCoords ( ((vlc_object_t *)(vlc_object_t *obj))  , const char *  name, int32_t  x, int32_t  y  )

inlinestatic

References vlc_value_t::coords, var_SetChecked, VLC_VAR_COORDS, vlc_value_t::x, and vlc_value_t::y.

static int var_SetFloat ( ((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, var_SetChecked, and VLC_VAR_FLOAT.

static int var_SetInteger ( ((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, var_SetChecked, and VLC_VAR_INTEGER.

static int var_SetString ( ((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 vlc_value_t::psz_string, var_SetChecked, and VLC_VAR_STRING.

static int var_SetTime ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name, int64_t  i  )

inlinestatic

Set the value of a time variable.

Parameters

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

References vlc_value_t::i_time, var_SetChecked, and VLC_VAR_TIME.

static bool var_ToggleBool ( ((vlc_object_t *)(vlc_object_t *p_obj))  , const char *  psz_name  )

inlinestatic

References vlc_value_t::b_bool, var_GetAndSet(), and VLC_VAR_BOOL_TOGGLE.

int var_TriggerCallback	(	((vlc_object_t *)(vlc_object_t *))	,
		const char *
	)

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