Variables

Collaboration diagram for Variables:

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


Modules
	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().
Defines
#define	VLC_VAR_TYPE 0x00ff
#define	VLC_VAR_CLASS 0x00f0
#define	VLC_VAR_FLAGS 0xff00
#define	var_Command(a, b, c, d, e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
#define	var_Create(a, b, c) __var_Create( VLC_OBJECT(a), b, c )
	__var_Create() with automatic casting.
#define	var_Destroy(a, b) __var_Destroy( VLC_OBJECT(a), b )
	__var_Destroy() with automatic casting
#define	var_Change(a, b, c, d, e) __var_Change( VLC_OBJECT(a), b, c, d, e )
	__var_Change() with automatic casting
#define	var_Type(a, b) __var_Type( VLC_OBJECT(a), b )
	__var_Type() with automatic casting
#define	var_Set(a, b, c) __var_Set( VLC_OBJECT(a), b, c )
	__var_Set() with automatic casting
#define	var_Get(a, b, c) __var_Get( VLC_OBJECT(a), b, c )
	__var_Get() with automatic casting
#define	var_GetAndSet(a, b, c, d) __var_GetAndSet(VLC_OBJECT(a), b, c, d)
	__var_GetAndSet() with automatic casting
#define	var_AddCallback(a, b, c, d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
	__var_AddCallback() with automatic casting
#define	var_DelCallback(a, b, c, d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
	__var_DelCallback() with automatic casting
#define	var_TriggerCallback(a, b) __var_TriggerCallback( VLC_OBJECT(a), b )
	__var_TriggerCallback() with automatic casting
#define	var_SetInteger(a, b, c) __var_SetInteger( VLC_OBJECT(a),b,c)
	__var_SetInteger() with automatic casting
#define	var_SetBool(a, b, c) __var_SetBool( VLC_OBJECT(a),b,c)
	__var_SetBool() with automatic casting
#define	var_SetTime(a, b, c) __var_SetTime( VLC_OBJECT(a),b,c)
	__var_SetTime() with automatic casting
#define	var_SetFloat(a, b, c) __var_SetFloat( VLC_OBJECT(a),b,c)
	__var_SetFloat() with automatic casting
#define	var_SetString(a, b, c) __var_SetString( VLC_OBJECT(a),b,c)
	__var_SetString() with automatic casting
#define	var_SetAddress(o, n, p) __var_SetAddress(VLC_OBJECT(o), n, p)
	__var_SetAddress() with automatic casting
#define	var_GetInteger(a, b) __var_GetInteger( VLC_OBJECT(a),b)
	__var_GetInteger() with automatic casting
#define	var_GetBool(a, b) __var_GetBool( VLC_OBJECT(a),b)
	__var_GetBool() with automatic casting
#define	var_GetTime(a, b) __var_GetTime( VLC_OBJECT(a),b)
	__var_GetTime() with automatic casting
#define	var_GetFloat(a, b) __var_GetFloat( VLC_OBJECT(a),b)
	__var_GetFloat() with automatic casting
#define	var_GetString(a, b) __var_GetString( VLC_OBJECT(a),b)
	__var_GetString() with automatic casting
#define	var_GetNonEmptyString(a, b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
#define	var_GetAddress(a, b) __var_GetAddress( VLC_OBJECT(a),b)
	__var_GetAddress() with automatic casting
#define	var_IncInteger(a, b) __var_IncInteger( VLC_OBJECT(a), b )
#define	var_DecInteger(a, b) __var_DecInteger( VLC_OBJECT(a), b )
#define	var_CreateGetInteger(a, b) __var_CreateGetInteger( VLC_OBJECT(a),b)
	__var_CreateGetInteger() with automatic casting
#define	var_CreateGetBool(a, b) __var_CreateGetBool( VLC_OBJECT(a),b)
	__var_CreateGetBool() with automatic casting
#define	var_CreateGetTime(a, b) __var_CreateGetTime( VLC_OBJECT(a),b)
	__var_CreateGetTime() with automatic casting
#define	var_CreateGetFloat(a, b) __var_CreateGetFloat( VLC_OBJECT(a),b)
	__var_CreateGetFloat() with automatic casting
#define	var_CreateGetString(a, b) __var_CreateGetString( VLC_OBJECT(a),b)
	__var_CreateGetString() with automatic casting
#define	var_CreateGetNonEmptyString(a, b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
#define	var_CreateGetAddress(a, b) __var_CreateGetAddress( VLC_OBJECT(a),b)
	__var_CreateGetString() with automatic casting
#define	var_CreateGetIntegerCommand(a, b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
	__var_CreateGetInteger() with automatic casting
#define	var_CreateGetBoolCommand(a, b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
	__var_CreateGetBoolCommand() with automatic casting
#define	var_CreateGetTimeCommand(a, b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
	__var_CreateGetTimeCommand() with automatic casting
#define	var_CreateGetFloatCommand(a, b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
	__var_CreateGetFloat() with automatic casting
#define	var_CreateGetStringCommand(a, b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
	__var_CreateGetStringCommand() with automatic casting
#define	var_CreateGetNonEmptyStringCommand(a, b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
#define	var_CountChoices(a, b) __var_CountChoices( VLC_OBJECT(a),b)
	__var_CountChoices() with automatic casting
#define	var_ToggleBool(a, b) __var_ToggleBool( VLC_OBJECT(a),b )
	__var_ToggleBool() with automatic casting
Functions
int	__var_Create (vlc_object_t , const char , int)
	Initialize a vlc variable.
int	__var_Destroy (vlc_object_t , const char )
	Destroy a vlc variable.
