VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtAudioSettingsWidgetInterface Class Referenceabstract

Interface for the DtAudioSettingsWidget.

Inheritance diagram for makVrv::DtAudioSettingsWidgetInterface:
Inheritance graph
[legend]

Public Member Functions

 DtAudioSettingsWidgetInterface ()
 
virtual ~DtAudioSettingsWidgetInterface ()
 
virtual void setAudioEnabled (bool enabled)=0
 
virtual void setVolume (int vol)=0
 
virtual void setAudioPlaybackDevice (const std::string &val)=0
 
virtual void setAudioCaptureDevice (const std::string &val)=0
 
virtual void setShowAudioCaptureSettings (bool enabled)=0
 
virtual void setSpeedOfSound (double speed)=0
 
virtual void setMaxVoices (int voices)=0
 
virtual void setMaximumOutputDecibelCapability (double decibels)=0
 
virtual void setEnvironmentalEnabled (bool enabled)=0
 
virtual void setEnvironmentalAvailable (bool enabled)=0
 
virtual void setPlaybackDeviceList (const std::vector< std::string > &devices)=0
 
virtual void setCaptureDeviceList (const std::vector< std::string > &devices)=0
 

Public Attributes

Audio settings signals.
boost::signalslib::signal
< void(bool)> 
signal_AudioEnabledChanged
 
boost::signalslib::signal
< void(int)> 
signal_VolumeChanged
 
boost::signalslib::signal
< void(std::string)> 
signal_AudioPlaybackDeviceChanged
 
boost::signalslib::signal
< void(std::string)> 
signal_AudioCaptureDeviceChanged
 
boost::signalslib::signal
< void(double)> 
signal_SpeedOfSoundChanged
 
boost::signalslib::signal
< void(int)> 
signal_MaxVoicesChanged
 
boost::signalslib::signal
< void(double)> 
signal_MaxmimumOutputDecibelCapability
 
boost::signalslib::signal
< void(bool)> 
signal_EnvironmentalProcessingEnabledChanged
 

Constructor & Destructor Documentation

makVrv::DtAudioSettingsWidgetInterface::DtAudioSettingsWidgetInterface ( )

Default CTOR.

virtual makVrv::DtAudioSettingsWidgetInterface::~DtAudioSettingsWidgetInterface ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtAudioSettingsWidgetInterface::setAudioEnabled ( bool  enabled)
pure virtual

Sets audio to be enabled/disabled in the widget.

Parameters
[in]enabledis the new state of audio.

Implemented in makVrv::DtAudioSettingsWidget, and makVrf::DtVrfAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setVolume ( int  vol)
pure virtual

Sets the audio volume level in the widget.

Parameters
[in]volis the new volume level.

Implemented in makVrv::DtAudioSettingsWidget.

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

Sets current audio playback device in the widget.

Parameters
[in]enabledis the new audio capture device

Implemented in makVrv::DtAudioSettingsWidget.

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

Sets current audio capture device in the widget.

Parameters
[in]enabledis the new audio capture device

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setShowAudioCaptureSettings ( bool  enabled)
pure virtual

Sets audio capture settings to be visible in the GUI.

Parameters
[in]enabledis the new state of showing audio capture settings

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setSpeedOfSound ( double  speed)
pure virtual

Sets the speed of sound. Default is the speed of sound in air at STP.

Parameters
[in]volis the new speed of sound

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setMaxVoices ( int  voices)
pure virtual

Set the max numbers.

Parameters
[in]volis the new number of simultaneous sounds

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setMaximumOutputDecibelCapability ( double  decibels)
pure virtual

Set the sound system output capability.

Parameters
[in]volis the new sound level capable of being produced by the attached speakers

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setEnvironmentalEnabled ( bool  enabled)
pure virtual

Sets environmental processing to be enabled/disabled in the widget.

Parameters
[in]enabledis the new state of environmental processing.

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setEnvironmentalAvailable ( bool  enabled)
pure virtual

Sets environmental processing to be enabled/disabled in the widget.

Parameters
[in]enabledis the new state of environmental processing.

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setPlaybackDeviceList ( const std::vector< std::string > &  devices)
pure virtual

Sets the list of available playback devices.

Parameters
[in]thelist of device names to use in the widget

Implemented in makVrv::DtAudioSettingsWidget.

virtual void makVrv::DtAudioSettingsWidgetInterface::setCaptureDeviceList ( const std::vector< std::string > &  devices)
pure virtual

Sets the list of available capture devices.

Parameters
[in]thelist of device names to use in the widget

Implemented in makVrv::DtAudioSettingsWidget.

Member Data Documentation

boost::signalslib::signal<void (bool)> makVrv::DtAudioSettingsWidgetInterface::signal_AudioEnabledChanged

Signal emitted when the user changes the audio enabled checkbox in the widget.

boost::signalslib::signal<void (int)> makVrv::DtAudioSettingsWidgetInterface::signal_VolumeChanged

Signal emitted when the user changes the main volume in the widget.

boost::signalslib::signal<void (std::string)> makVrv::DtAudioSettingsWidgetInterface::signal_AudioPlaybackDeviceChanged

Signal emitted when the user changes the audio playback device in the widget.

boost::signalslib::signal<void (std::string)> makVrv::DtAudioSettingsWidgetInterface::signal_AudioCaptureDeviceChanged

Signal emitted when the user changes the audio capture device in the widget.

boost::signalslib::signal<void (double)> makVrv::DtAudioSettingsWidgetInterface::signal_SpeedOfSoundChanged

Signal emitted when the user changes the speed of sound in the widget.

boost::signalslib::signal<void (int)> makVrv::DtAudioSettingsWidgetInterface::signal_MaxVoicesChanged

signal emitted when the user changes the max voices in the widget

boost::signalslib::signal<void (double)> makVrv::DtAudioSettingsWidgetInterface::signal_MaxmimumOutputDecibelCapability

signal emitted when the user changes the max output of the system in the widget

boost::signalslib::signal<void (bool)> makVrv::DtAudioSettingsWidgetInterface::signal_EnvironmentalProcessingEnabledChanged

Signal emitted when the user changes the audio enabled checkbox in the widget.


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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)