VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrf::DtVrfAudioSettingsManager Class Reference
Inheritance diagram for makVrf::DtVrfAudioSettingsManager:
Inheritance graph
[legend]

Public Member Functions

 DtVrfAudioSettingsManager (makVrv::DtDe &)
 
virtual ~DtVrfAudioSettingsManager ()
 
virtual void setAudioEnabled (bool)
 Set the master audio enabled state. More...
 
- Public Member Functions inherited from makVrv::DtAudioSettingsManager
virtual ~DtAudioSettingsManager ()
 Virtual DTOR. More...
 
virtual bool audioEnabled () const
 Get the master audio enabled state. More...
 
virtual void setVolume (double val)
 Set the master audio volume. More...
 
virtual double volume () const
 Get the master audio volume. More...
 
virtual void setAudioPlaybackDevice (const std::string &val)
 Set the device that audio should be played back on. More...
 
virtual std::string audioPlaybackDevice () const
 get the name of the device that the audio should be played back on More...
 
virtual void setAudioCaptureDevice (const std::string &val)
 Set the device that audio should be captured from. More...
 
virtual std::string audioCaptureDevice () const
 get the name of the device that the audio should be captured from More...
 
virtual void setShowCaptureDeviceSettings (bool val)
 Set whether or not the capture device selection dialog is present in the audio settings dialog. More...
 
virtual bool showCaptureDeviceSettings () const
 Get whether or not the capture device selection dialog is present in the audio settings dialog. More...
 
virtual void setSpeedOfSound (double val)
 Set the speed of sound (in meters/second). More...
 
virtual double speedOfSound () const
 Get the speed of sound (in meters/second). More...
 
virtual void setMaxVoices (int val)
 Set the maximum number of simultaneous playing sounds. More...
 
virtual int maxVoices () const
 Get the number of maximum voices. More...
 
virtual void setMaximumOutputDecibelCapability (double val)
 Set the maximum loudness that the sound hardware that this application is playing on is capable of producing. More...
 
virtual double maximumOutputDecibelCapability () const
 Get the maximum loudness that the sound system can generate. More...
 
virtual void setEnvironmentalProcessingEnabled (bool val)
 Set the environmental processing enabled state. More...
 
virtual bool environmentalProcessingEnabled () const
 Get the environmental processing enabled state. More...
 
void setFromRecord (const DtAudioSettingsRecord &rec)
 Set the current settings' state from the given record. More...
 
void getRecord (DtAudioSettingsRecord &rec) const
 Store the current settings' state in the given record. More...
 
- Public Member Functions inherited from makVrv::DtBaseSettingsManager< DtAudioSettingsRecord >
 DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
 CTOR. More...
 
virtual ~DtBaseSettingsManager ()
 Virtual DTOR. More...
 
virtual void initializeBackup ()
 Creates a backup of the settings' current state. More...
 
- Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< DtAudioSettingsRecord >
 DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
 CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk. More...
 
virtual ~DtCommonBaseSettingsManager ()
 Virtual DTOR. More...
 
virtual void autoSaveIfNecessary ()
 Saves the current settings as defaults if autosave is enabled. More...
 
virtual void setAutoSave (bool doit)
 Sets whether autosave is enabled for the settings manager. More...
 
virtual bool autoSave () const
 Gets whether autosave is enabled for the settings manager. More...
 
virtual void setUseDefaultSettingsRecord (bool useit)
 Sets whether setting initialization should check for a default record. More...
 
virtual bool useDefaultSettingsRecord () const
 Gets whether setting initialization should check for a default record. More...
 
virtual DtDeSettingssettings ()
 Accessor for the manager's DtDeSettings object. More...
 
virtual const DtDeSettingssettings () const
 Accessor for the manager's DtDeSettings object (const). More...
 
virtual DtSettingsBackupsettingsBackup ()
 Accessor for the manager's settings backup. More...
 
virtual const DtSettingsBackupsettingsBackup () const
 Accessor for the manager's settings backup (const). More...
 
virtual void loadDefaults ()
 Initializes the settings and creates a backup. More...
 
virtual void saveDefaultSettings ()
 Saves the current settings' state as the default (on disk). More...
 
virtual void loadDefaultSettings (bool loadOnlyFactorySettings)
 Loads the default settings from disk. More...
 
virtual void importSettings (const std::string &filePath)
 Load the settings' state from the given file. More...
 
virtual void exportSettings (const std::string &filePath) const
 Save the current settings' state to the given file. More...
 
virtual void getSplitRecord (std::vector< DtAudioSettingsRecord > &rec, std::vector< std::string > &fileNames)
 For directory support, split the main record into different sub-records and give them each a file name. More...
 
virtual void addRecords (DtAudioSettingsRecord &rec, DtAudioSettingsRecord &combinedRec)
 For directory support, when reading in a directory, add the records from each file to the combined record. More...
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor. More...
 
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from makVrv::DtAudioSettingsManager
static DtAudioSettingsManagerinstance (DtDe &de)
 Get an instance of the settings manager. More...
 
- Public Attributes inherited from makVrv::DtAudioSettingsManager
boost::signalslib::signal
< void(bool)> 
signal_enableAudioChanged
 Emitted when the audio enabled setting is changed. More...
 
boost::signalslib::signal
< void(double)> 
signal_volumeChanged
 Emitted when the audio volume is changed. More...
 
boost::signalslib::signal
< void(std::string)> 
signal_audioPlaybackDeviceChanged
 Emitted when the audio playback device setting is changed. More...
 
boost::signalslib::signal
< void(std::string)> 
signal_audioCaptureDeviceChanged
 Emitted when the audio capture device setting is changed. More...
 
boost::signalslib::signal
< void(bool)> 
signal_showCaptureDeviceSettingsChanged
 Emitted when the show audio capture device settings is changed. More...
 
boost::signalslib::signal
< void(double)> 
signal_speedOfSoundChanged
 Emitted when the speed of sound is changed. More...
 
boost::signalslib::signal
< void(double)> 
signal_maxVoicesChanged
 Emitted when the max voices are changed. More...
 
boost::signalslib::signal
< void(double)> 
signal_maximumOutputDecibelCapabilityChanged
 Emitted when the sound system capability changed. More...
 
boost::signalslib::signal
< void(bool)> 
signal_environmentalProcessingEnabledChanged
 Emitted when the environmental audio processing enabled setting is changed. More...
 
- Protected Types inherited from makVrv::DtBaseSettingsManager< DtAudioSettingsRecord >
typedef DtRecordSettingsBackup
< DtBaseSettingsManager
< DtAudioSettingsRecord >
, DtAudioSettingsRecord
RecordBackupType
 
- Protected Member Functions inherited from makVrv::DtAudioSettingsManager
 DtAudioSettingsManager (DtDe &de)
 Protected CTOR ( use instance(..) ). More...
 
- Protected Attributes inherited from makVrv::DtAudioSettingsManager
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
 
DtSettingsBackupmySettingsBackup
 
DtDemyDe
 

Constructor & Destructor Documentation

makVrf::DtVrfAudioSettingsManager::DtVrfAudioSettingsManager ( makVrv::DtDe )
virtual makVrf::DtVrfAudioSettingsManager::~DtVrfAudioSettingsManager ( )
virtual

Member Function Documentation

virtual void makVrf::DtVrfAudioSettingsManager::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]valis the new enabled state: true for on, false for off.

Reimplemented from makVrv::DtAudioSettingsManager.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)