VolumeBase Class Reference

#include <libmythtv/audio/volumebase.h>

Inheritance diagram for VolumeBase:

Collaboration diagram for VolumeBase:

Public Member Functions
	VolumeBase ()
virtual	~VolumeBase ()=default
void	SWVolume (bool set)
bool	SWVolume (void) const
virtual uint	GetCurrentVolume (void) const
virtual void	SetCurrentVolume (int value)
virtual void	AdjustCurrentVolume (int change)
virtual void	ToggleMute (void)
virtual MuteState	GetMuteState (void) const
virtual MuteState	SetMuteState (MuteState)

Static Public Member Functions
static MuteState	NextMuteState (MuteState)

Protected Member Functions
virtual int	GetVolumeChannel (int channel) const =0
virtual void	SetVolumeChannel (int channel, int volume)=0
virtual void	SetSWVolume (int new_volume, bool save)=0
virtual int	GetSWVolume (void)=0
void	UpdateVolume (void)
void	SyncVolume (void)
void	SetChannels (int new_channels)

Protected Attributes
bool	m_internalVol {false}

Private Attributes
int	m_volume {80}
MuteState	m_currentMuteState {kMuteOff}
bool	m_swvol {false}
bool	m_swvolSetting {false}
int	m_channels {0}

Detailed Description

Definition at line 15 of file volumebase.h.

Constructor & Destructor Documentation

VolumeBase()

VolumeBase::VolumeBase

(

)

Definition at line 100 of file volumebase.cpp.

~VolumeBase()

virtual VolumeBase::~VolumeBase ( )

virtualdefault

Member Function Documentation

AdjustCurrentVolume()

void VolumeBase::AdjustCurrentVolume ( int  change )

virtual

Reimplemented in AudioReencodeBuffer.

Definition at line 133 of file volumebase.cpp.

Referenced by AudioPlayer::AdjustVolume(), MusicPlayer::decVolume(), and MusicPlayer::incVolume().

GetCurrentVolume()

uint VolumeBase::GetCurrentVolume ( void  ) const

virtual

Reimplemented in AudioReencodeBuffer.

Definition at line 119 of file volumebase.cpp.

Referenced by AudioPlayer::GetVolume(), MusicPlayer::getVolume(), and MythRAOPConnection::ProcessRequest().

GetMuteState()

MuteState VolumeBase::GetMuteState ( void  ) const

virtual

Reimplemented in AudioReencodeBuffer.

Definition at line 151 of file volumebase.cpp.

Referenced by AudioOutputBase::GetAudioData(), AudioPlayer::GetMuteState(), MusicPlayer::getMuteState(), and ToggleMute().

GetSWVolume()

virtual int VolumeBase::GetSWVolume ( void  )

protectedpure virtual

Implemented in AudioOutputBase, and AudioReencodeBuffer.

Referenced by SyncVolume().

GetVolumeChannel()

virtual int VolumeBase::GetVolumeChannel ( int  channel ) const

protectedpure virtual

Implemented in AudioOutputALSA, AudioOutputCA, AudioOutputDX, AudioOutputJACK, AudioOutputOpenSLES, AudioOutputOSS, AudioOutputPulseAudio, AudioOutputWin, AudioOutputAudioTrack, AudioOutputNULL, and AudioReencodeBuffer.

Referenced by SyncVolume().

NextMuteState()

MuteState VolumeBase::NextMuteState ( MuteState  cur )

static

Definition at line 156 of file volumebase.cpp.

Referenced by AudioPlayer::IncrMuteState().

SetChannels()

void VolumeBase::SetChannels ( int  new_channels )

protected

Definition at line 219 of file volumebase.cpp.

Referenced by AudioOutputBase::Reconfigure().

SetCurrentVolume()

void VolumeBase::SetCurrentVolume ( int  value )

virtual

Reimplemented in AudioReencodeBuffer.

Definition at line 124 of file volumebase.cpp.