int	__var_Change (vlc_object_t , const char , int, vlc_value_t , vlc_value_t )
	Perform an action on a variable.
int	__var_Type (vlc_object_t , const char )
	Request a variable's type.
int	__var_Set (vlc_object_t , const char , vlc_value_t)
	Set a variable's value.
int	__var_Get (vlc_object_t , const char , vlc_value_t *)
	Get a variable's value.
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.
int	__var_Command (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 , const char , vlc_callback_t, void *)
	Register a callback in a variable.
int	__var_DelCallback (vlc_object_t , const char , vlc_callback_t, void *)
	Remove a callback from a variable.
int	__var_TriggerCallback (vlc_object_t , const char )
	Trigger callback on a variable.
static int	__var_SetInteger (vlc_object_t p_obj, const char psz_name, int i)
	Set the value of an integer variable.
static int	__var_SetBool (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 p_obj, const char psz_name, int64_t i)
	Set the value of a time variable.
static int	__var_SetFloat (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 p_obj, const char psz_name, const char *psz_string)
	Set the value of a string variable.
static int	__var_SetAddress (vlc_object_t p_obj, const char psz_name, void *ptr)
	Set the value of a pointer variable.
static int	__var_GetInteger (vlc_object_t p_obj, const char psz_name)
	Get an integer value.
static bool	__var_GetBool (vlc_object_t p_obj, const char psz_name)
	Get a boolean value.
static int64_t	__var_GetTime (vlc_object_t p_obj, const char psz_name)
	Get a time value.
static float	__var_GetFloat (vlc_object_t p_obj, const char psz_name)
	Get a float value.
static char *	__var_GetString (vlc_object_t p_obj, const char psz_name)
	Get a string value.
static char *	__var_GetNonEmptyString (vlc_object_t p_obj, const char psz_name)
static void *	__var_GetAddress (vlc_object_t p_obj, const char psz_name)
static void	__var_IncInteger (vlc_object_t p_obj, const char psz_name)
	Increment an integer variable.
static void	__var_DecInteger (vlc_object_t p_obj, const char psz_name)
	Decrement an integer variable.
static int	__var_CreateGetInteger (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 p_obj, const char psz_name)
	Create a boolean variable with inherit and get its value.
static int64_t	__var_CreateGetTime (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 p_obj, const char psz_name)
	Create a float variable with inherit and get its value.
static char *	__var_CreateGetString (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 p_obj, const char psz_name)
static void *	__var_CreateGetAddress (vlc_object_t p_obj, const char psz_name)
	Create an address variable with inherit and get its value.
static int	__var_CreateGetIntegerCommand (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 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 p_obj, const char psz_name)
	Create a time command variable with inherit and get its value.
static float	__var_CreateGetFloatCommand (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 p_obj, const char psz_name)
	Create a string command variable with inherit and get its value.
static char *	__var_CreateGetNonEmptyStringCommand (vlc_object_t p_obj, const char psz_name)
static int	__var_CountChoices (vlc_object_t p_obj, const char psz_name)
static int	__var_ToggleBool (vlc_object_t p_obj, const char psz_name)

Detailed Description

Functions for using the object variables in vlc.

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

Define Documentation

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

__var_AddCallback() with automatic casting

Referenced by __vlc_custom_create(), __vout_Create(), Activate(), AddCropVariableCallback(), aout_InputNew(), aout_OutputNew(), Callback(), ControlList(), ControlListPrint(), Create(), CreateFilter(), CreateVout(), DeinterlaceEnable(), DialogHandler::DialogHandler(), EqzInit(), EventIntf(), demux_sys_t::EventThread(), FullscreenControllerWidget::fullscreenChanged(), Init(), input_ControlVarNavigation(), input_ControlVarTitle(), InputAddCallbacks(), InputChange(), InterfaceWindow::InterfaceWindow(), intf_Create(), ItemChange(), libvlc_InternalInit(), libvlc_media_player_new(), libvlc_media_player_play(), libvlc_vlm_init(), MainInterface::MainInterface(), VLCMain::manage, VlcProc::on_audio_filter_changed(), VlcProc::on_intf_event_changed(), Open(), OpenCommon(), OpenDecoder(), OpenPostproc(), PlayItem(), PostProcessEnable(), Probe(), QVLCVariable::QVLCVariable(), Run(), RunIntf(), set_input(), VLCVoutView::setVout:subView:frame:, FullscreenControllerWidget::setVoutList(), spu_Attach(), spu_Init(), ThemeRepository::ThemeRepository(), Timer::Timer(), TrackChange(), VariablesInit(), vlclua_add_callback(), VlcProc::VlcProc(), vlm_ControlMediaInstanceStart(), vlm_OnMediaUpdate(), vout_IntfInit(), and WaitPreparsed().

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

__var_Change() with automatic casting

