#include <GUIAudioManager.h>

Inheritance diagram for CGUIAudioManager:

Public Member Functions
	CGUIAudioManager ()

	~CGUIAudioManager () override

void	OnSettingChanged (std::shared_ptr< const CSetting > setting) override
	The value of the given setting has changed. More...

bool	OnSettingUpdate (std::shared_ptr< CSetting > setting, const char oldSettingId, const TiXmlNode oldSettingNode) override
	The given setting needs to be updated. More...

void	Initialize ()

void	DeInitialize ()

bool	Load ()

void	UnLoad ()

void	PlayActionSound (const CAction &action)

void	PlayWindowSound (int id, WINDOW_SOUND event)

void	PlayPythonSound (const std::string &strFileName, bool useCached=true)

void	Enable (bool bEnable)

void	SetVolume (float level)

void	Stop ()

Public Member Functions inherited from ISettingCallback
virtual	~ISettingCallback ()=default

virtual bool	OnSettingChanging (std::shared_ptr< const CSetting > setting)
	The value of the given setting is being changed. More...

virtual void	OnSettingAction (std::shared_ptr< const CSetting > setting)
	The given setting has been activated. More...

virtual void	OnSettingPropertyChanged (std::shared_ptr< const CSetting > setting, const char *propertyName)
	The given property of the given setting has changed. More...

Constructor & Destructor Documentation

◆ CGUIAudioManager()

CGUIAudioManager::CGUIAudioManager ( )

◆ ~CGUIAudioManager()

CGUIAudioManager::~CGUIAudioManager ( )

override

Member Function Documentation

◆ DeInitialize()

void CGUIAudioManager::DeInitialize ( )

◆ Enable()

void CGUIAudioManager::Enable ( bool bEnable )

◆ Initialize()

void CGUIAudioManager::Initialize ( void )

◆ Load()

bool CGUIAudioManager::Load ( )

◆ OnSettingChanged()

void CGUIAudioManager::OnSettingChanged ( std::shared_ptr< const CSetting > setting )

overridevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters

setting The setting whose value has been changed

Reimplemented from ISettingCallback.

◆ OnSettingUpdate()

bool CGUIAudioManager::OnSettingUpdate	(	std::shared_ptr< CSetting >	setting,
		const char *	oldSettingId,
		const TiXmlNode *	oldSettingNode
	)

overridevirtual

The given setting needs to be updated.

This callback is triggered when a setting needs to be updated because its value is outdated. This only happens when initially loading the value of a setting and will not be triggered afterwards.

Parameters

setting	The setting which needs to be updated.
oldSettingId	The id of the previous setting.
oldSettingNode	The old setting node

Returns: True if the setting has been successfully updated otherwise false

Reimplemented from ISettingCallback.

◆ PlayActionSound()

void CGUIAudioManager::PlayActionSound ( const CAction & action )

◆ PlayPythonSound()

void CGUIAudioManager::PlayPythonSound	(	const std::string &	strFileName,
		bool	useCached = `true`
	)

◆ PlayWindowSound()

void CGUIAudioManager::PlayWindowSound	(	int	id,
		WINDOW_SOUND	event
	)

◆ SetVolume()

void CGUIAudioManager::SetVolume ( float level )

◆ Stop()

void CGUIAudioManager::Stop ( )

◆ UnLoad()

void CGUIAudioManager::UnLoad ( )

The documentation for this class was generated from the following files:

Public Member Functions