CApplicationVolumeHandling Class Reference

Class handling application support for audio volume management. More...

#include <ApplicationVolumeHandling.h>

Inheritance diagram for CApplicationVolumeHandling:

Classes
struct	ReplayGainSettings

Public Member Functions
float	GetVolumePercent () const
float	GetVolumeRatio () const
bool	IsMuted () const
void	SetVolume (float iValue, bool isPercentage=true)
void	SetMute (bool mute)
void	ToggleMute (void)
const ReplayGainSettings &	GetReplayGainSettings () const
bool	Load (const TiXmlNode *settings)
bool	Save (TiXmlNode *settings) const
void	OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
	The value of the given setting has changed.
bool	OnAction (const CAction &action)
	Handle the mute, passthrough and volume actions.
Public Member Functions inherited from IApplicationComponent
virtual	~IApplicationComponent ()=default
Public Member Functions inherited from ISettingCallback
virtual	~ISettingCallback ()=default
virtual bool	OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
	The value of the given setting is being changed.
virtual void	OnSettingAction (const std::shared_ptr< const CSetting > &setting)
	The given setting has been activated.
virtual bool	OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
	The given setting needs to be updated.
virtual void	OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
	The given property of the given setting has changed.

Static Public Attributes
static constexpr float	VOLUME_MINIMUM = 0.0f
static constexpr float	VOLUME_MAXIMUM = 1.0f
static constexpr float	VOLUME_DYNAMIC_RANGE = 90.0f

Protected Member Functions
bool	IsMutedInternal () const
void	ShowVolumeBar (const CAction *action=nullptr)
void	CacheReplayGainSettings (const CSettings &settings)
void	Mute ()
void	UnMute ()
void	SetHardwareVolume (float hardwareVolume)
void	TogglePassthrough ()
void	ChangeVolume (const CAction &action)
	Steps or sets the volume as action asks, unless a bitstream is playing without volume control.
void	VolumeChanged ()

Protected Attributes
bool	m_muted = false
float	m_volumeLevel = VOLUME_MAXIMUM
ReplayGainSettings	m_replayGainSettings

Friends
class	CApplication
class	CApplicationMessageHandling

Detailed Description

Class handling application support for audio volume management.

Member Function Documentation

CacheReplayGainSettings()

void CApplicationVolumeHandling::CacheReplayGainSettings ( const CSettings & settings )

protected

ChangeVolume()

void CApplicationVolumeHandling::ChangeVolume ( const CAction & action )

protected

Steps or sets the volume as action asks, unless a bitstream is playing without volume control.

GetReplayGainSettings()

const ReplayGainSettings & CApplicationVolumeHandling::GetReplayGainSettings ( ) const

inline

GetVolumePercent()

float CApplicationVolumeHandling::GetVolumePercent

(

)

const

GetVolumeRatio()

float CApplicationVolumeHandling::GetVolumeRatio

(

)

const

IsMuted()

bool CApplicationVolumeHandling::IsMuted

(

)

const

IsMutedInternal()

bool CApplicationVolumeHandling::IsMutedInternal ( ) const

inlineprotected

Load()

bool CApplicationVolumeHandling::Load

(

const TiXmlNode *

settings

)

Mute()

void CApplicationVolumeHandling::Mute ( )

protected

OnAction()

bool CApplicationVolumeHandling::OnAction

(

const CAction &

action

)

Handle the mute, passthrough and volume actions.

Returns

true if action was one of them and has been handled

OnSettingChanged()

void CApplicationVolumeHandling::OnSettingChanged ( const 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.

Save()

bool CApplicationVolumeHandling::Save

(

TiXmlNode *

settings

)

const

SetHardwareVolume()

void CApplicationVolumeHandling::SetHardwareVolume ( float hardwareVolume )

protected

SetMute()

void CApplicationVolumeHandling::SetMute

(

bool

mute

)

SetVolume()

void CApplicationVolumeHandling::SetVolume	(	float	iValue,
		bool	isPercentage = true )

ShowVolumeBar()

void CApplicationVolumeHandling::ShowVolumeBar ( const CAction * action = nullptr )

protected

ToggleMute()

void CApplicationVolumeHandling::ToggleMute

(

void

)

TogglePassthrough()

void CApplicationVolumeHandling::TogglePassthrough ( )

protected

UnMute()

void CApplicationVolumeHandling::UnMute ( )

protected

VolumeChanged()

void CApplicationVolumeHandling::VolumeChanged ( )

protected

Friends And Related Symbol Documentation

CApplication

friend class CApplication

friend

CApplicationMessageHandling

friend class CApplicationMessageHandling

friend

Member Data Documentation

m_muted

bool CApplicationVolumeHandling::m_muted = false

protected

m_replayGainSettings

ReplayGainSettings CApplicationVolumeHandling::m_replayGainSettings

protected

m_volumeLevel

float CApplicationVolumeHandling::m_volumeLevel = VOLUME_MAXIMUM

protected

VOLUME_DYNAMIC_RANGE

float CApplicationVolumeHandling::VOLUME_DYNAMIC_RANGE = 90.0f

staticconstexpr

VOLUME_MAXIMUM

float CApplicationVolumeHandling::VOLUME_MAXIMUM = 1.0f

staticconstexpr

VOLUME_MINIMUM

float CApplicationVolumeHandling::VOLUME_MINIMUM = 0.0f

staticconstexpr

---

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

• ApplicationVolumeHandling.h
• ApplicationVolumeHandling.cpp