Rooted singleton that holds value about current state of sound settings.

Inheritance diagram for makVrv::DtAudioSettingsManager:

Public Member Functions
virtual	~DtAudioSettingsManager ()

Controls for the sound settings.
virtual void	setAudioEnabled (bool val)

virtual bool	audioEnabled () const

virtual void	setVolume (double val)

virtual double	volume () const

virtual void	setAudioPlaybackDevice (const std::string &val)

virtual std::string	audioPlaybackDevice () const

virtual void	setAudioCaptureDevice (const std::string &val)

virtual std::string	audioCaptureDevice () const

virtual void	setShowCaptureDeviceSettings (bool val)

virtual bool	showCaptureDeviceSettings () const

virtual void	setSpeedOfSound (double val)

virtual double	speedOfSound () const

virtual void	setMaxVoices (int val)

virtual int	maxVoices () const

virtual void	setMaximumOutputDecibelCapability (double val)

virtual double	maximumOutputDecibelCapability () const

virtual void	setEnvironmentalProcessingEnabled (bool val)

virtual bool	environmentalProcessingEnabled () const

Setting Persistence Methods
void	setFromRecord (const DtAudioSettingsRecord &rec)

void	getRecord (DtAudioSettingsRecord &rec) const

Public Member Functions inherited from makVrv::DtBaseSettingsManager< DtAudioSettingsRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)

virtual	~DtBaseSettingsManager ()

virtual void	initializeBackup ()

virtual bool	getOverriddenFactoryRecord (DtAudioSettingsRecord &record) const

Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< DtAudioSettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)

virtual	~DtCommonBaseSettingsManager ()

virtual void	autoSaveIfNecessary ()

virtual void	setAutoSave (bool doit)

virtual bool	autoSave () const

virtual void	setUseDefaultSettingsRecord (bool useit)

virtual bool	useDefaultSettingsRecord () const

virtual DtDeSettings *	settings ()

virtual const DtDeSettings *	settings () const

virtual DtSettingsBackup *	settingsBackup ()

virtual const DtSettingsBackup *	settingsBackup () const

virtual void	loadDefaults ()

virtual void	saveDefaultSettings ()

virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)

virtual void	importSettings (const std::string &filePath)

virtual void	exportSettings (const std::string &filePath) const

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtAudioSettingsManager &	instance (DtDe &de)

Public Attributes
Boost signals for changed settings
boost::signalslib::signal < void(bool)>	signal_enableAudioChanged

boost::signalslib::signal < void(double)>	signal_volumeChanged

boost::signalslib::signal < void(std::string)>	signal_audioPlaybackDeviceChanged

boost::signalslib::signal < void(std::string)>	signal_audioCaptureDeviceChanged

boost::signalslib::signal < void(bool)>	signal_showCaptureDeviceSettingsChanged

boost::signalslib::signal < void(double)>	signal_speedOfSoundChanged

boost::signalslib::signal < void(double)>	signal_maxVoicesChanged

boost::signalslib::signal < void(double)>	signal_maximumOutputDecibelCapabilityChanged

boost::signalslib::signal < void(bool)>	signal_environmentalProcessingEnabledChanged

Protected Member Functions
	DtAudioSettingsManager (DtDe &de)

virtual bool	applyFactoryOverrides (DtAudioSettingsRecord &rec) const

Protected Attributes
bool	myAudioEnabled

double	myVolume

std::string	myAudioPlaybackDevice

std::string	myAudioCaptureDevice

bool	myShowCaptureDeviceSettings

double	mySpeedOfSound

int	myMaxVoices

double	myMaximumOutputDecibelCapability

bool	myEnvironmentalProcessingEnabled

Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< DtAudioSettingsRecord >
DtSignalConnectionManager	myConnections

std::string	myName

std::string	myExtension

std::string	myDisplayName

bool	myUseDefaultSettingsRecordFlag

bool	myAutoSaveFlag

DtSettingsBackup *	mySettingsBackup

DtDe &	myDe

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)

template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSettingsManager< DtAudioSettingsRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < DtAudioSettingsRecord > , DtAudioSettingsRecord >	RecordBackupType

Constructor & Destructor Documentation

virtual makVrv::DtAudioSettingsManager::~DtAudioSettingsManager ( )

virtual

Virtual DTOR.

makVrv::DtAudioSettingsManager::DtAudioSettingsManager ( DtDe & de )

protected