Referenced by __vout_Create(), InputManager::activateTeletext(), AddCustomRatios(), aout_InputNew(), aout_OutputNew(), ChapterMenu::AttachedToWindow(), TitleMenu::AttachedToWindow(), LanguageMenu::AttachedToWindow(), AudioConfig(), Control(), ControlList(), ControlListPrint(), CreateChoicesMenu(), CreateMenuItem(), DeinterlaceEnable(), EsOutESVarUpdateGeneric(), Foo(), InputManager::hasAudio(), Input(), 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(), IsMenuEmpty(), ItemChange(), libvlc_audio_get_track(), libvlc_audio_set_track(), libvlc_get_track_description(), libvlc_media_player_get_chapter_count(), libvlc_media_player_get_chapter_count_for_title(), libvlc_media_player_get_title_count(), libvlc_toggle_teletext(), libvlc_video_get_spu(), libvlc_video_get_track(), libvlc_video_set_spu(), libvlc_video_set_track(), mvar_InputVarSetNew(), NavigationCallback(), VlcProc::on_intf_event_changed(), Open(), OpenPostproc(), PositionCallback(), PostProcessEnable(), Probe(), PutAction(), RunIntf(), InputManager::sectionMenu(), SeekpointCallback(), SetAvailControlsByString(), VLCControls::setupVarMenu:forMenuItem:target:var:selector:, VLCControls::setupVarMenuItem:target:var:selector:, VLCVoutView::setVout:subView:frame:, SubtitleAdd(), ThemeRepository::ThemeRepository(), TimeCallback(), TitleCallback(), UpdateBookmarksOption(), VarListAdd(), VarListDel(), VarListSelect(), VCDUpdateVar(), VideoConfig(), vlclua_var_get_list(), vout_IntfInit(), and vout_SendEventSourceCrop().

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

Referenced by Run(), and vlclua_command().

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

__var_CountChoices() with automatic casting

Referenced by EsOutSetRecord(), Input(), libvlc_audio_get_track_count(), libvlc_toggle_teletext(), libvlc_video_get_spu_count(), libvlc_video_get_track_count(), InterfaceWindow::MessageReceived(), and Redraw().

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

__var_Create() with automatic casting.

Referenced by __aout_New(), __aout_ToggleMute(), __aout_VolumeSet(), __config_ChainParse(), __osd_MenuCreate(), __sout_NewInstance(), __vlc_custom_create(), __vlm_New(), __vout_Create(), AcquireDrawable(), Activate(), Add(), AddOut(), aout_InputNew(), aout_OutputNew(), AssHandleHold(), VLCEqualizer::awakeFromNib, Callback(), CDDAOpen(), cocoaglvoutviewInit(), CommonInit(), CommonOpen(), ControlList(), ControlListPrint(), Create(), CreateFilter(), CreateVout(), DeinterlaceEnable(), DeinterlaceSave(), DesktopCallback(), DeviceCallback(), DialogHandler::DialogHandler(), EqualizerCallback(), VLCEqualizer::equalizerUpdated, EqzInit(), FilterCallback(), Foo(), FullscreenCallback(), GetHistory(), GetV4L2Params(), InOpen(), input_ConfigVarInit(), input_ControlVarInit(), input_ControlVarNavigation(), input_ControlVarTitle(), intf_Create(), libvlc_InternalInit(), libvlc_media_player_play(), LoadSubtitles(), OnTopCallback(), Open(), OpenAudio(), OpenDecoder(), OpenDecoderCommon(), OpenFilter(), OpenIn(), OpenOut(), OpenPostproc(), OpenWithCookies(), osd_GetMutex(), ParseImageAttachments(), ParseText(), PostProcessEnable(), Probe(), QVLCVariable::QVLCVariable(), SetBookmark(), VLCVoutView::setVout:subView:frame:, sout_AnnounceRegisterSDP(), sout_AnnounceUnRegister(), spu_Init(), SpuRenderCreateAndLoadText(), demux_sys_t::StartUiThread(), stream_ReadLine(), Stress(), ThemeRepository::ThemeRepository(), tls_ClientCreate(), tls_ServerCreate(), VariablesInit(), VarInit(), VisualizationCallback(), vlclua_var_create(), VlcProc::VlcProc(), vout_IntfInit(), VLCVoutView::voutView:subView:frame:, and WallpaperCallback().

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

__var_CreateGetString() with automatic casting

Referenced by Init().

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

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

__var_CreateGetBoolCommand() with automatic casting

Referenced by Create(), CreateFilter(), and vout_IntfInit().

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

__var_CreateGetFloat() with automatic casting

Referenced by Create(), GetV4L2Params(), LoadSubtitles(), Open(), and VoutGetDisplayCfg().

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

__var_CreateGetFloat() with automatic casting

Referenced by Create(), and Open().

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

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

__var_CreateGetInteger() with automatic casting

Referenced by Create(), CreateFilter(), OpenCommon(), and OpenDecoder().

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

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

Referenced by Create(), and OpenDecoder().

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

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

__var_CreateGetStringCommand() with automatic casting

Referenced by __vout_Create(), Create(), CreateFilter(), and OpenCommon().

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

__var_CreateGetTime() with automatic casting

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

__var_CreateGetTimeCommand() with automatic casting

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

Referenced by PutAction().

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

__var_DelCallback() with automatic casting

Referenced by VLCMain::applicationWillTerminate:, Callback(), Close(), CloseDecoder(), ClosePostproc(), CloseVideo(), Deactivate(), DelCropVariableCallback(), delete_input(), Destroy(), DestroyFilter(), End(), EqzClean(), EventIntf(), demux_sys_t::EventThread(), FreeSys(), FullscreenControllerWidget::fullscreenChanged(), input_ControlVarStop(), InputChange(), InputDelCallbacks(), libvlc_InternalCleanup(), libvlc_media_player_destroy(), libvlc_vlm_release_internal(), LoopInput(), VlcProc::on_intf_event_changed(), Open(), release_input_thread(), Run(), RunIntf(), FullscreenControllerWidget::setVoutList(), spu_Attach(), spu_Destroy(), vlclua_del_callback(), vlm_ControlMediaInstanceStart(), vlm_MediaInstanceDelete(), vlm_OnMediaUpdate(), WaitPreparsed(), DialogHandler::~DialogHandler(), MainInterface::~MainInterface(), QVLCVariable::~QVLCVariable(), ThemeRepository::~ThemeRepository(), Timer::~Timer(), and VlcProc::~VlcProc().

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

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

__var_Get() with automatic casting

Referenced by __config_ChainParse(), __GetBridge(), __osd_MenuCreate(), __vlm_New(), aglInit(), aglManage(), aout_InputNew(), aout_OutputNew(), AspectCallback(), AssHandleHold(), ChapterMenu::AttachedToWindow(), TitleMenu::AttachedToWindow(), AudioConfig(), ButtonUpdate(), Close(), cocoaglvoutviewInit(), CommonOpen(), Create(), CreateChoicesMenu(), CreateFilter(), CreateMenuItem(), DelStream(), DisplayPosition(), EqzInit(), EsOutSelect(), EvaluateRPN(), EventThread(), demux_sys_t::EventThread(), Foo(), StreamTime::getAsStringCurrTime(), StreamTime::getAsStringDuration(), StreamTime::getAsStringTimeLeft(), GetFontSize(), VLCControls::goToSpecificTime:, HandleSeek(), InitPrograms(), Input(), input_ControlVarInit(), input_ControlVarTitle(), VLCVoutView::isFullscreen, item_changed(), libvlc_audio_get_track(), libvlc_video_get_spu(), libvlc_video_get_track(), VLCControls::loop:, VLCMain::manageIntf:, ManageSlider(), ManageVideo(), Menu(), InterfaceWindow::MessageReceived(), mvar_InputVarSetNew(), Timer::Notify(), Interface::OnPlayStream(), Interface::OnVideoOnTop(), Open(), OpenDecoderCommon(), OpenDevice(), OpenFilter(), OpenIn(), OpenOut(), OpenPostproc(), osd_Find(), osd_GetMutex(), ParseExecute(), play_cb(), PlayingChange(), Playlist(), PlayPause(), PopupMenu(), QVLCMenu::PopupMenu(), Probe(), ProcessNodes(), PutAction(), VLCControls::quitAfterPlayback:, VLCControls::random:, Reassemble(), Redraw(), RenderText(), VLCControls::repeat:, VLCControls::repeatButtonAction:, Run(), SetFont(), VLCControls::setupVarMenu:forMenuItem:target:var:selector:, VLCControls::setupVarMenuItem:target:var:selector:, VLCControls::shuffle, Messages::sinkMessage(), sout_AnnounceRegisterSDP(), sout_AnnounceUnRegister(), VLCMain::timesliderUpdate:, VLCVoutView::toggleFloatOnTop, InterfaceWindow::UpdateInterface(), UpdateSPU(), VideoConfig(), vlclua_var_get(), vlm_Delete(), vout_IntfInit(), WindowEventHandler(), WindowOpen(), and Playlist::WndProc().

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

__var_GetAddress() with automatic casting

Referenced by AcquireDrawable(), AddOut(), ReleaseDrawable(), and SendIn().

#define var_GetAndSet	(	a,
		b,
		c,
		d	)	__var_GetAndSet(VLC_OBJECT(a), b, c, d)

__var_GetAndSet() with automatic casting

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

__var_GetBool() with automatic casting

Referenced by __vlclua_var_toggle_or_set(), aout_InputNew(), CommonManage(), Connect(), Control(), CreateDSBufferPCM(), DeinterlaceCallback(), Demux(), DirectXCreateWindow(), DisableScreensaver(), DisplayPosition(), DisplayVolume(), DoDiseqc(), VLCEqualizer::equalizerUpdated, EsSelect(), ForwardFullscreen(), FrontendOpen(), FullscreenEventDown(), FullscreenEventUp(), PLModel::hasLoop(), PLModel::hasRandom(), PLModel::hasRepeat(), Init(), InitPrograms(), Input(), input_vaControl(), InputSourceInit(), IsFullscreenActive(), VLCVoutWindow::leaveFullscreen, libvlc_get_fullscreen(), libvlc_media_player_can_pause(), libvlc_media_player_get_rate(), libvlc_media_player_is_seekable(), libvlc_media_player_set_rate(), libvlc_toggle_teletext(), libvlc_video_get_scale(), LoadSubtitles(), LoopRequest(), MainLoop(), Manage(), VLCMain::manageIntf:, ManageVideo(), NextItem(), VlcProc::on_can_record_changed(), VlcProc::on_intf_event_changed(), VlcProc::on_loop_changed(), VlcProc::on_random_changed(), VlcProc::on_repeat_changed(), Open(), OpenVideoDev(), osd_isVisible(), PlaylistVAControl(), VLCPlaylist::playModeUpdated, PutAction(), Redraw(), ReplayGainSelect(), ResetCurrentlyPlaying(), SessionsSetup(), AbstractController::setStatus(), FullscreenControllerWidget::setVoutList(), SpuRenderText(), StartTitle(), UpdateCaps(), Equalizer::updateUIFromCore(), vout_IntfInit(), vout_SendEventDisplayFilled(), vout_SendEventFullscreen(), vout_SendEventMousePressed(), vout_SendEventOnTop(), VoutOsdSnapshot(), VoutSaveSnapshot(), and VLCVoutView::voutView:subView:frame:.

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

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

__var_GetInteger() with automatic casting

Referenced by __aout_ToggleMute(), __str_format_meta(), AccessControl(), Activate(), Add(), aglInit(), aglManage(), LanguageMenu::AttachedToWindow(), AudioConfig(), CAMOpen(), CDDAControl(), CheckTitle(), ConfigTuner(), Control(), CropCallback(), DecodeBandwidth(), DecodeGuardInterval(), DecodeHierarchy(), DecodeInversion(), DecodeModulationATSC(), DecodeModulationOFDM(), DecodeModulationQAM(), DecodeTone(), DecodeTransmission(), DecodeVoltage(), DeinterlaceCallback(), DeinterlaceEnable(), DemuxControl(), DMXSetFilter(), DoDiseqc(), DVROpen(), VLCVoutWindow::enterFullscreen, EsOutProgramAdd(), EsUnselect(), EventMouse(), EventThreadCreate(), FrontendOpen(), FrontendSetATSC(), FrontendSetOFDM(), FrontendSetQAM(), FrontendSetQPSK(), FullscreenControllerWidgetFullscreenChanged(), FullscreenControllerWidgetMouseMoved(), VLCVoutWindow::initMainThread:, InitPrograms(), InitWindowSize(), Input(), input_ControlVarInit(), input_EsOutNew(), input_event_changed(), input_SendEventProgramScrambled(), input_vaControl(), InputEvent(), InputSourceInit(), libvlc_audio_get_channel(), libvlc_audio_output_get_device_type(), libvlc_media_player_get_chapter(), libvlc_media_player_get_rate(), libvlc_media_player_get_title(), libvlc_toggle_teletext(), libvlc_video_get_marquee_option_as_int(), libvlc_video_get_teletext(), MainLoopTryRepeat(), MarshalStatus(), MouseEvent(), VlcProc::on_bit_rate_changed(), VlcProc::on_intf_event_changed(), VlcProc::on_sample_rate_changed(), Open(), OpenDecoder(), OpenVideoGL(), PlayItem(), Playlist(), playlist_fetcher_New(), playlist_preparser_New(), PlaylistVAControl(), PostProcessSetFilterQuality(), PPNameCallback(), PutAction(), RateChanged(), InputManager::reverse(), RunIntf(), SeekpointCallback(), VLCVoutView::setVout:subView:frame:, FullscreenControllerWidget::setVoutList(), sout_MuxSendBuffer(), StateChanged(), BDAGraph::SubmitATSCTuneRequest(), BDAGraph::SubmitDVBCTuneRequest(), BDAGraph::SubmitDVBSTuneRequest(), BDAGraph::SubmitDVBTTuneRequest(), subtitles_Detect(), InputManager::telexSetPage(), ThreadWrite(), TitleCallback(), UpdateActivity(), InterfaceWindow::UpdateInterface(), UpdatePtsDelay(), UpdateSPU(), VCDControl(), VLCView::VLCView(), vlm_ControlMediaInstanceGets(), vlm_ControlMediaInstancePause(), vlm_ControlMediaInstanceStart(), Volume(), VolumeMove(), vout_GetSnapshot(), vout_SendEventMousePressed(), vout_SendEventMouseReleased(), VoutSaveSnapshot(), and VLCVoutView::voutView:subView:frame:.

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

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

__var_GetString() with automatic casting

Referenced by __vout_Create(), __vout_Request(), AddAudio(), AddVideo(), aout_InputDelete(), aout_InputNew(), AoutChangeFilterString(), DeinterlaceCallback(), DirectXEnumCallback(), DirectXInitDDraw(), input_EsOutNew(), libvlc_video_get_marquee_option_as_string(), Open(), PostProcessCallback(), PutAction(), Equalizer::updateUIFromCore(), vout_EnableFilter(), and vout_SendEventSourceAspect().

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

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

Referenced by PutAction().

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

__var_Set() with automatic casting

Referenced by __config_ChainParse(), __osd_MenuCreate(), __osd_MenuDelete(), Add(), aout_OutputNew(), ConfigWidget::Apply(), PrefsPanel::ApplyChanges(), VLCConfigControl::applyChanges, AssHandleHold(), AssHandleRelease(), AudioConfig(), AudioDeviceCallback(), Callback(), Close(), DeviceCallback(), QVLCMenu::DoAction(), EvaluateRPN(), EventThread(), demux_sys_t::EventThread(), CmdFaster::execute(), CmdSlower::execute(), CmdDvdRootMenu::execute(), Foo(), Forward(), ForwardEvent(), FullscreenCallback(), GetHistory(), HandleSeek(), VLCMain::hasDefinedShortcutKey:, libvlc_audio_set_track(), libvlc_video_set_spu(), VLCControls::loop:, ManageSlider(), ManageVideo(), VideoWindow::MessageReceived(), InterfaceWindow::MessageReceived(), MouseEvent(), VLCView::MouseMoved(), MyCallback(), MyThread(), Interface::OnFastStream(), Playlist::OnLoop(), OnMenuEvent(), Interface::OnPlayStream(), Playlist::OnRandom(), Playlist::OnRepeat(), Interface::OnSliderUpdate(), Interface::OnSlowStream(), OnTopCallback(), Interface::OnVideoOnTop(), VLCExtended::opaqueSliderAction:, Open(), OpenDecoder(), OpenFilter(), ParseImageAttachments(), ParseMRL(), ParsePath(), ParseText(), play_cb(), Playlist(), playlist_SendAddNotify(), PlayPause(), PositionSet(), Probe(), Process(), VoutWindow::processEvent(), TopWindow::processEvent(), PutAction(), VLCControls::quitAfterPlayback:, VLCControls::random:, VLCControls::repeat:, VLCControls::repeatButtonAction:, Run(), SendEvents(), StreamTime::set(), VLCVoutView::setVout:subView:frame:, Stress(), VLCMain::timesliderUpdate:, VLCVoutView::toggleFloatOnTop, VLCControls::toggleVarThread:, VideoConfig(), vlclua_libvlc_command(), vlclua_var_create(), vlclua_var_set(), vout_IntfInit(), WallpaperCallback(), and WindowEventHandler().

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

__var_SetAddress() with automatic casting

Referenced by AcquireDrawable(), AddOut(), ButtonUpdate(), dialog_Login(), dialog_ProgressCreate(), dialog_Question(), dialog_VFatal(), input_item_changed(), ItemToNode(), libvlc_media_player_play(), PlayItem(), Preparse(), ReleaseDrawable(), Thread(), Trigger(), and TriggerInstanceState().

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

__var_SetBool() with automatic casting

Referenced by __aout_New(), __aout_VolumeSet(), __osd_MenuCreate(), __var_Command(), __vlclua_var_toggle_or_set(), MainInputManager::activatePlayQuit(), ButtonUpdate(), CloseVideoGL(), Connect(), ControlListPrint(), DeinterlaceNeeded(), DesktopCallback(), DirectXPopupMenu(), VLCVoutView::enterFullscreen, EventThread(), CmdPlaylistRepeat::execute(), CmdPlaylistLoop::execute(), CmdPlaylistRandom::execute(), ExitFullscreen(), FilterCallback(), ForwardFullscreen(), FullscreenEventDown(), FullscreenEventUp(), Init(), InitWindow(), input_ConfigVarInit(), input_SendEventProgramScrambled(), input_vaControl(), InputSourceInit(), VLCVoutView::leaveFullscreen, libvlc_InternalInit(), libvlc_media_player_next_chapter(), libvlc_media_player_play(), libvlc_media_player_previous_chapter(), libvlc_set_fullscreen(), libvlc_toggle_teletext(), libvlc_video_set_scale(), Manage(), ManageVideo(), MouseEvent(), VLCView::MouseUp(), Open(), ParseMRL(), Probe(), PutAction(), RenderHtml(), Repeat(), RollOverTcp(), VLCInfo::saveMetaData:, PLModel::setLoop(), SetLoop(), PLModel::setRandom(), SetRandom(), PLModel::setRepeat(), SpecialKeyEvent(), SpuRenderText(), InputManager::telexSetTransparency(), VLCControls::telxTransparent:, VLCEqualizer::twopass:, VariablesInit(), VideoConfig(), vout_Destructor(), vout_IntfInit(), vout_SendEventDisplayFilled(), vout_SendEventFullscreen(), vout_SendEventMouseMoved(), vout_SendEventMousePressed(), vout_SendEventOnTop(), Win32ToggleFullscreen(), and WindowEventHandler().

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

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

__var_SetInteger() with automatic casting

Referenced by __aout_ToggleMute(), __aout_VolumeSet(), __var_Command(), InputManager::activateTeletext(), VLCControls::backward:, BlockScan(), ButtonUpdate(), ControlListPrint(), DeinterlaceEnable(), DeinterlaceSave(), DeleteInner(), ActionsManager::doAction(), DoDiseqc(), EsOutProgramSelect(), EsOutUpdateInfo(), EventKey(), VLCControls::faster:, VLCControls::forward:, FrontendSetQPSK(), Init(), Input(), input_ConfigVarInit(), input_vaControl(), libvlc_audio_output_set_device_type(), libvlc_audio_set_channel(), libvlc_InternalInit(), libvlc_media_player_play(), libvlc_media_player_set_chapter(), libvlc_media_player_set_rate(), libvlc_media_player_set_title(), libvlc_toggle_teletext(), libvlc_video_set_deinterlace(), libvlc_video_set_marquee_option_as_int(), libvlc_video_set_teletext(), libvlc_video_set_track(), libvlc_video_take_snapshot(), InputManager::littlefaster(), InputManager::littleslower(), MainLoopTryRepeat(), InterfaceWindow::MessageReceived(), MouseEvent(), VLCControls::mute:, VLCControls::next:, InputManager::normalRate(), Open(), ParseMRL(), VLCControls::play:, playlist_NodeDelete(), PlaylistVAControl(), PostProcessEnable(), PostProcessSetFilterQuality(), VLCControls::prev:, ProcessKeyEvent(), PutAction(), InputManager::reverse(), Run(), RunIntf(), VLCControls::scrollWheel:, InputManager::sectionMenu(), VLCApplication::sendEvent:, InputManager::setRate(), VLCControls::showPosition:, VLCExtended::sliderActionAdjustImage:, VLCControls::slower:, SpuRenderText(), VLCControls::stop:, InputManager::telexSetPage(), VLCControls::telxNavLink:, Thread(), Trigger(), UpdateActivity(), VariablesInit(), vlc_key_to_action(), vlm_ControlMediaInstancePause(), vlm_ControlMediaInstanceStart(), VLCControls::volumeDown:, VLCControls::volumeUp:, vout_IntfInit(), vout_SendEventKey(), vout_SendEventMouseMoved(), vout_SendEventMousePressed(), vout_SendEventMouseReleased(), VoutSaveSnapshot(), MainInterface::wheelEvent(), and WMHOTKEYPROC().

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

__var_SetString() with automatic casting