Referenced by AdjustCurrentVolume(), AudioOutputCA::OpenDevice(), MythRAOPConnection::ProcessRequest(), AudioPlayer::SetVolume(), and MusicPlayer::setVolume().

SetMuteState()

MuteState VolumeBase::SetMuteState ( MuteState  mstate )

virtual

Definition at line 138 of file volumebase.cpp.

Referenced by AudioPlayer::SetMuteState(), and ToggleMute().

SetSWVolume()

virtual void VolumeBase::SetSWVolume ( int  new_volume, bool  save  )

protectedpure virtual

Implemented in AudioOutputBase, and AudioReencodeBuffer.

Referenced by UpdateVolume().

SetVolumeChannel()

virtual void VolumeBase::SetVolumeChannel ( int  channel, int  volume  )

protectedpure virtual

Implemented in AudioOutputALSA, AudioOutputCA, AudioOutputDX, AudioOutputJACK, AudioOutputOpenSLES, AudioOutputOSS, AudioOutputPulseAudio, AudioOutputWin, AudioOutputAudioTrack, AudioOutputNULL, and AudioReencodeBuffer.

Referenced by UpdateVolume().

SWVolume() [1/2]

void VolumeBase::SWVolume

(

bool

set

)

Definition at line 112 of file volumebase.cpp.

SWVolume() [2/2]

bool VolumeBase::SWVolume

(

void

)

const

Definition at line 107 of file volumebase.cpp.

Referenced by AudioOutputBase::AddData(), AudioOutputBase::CanPassthrough(), and AudioOutputBase::Reconfigure().

SyncVolume()

void VolumeBase::SyncVolume ( void  )

protected

Definition at line 210 of file volumebase.cpp.

Referenced by AudioOutputBase::Reconfigure().

ToggleMute()

void VolumeBase::ToggleMute ( void  )

virtual

Reimplemented in AudioReencodeBuffer.

Definition at line 145 of file volumebase.cpp.

Referenced by MusicPlayer::toggleMute().

UpdateVolume()

void VolumeBase::UpdateVolume ( void  )

protected

Definition at line 179 of file volumebase.cpp.

Referenced by AudioOutputBase::Reconfigure(), SetCurrentVolume(), and SetMuteState().

Member Data Documentation

m_channels

int VolumeBase::m_channels {0}

private

Definition at line 51 of file volumebase.h.

Referenced by SetChannels(), and UpdateVolume().

m_currentMuteState

MuteState VolumeBase::m_currentMuteState {kMuteOff}

private

Definition at line 48 of file volumebase.h.

Referenced by GetMuteState(), SetMuteState(), and UpdateVolume().

m_internalVol

bool VolumeBase::m_internalVol {false}

protected

Definition at line 43 of file volumebase.h.

Referenced by AudioOutputBase::AddData(), AudioOutputBase::CanPassthrough(), AudioOutputJACK::DeinterleaveAudio(), AudioOutputJACK::GetVolumeChannel(), AudioOutputALSA::OpenDevice(), AudioOutputCA::OpenDevice(), AudioOutputJACK::OpenDevice(), AudioOutputOSS::OpenDevice(), AudioOutputBase::Reconfigure(), AudioOutputALSA::SetVolumeChannel(), AudioOutputJACK::SetVolumeChannel(), and VolumeBase().

m_swvol

bool VolumeBase::m_swvol {false}

private

Definition at line 49 of file volumebase.h.

Referenced by SWVolume(), SyncVolume(), UpdateVolume(), and VolumeBase().

m_swvolSetting

bool VolumeBase::m_swvolSetting {false}

private

Definition at line 50 of file volumebase.h.

Referenced by SWVolume(), and VolumeBase().

m_volume

int VolumeBase::m_volume {80}

private

Definition at line 47 of file volumebase.h.

Referenced by AdjustCurrentVolume(), GetCurrentVolume(), SetCurrentVolume(), SyncVolume(), and UpdateVolume().

---

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

• mythtv/libs/libmythtv/audio/volumebase.h
• mythtv/libs/libmythtv/audio/volumebase.cpp