Protected CTOR ( use instance(..) ).

Member Function Documentation

static DtAudioSettingsManager& makVrv::DtAudioSettingsManager::instance ( DtDe & de )

static

Get an instance of the settings manager.

Parameters

[in] de is the display engine root for the singleton.

virtual void makVrv::DtAudioSettingsManager::setAudioEnabled ( bool val )

virtual

Set the master audio enabled state. When set, this switch will allow all sounds to be played. When not set, all sounds will be prevented from playing.

Parameters

[in] val is the new enabled state: true for on, false for off.

Reimplemented in makVrf::DtVrfAudioSettingsManager.

virtual bool makVrv::DtAudioSettingsManager::audioEnabled ( ) const

virtual

Get the master audio enabled state.

Return values

true	for audio is enabled.
false	otherwise.

See Also: setAudioEnabled()

virtual void makVrv::DtAudioSettingsManager::setVolume ( double val )

virtual

Set the master audio volume. This value controls the gain as heard from the listener's position.

Parameters

[in] val is the new volume.

virtual double makVrv::DtAudioSettingsManager::volume ( ) const

virtual

Get the master audio volume.

Returns: The master audio volume.

See Also: setVolume()

virtual void makVrv::DtAudioSettingsManager::setAudioPlaybackDevice ( const std::string & val )

virtual

Set the device that audio should be played back on.

Parameters

[in] deviceName is the name of the device that should be used for audio playback

virtual std::string makVrv::DtAudioSettingsManager::audioPlaybackDevice ( ) const

virtual

get the name of the device that the audio should be played back on

Returns: The name of the current audio device for audio playback

virtual void makVrv::DtAudioSettingsManager::setAudioCaptureDevice ( const std::string & val )

virtual

Set the device that audio should be captured from.

Parameters

[in] deviceName is the name of the device that should be used for audio capture

virtual std::string makVrv::DtAudioSettingsManager::audioCaptureDevice ( ) const

virtual

get the name of the device that the audio should be captured from

Returns: The name of the current audio device for audio capture

virtual void makVrv::DtAudioSettingsManager::setShowCaptureDeviceSettings ( bool val )

virtual

Set whether or not the capture device selection dialog is present in the audio settings dialog.

Parameters

[in] val is the new enabled state: true for on, false for off.

virtual bool makVrv::DtAudioSettingsManager::showCaptureDeviceSettings ( ) const

virtual

Get whether or not the capture device selection dialog is present in the audio settings dialog.

See Also: setShowCaptureDeviceSettings()

virtual void makVrv::DtAudioSettingsManager::setSpeedOfSound ( double val )

virtual

Set the speed of sound (in meters/second). This value controls the speed of sound which can depend on many external factors. This allows the user to choose the speed for their situation.

Parameters

[in] val is the new speed of sound.

See Also: DtAudioSettingsManager::setSpeedOfSound.

virtual double makVrv::DtAudioSettingsManager::speedOfSound ( ) const

virtual

Get the speed of sound (in meters/second).

Returns: The speed of sound.

See Also: setSpeedOfSound()

virtual void makVrv::DtAudioSettingsManager::setMaxVoices ( int val )

virtual

Set the maximum number of simultaneous playing sounds.

Parameters

[in] val is the new number of active voices.

virtual int makVrv::DtAudioSettingsManager::maxVoices ( ) const

virtual

Get the number of maximum voices.

Returns: the number of maximum voices

See Also: setMaxVoices()

virtual void makVrv::DtAudioSettingsManager::setMaximumOutputDecibelCapability ( double val )

virtual

Set the maximum loudness that the sound hardware that this application is playing on is capable of producing. This is used to calibrate where played sounds start to falloff sounds.

Parameters

[in] val is the loudness in decibels.

virtual double makVrv::DtAudioSettingsManager::maximumOutputDecibelCapability ( ) const

virtual

Get the maximum loudness that the sound system can generate.

Returns: the maximum decibels that the audio hardware can generate

See Also: setmaximumOutputDecibelCapability()

virtual void makVrv::DtAudioSettingsManager::setEnvironmentalProcessingEnabled ( bool val )

virtual

Set the environmental processing enabled state. When set, this switch will allow all sounds to be played with environmental effects processing such as lowpass filtering based on distance, so high frequency sounds get filtered out the further a sound source is. When not set, all sounds will be played without filtering.

Parameters

[in] val is the new enabled state: true for on, false for off.