Referenced by __var_Command(), PodcastConfigDialog::accept(), aout_InputNew(), AoutChangeFilterString(), VLCEqualizer::awakeFromNib, VLCEqualizer::bandSliderUpdated:, VLCEqualizer::changePreset:, VLCExtended::changeVideoFiltersString:onOrOff:, VLCExtended::changeVoutFiltersString:onOrOff:, DeinterlaceAdd(), DeinterlaceCallback(), DeinterlaceRemove(), DeinterlaceSave(), DemuxOpen(), EqualizerCallback(), EqzInit(), FilterCallback(), Init(), libvlc_InternalInit(), libvlc_video_set_aspect_ratio(), libvlc_video_set_crop_geometry(), libvlc_video_set_deinterlace(), libvlc_video_set_marquee_option_as_string(), libvlc_video_take_snapshot(), MMSHOpen(), Open(), OutputNew(), PostProcessCallback(), PresetCallback(), PutAction(), Run(), RunIntf(), stream_ReadLine(), tls_ClientCreate(), tls_ServerCreate(), VisualizationCallback(), vout_EnableFilter(), vout_SendEventSourceAspect(), and VoutSaveSnapshot().

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

__var_SetTime() with automatic casting

Referenced by Input(), input_vaControl(), InputManager::jumpBwd(), InputManager::jumpFwd(), libvlc_media_player_set_time(), LoadSubtitles(), PutAction(), RunIntf(), InputManager::setAtoB(), SpuRenderText(), TimeCallback(), and vlm_ControlMediaInstanceSetTimePosition().

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

__var_ToggleBool() with automatic casting

Referenced by DirectXEventProc(), CmdToggleRecord::execute(), CmdFullscreen::execute(), ActionsManager::fullscreen(), HandleKey(), libvlc_toggle_fullscreen(), MacroDo(), ManageVideo(), PutAction(), ActionsManager::record(), RunIntf(), VLCVoutView::toggleFullscreen, vout_SendEventMouseDoubleClick(), and VLCControls::windowAction:.

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

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

#define VLC_VAR_CLASS 0x00f0

Referenced by __var_Command(), __var_Create(), DumpCommand(), DupList(), FreeList(), InheritValue(), var_GetChecked(), var_SetChecked(), vlclua_pushvalue(), and vlclua_tovalue().

#define VLC_VAR_FLAGS 0xff00

Function Documentation

int __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 GetUnused(), variable_t::i_entries, INSERT_ELEM, msg_Warn, callback_entry_t::p_data, variable_t::p_entries, vlc_object_internals_t::p_vars, callback_entry_t::pf_callback, vlc_object_internals_t::var_lock, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

Referenced by vout_filter_SetupChild().

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

References CheckValue(), variable_t::choices, variable_t::choices_text, i, vlc_list_t::i_count, variable_t::i_default, vlc_value_t::i_int, variable_t::i_type, vlc_object_internals_t::i_vars, InheritValue(), INSERT_ELEM, Lookup(), variable_t::max, variable_t::min, variable_t::ops, vlc_value_t::p_list, vlc_list_t::p_values, vlc_object_internals_t::p_vars, variable_ops_t::pf_cmp, variable_ops_t::pf_dup, variable_ops_t::pf_free, vlc_list_t::pi_types, vlc_value_t::psz_string, variable_t::psz_text, REMOVE_ELEM, variable_t::step, strdup(), variable_t::val, vlc_object_internals_t::var_lock, VLC_EGENERIC, VLC_ENOVAR, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_ADDCHOICE, VLC_VAR_CHOICESCOUNT, VLC_VAR_CLEARCHOICES, VLC_VAR_DELCHOICE, VLC_VAR_GETCHOICES, VLC_VAR_GETLIST, VLC_VAR_GETMAX, VLC_VAR_GETMIN, VLC_VAR_GETSTEP, VLC_VAR_GETTEXT, VLC_VAR_HASMAX, VLC_VAR_HASMIN, VLC_VAR_HASSTEP, VLC_VAR_INHERITVALUE, VLC_VAR_ISCOMMAND, VLC_VAR_SETDEFAULT, VLC_VAR_SETISCOMMAND, VLC_VAR_SETMAX, VLC_VAR_SETMIN, VLC_VAR_SETSTEP, VLC_VAR_SETTEXT, VLC_VAR_SETVALUE, and VLC_VAR_STRING.

Referenced by __var_CountChoices().

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

static int __var_CountChoices	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

References __var_Change(), vlc_value_t::i_int, and VLC_VAR_CHOICESCOUNT.

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

References addr_ops, vlc_value_t::b_bool, variable_t::b_incallback, bool_ops, variable_t::choices, variable_t::choices_text, vlc_value_t::f_float, float_ops, HashString(), vlc_list_t::i_count, variable_t::i_default, variable_t::i_entries, variable_t::i_hash, vlc_value_t::i_int, vlc_value_t::i_time, variable_t::i_type, variable_t::i_usage, vlc_object_internals_t::i_vars, InheritValue(), Insert(), INSERT_ELEM, int_ops, list_ops, Lookup(), msg_Err, mutex_ops, variable_t::ops, vlc_value_t::p_address, variable_t::p_entries, vlc_value_t::p_list, vlc_list_t::p_values, vlc_object_internals_t::p_vars, variable_ops_t::pf_dup, variable_ops_t::pf_free, variable_t::psz_name, vlc_value_t::psz_string, variable_t::psz_text, strdup(), string_ops, time_ops, variable_t::val, vlc_object_internals_t::var_lock, VLC_EBADVAR, vlc_internals, vlc_mutex_init(), vlc_mutex_lock(), vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_ADDRESS, VLC_VAR_BOOL, VLC_VAR_CLASS, VLC_VAR_DOINHERIT, VLC_VAR_FLOAT, VLC_VAR_HASCHOICE, VLC_VAR_INTEGER, VLC_VAR_ISCOMMAND, VLC_VAR_LIST, VLC_VAR_MUTEX, VLC_VAR_STRING, and VLC_VAR_TIME.

Referenced by __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(), and var_OptionParse().

static void* __var_CreateGetAddress	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 int __var_CreateGetInteger	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 int __var_CreateGetIntegerCommand	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

References __var_Create(), __var_GetNonEmptyString(), VLC_VAR_DOINHERIT, and VLC_VAR_STRING.

static char* __var_CreateGetNonEmptyStringCommand	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

References __var_Create(), __var_GetNonEmptyString(), VLC_VAR_DOINHERIT, VLC_VAR_ISCOMMAND, and VLC_VAR_STRING.

static char* __var_CreateGetString	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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 void __var_DecInteger	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

Decrement an integer variable.

Parameters:

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

References __var_GetAndSet(), vlc_value_t::i_int, and VLC_VAR_INTEGER_INCDEC.

int __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 GetUnused(), variable_t::i_entries, callback_entry_t::p_data, variable_t::p_entries, vlc_object_internals_t::p_vars, callback_entry_t::pf_callback, REMOVE_ELEM, vlc_object_internals_t::var_lock, VLC_EGENERIC, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

Referenced by vout_filter_SetupChild().

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

Destroy a vlc variable.

Look for the variable and destroy it if it is found. As in var_Create we do a call to memmove() but we have performance counterparts elsewhere.

Parameters:

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

References variable_t::choices, variable_t::choices_text, GetUnused(), i, vlc_list_t::i_count, variable_t::i_usage, vlc_object_internals_t::i_vars, variable_t::ops, variable_t::p_entries, vlc_list_t::p_values, vlc_object_internals_t::p_vars, variable_ops_t::pf_free, variable_t::psz_name, vlc_value_t::psz_string, variable_t::psz_text, variable_t::val, vlc_object_internals_t::var_lock, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

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 var_GetChecked().

static void* __var_GetAddress	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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

Referenced by __var_CreateGetAddress().

int __var_GetAndSet	(	vlc_object_t *	p_this,
		const char *	psz_name,
		int	i_action,
		vlc_value_t	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

References vlc_value_t::b_bool, CheckValue(), GetUnused(), variable_t::i_entries, vlc_value_t::i_int, variable_t::i_type, vlc_object_internals_t::p_vars, TriggerCallback(), variable_t::val, vlc_object_internals_t::var_lock, VLC_EGENERIC, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_BOOL, VLC_VAR_INTEGER, VLC_VAR_INTEGER_INCDEC, and VLC_VAR_TOGGLE_BOOL.

Referenced by __var_DecInteger(), __var_IncInteger(), and __var_ToggleBool().

static bool __var_GetBool	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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.

Referenced by __var_CreateGetBool(), and __var_CreateGetBoolCommand().

static float __var_GetFloat	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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.

Referenced by __var_CreateGetFloat(), and __var_CreateGetFloatCommand().

static int __var_GetInteger	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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.

Referenced by __var_CreateGetInteger(), and __var_CreateGetIntegerCommand().

static char* __var_GetNonEmptyString	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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

Referenced by __var_CreateGetNonEmptyString(), and __var_CreateGetNonEmptyStringCommand().

static char* __var_GetString	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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.

Referenced by __var_CreateGetString(), and __var_CreateGetStringCommand().

static int64_t __var_GetTime	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

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.

Referenced by __var_CreateGetTime(), and __var_CreateGetTimeCommand().

static void __var_IncInteger	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

Increment an integer variable.

Parameters:

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

References __var_GetAndSet(), vlc_value_t::i_int, and VLC_VAR_INTEGER_INCDEC.

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 var_SetChecked().

Referenced by var_OptionParse().

static int __var_SetAddress	(	vlc_object_t *	p_obj,
		const char *	psz_name,
		void *	ptr
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name,
		bool	b
	)			`[inline, static]`

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.

static int __var_SetFloat	(	vlc_object_t *	p_obj,
		const char *	psz_name,
		float	f
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name,
		int	i
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name,
		const char *	psz_string
	)			`[inline, static]`

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 *	p_obj,
		const char *	psz_name,
		int64_t	i
	)			`[inline, static]`

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 int __var_ToggleBool	(	vlc_object_t *	p_obj,
		const char *	psz_name
	)			`[inline, static]`

References __var_GetAndSet(), and VLC_VAR_TOGGLE_BOOL.

int __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 GetUnused(), variable_t::i_entries, vlc_object_internals_t::p_vars, TriggerCallback(), variable_t::val, vlc_object_internals_t::var_lock, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

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::i_type, i_type, vlc_object_internals_t::i_vars, Lookup(), vlc_object_internals_t::p_vars, vlc_object_internals_t::var_lock, vlc_internals, vlc_mutex_lock(), and vlc_mutex_unlock().

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(), i, 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 InputManager::activateTeletext(), ChapterMenu::AttachedToWindow(), TitleMenu::AttachedToWindow(), LanguageMenu::AttachedToWindow(), AudioConfig(), CreateChoicesMenu(), EsOutSelect(), Foo(), InitPrograms(), Input(), IsMenuEmpty(), libvlc_audio_get_track(), libvlc_audio_set_track(), libvlc_get_track_description(), libvlc_toggle_teletext(), libvlc_video_get_spu(), libvlc_video_get_track(), libvlc_video_set_spu(), libvlc_video_set_track(), mvar_InputVarSetNew(), PutAction(), RunIntf(), InputManager::sectionMenu(), SetAvailControlsByString(), VLCControls::setupVarMenu:forMenuItem:target:var:selector:, SubtitleAdd(), VideoConfig(), and vlclua_var_get_list().

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

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

Variables

Modules

Defines

Functions

Detailed Description

Define Documentation

Function Documentation