virtual bool makVrv::DtAudioSettingsManager::environmentalProcessingEnabled ( ) const

virtual

Get the environmental processing enabled state.

Return values

true	for processing is enabled.
false	otherwise.

See Also: setEnvironmentalProcessingEnabled()

void makVrv::DtAudioSettingsManager::setFromRecord ( const DtAudioSettingsRecord & rec )

virtual

Set the current settings' state from the given record.

Implements makVrv::DtBaseSettingsManager< DtAudioSettingsRecord >.

void makVrv::DtAudioSettingsManager::getRecord ( DtAudioSettingsRecord & rec ) const

virtual

Store the current settings' state in the given record.

Implements makVrv::DtBaseSettingsManager< DtAudioSettingsRecord >.

virtual bool makVrv::DtAudioSettingsManager::applyFactoryOverrides ( DtAudioSettingsRecord & rec ) const

protectedvirtual

Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.

Implements makVrv::DtBaseSettingsManager< DtAudioSettingsRecord >.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction	(	DtDe &	de,
		bool	allowedInSlave
	)

friend

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
   static Manager& instance(DtDe& de);
   void loadDefaults();
protected:
   template <typename ManagerClass>
   friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
   template <typename ManagerClass>
   friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
   Manager(DtDe&);
   DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
   return defaultManagerInstanceFunction<Manager>(de);
}

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction	(	DtDe &	de,
		ManagerClass *	mgr
	)

friend

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

boost::signalslib::signal<void(bool)> makVrv::DtAudioSettingsManager::signal_enableAudioChanged

Emitted when the audio enabled setting is changed.

See Also: DtSharedAudioSettings::setAudioEnabled.

boost::signalslib::signal<void(double)> makVrv::DtAudioSettingsManager::signal_volumeChanged

Emitted when the audio volume is changed.

See Also: DtSharedAudioSettings::setVolume.

boost::signalslib::signal<void(std::string)> makVrv::DtAudioSettingsManager::signal_audioPlaybackDeviceChanged

Emitted when the audio playback device setting is changed.

See Also: DtSharedAudioSettings::setAudioPlaybackDevice.

boost::signalslib::signal<void(std::string)> makVrv::DtAudioSettingsManager::signal_audioCaptureDeviceChanged

Emitted when the audio capture device setting is changed.

See Also: DtSharedAudioSettings::setAudioCaptureDevice.

boost::signalslib::signal<void(bool)> makVrv::DtAudioSettingsManager::signal_showCaptureDeviceSettingsChanged

Emitted when the show audio capture device settings is changed.

See Also: DtSharedAudioSettings::setShowCaptureDeviceSettings.

boost::signalslib::signal<void(double)> makVrv::DtAudioSettingsManager::signal_speedOfSoundChanged

Emitted when the speed of sound is changed.

See Also: DtSharedAudioSettings::setSpeedOfSound.

boost::signalslib::signal<void(double)> makVrv::DtAudioSettingsManager::signal_maxVoicesChanged

Emitted when the max voices are changed.

See Also: DtSharedAudioSettings::setMaxVoices.

boost::signalslib::signal<void(double)> makVrv::DtAudioSettingsManager::signal_maximumOutputDecibelCapabilityChanged

Emitted when the sound system capability changed.

See Also: DtSharedAudioSettings::setmaximumOutputDecibelCapability.

boost::signalslib::signal<void(bool)> makVrv::DtAudioSettingsManager::signal_environmentalProcessingEnabledChanged

Emitted when the environmental audio processing enabled setting is changed.

See Also: DtSharedAudioSettings::setEnvironmentalProcessingEnabled.

bool makVrv::DtAudioSettingsManager::myAudioEnabled

protected

double makVrv::DtAudioSettingsManager::myVolume

protected

std::string makVrv::DtAudioSettingsManager::myAudioPlaybackDevice

protected

std::string makVrv::DtAudioSettingsManager::myAudioCaptureDevice

protected

bool makVrv::DtAudioSettingsManager::myShowCaptureDeviceSettings

protected

double makVrv::DtAudioSettingsManager::mySpeedOfSound

protected

int makVrv::DtAudioSettingsManager::myMaxVoices

protected

double makVrv::DtAudioSettingsManager::myMaximumOutputDecibelCapability

protected

bool makVrv::DtAudioSettingsManager::myEnvironmentalProcessingEnabled

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvAudio/DtAudioSettingsManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation