makVrv::DtAudioSettingsWidgetInterface Class Reference

Interface for the DtAudioSettingsWidget. More...

Inheritance diagram for makVrv::DtAudioSettingsWidgetInterface:

Public Member Functions
	DtAudioSettingsWidgetInterface ()
	Default CTOR.
virtual	~DtAudioSettingsWidgetInterface ()
	Virtual DTOR.
virtual void	setAudioEnabled (bool enabled)=0
	Sets audio to be enabled/disabled in the widget.
virtual void	setVolume (int vol)=0
	Sets the audio volume level in the widget.
virtual void	setAudioPlaybackDevice (const std::string &val)=0
	Sets current audio playback device in the widget.
virtual void	setAudioCaptureDevice (const std::string &val)=0
	Sets current audio capture device in the widget.
virtual void	setShowAudioCaptureSettings (bool enabled)=0
	Sets audio capture settings to be visible in the GUI.
virtual void	setSpeedOfSound (double speed)=0
	Sets the speed of sound.
virtual void	setMaxVoices (int voices)=0
	Set the max numbers.
virtual void	setMaximumOutputDecibelCapability (double decibels)=0
	Set the sound system output capability.
virtual void	setEnvironmentalEnabled (bool enabled)=0
	Sets environmental processing to be enabled/disabled in the widget.
virtual void	setEnvironmentalAvailable (bool enabled)=0
	Sets environmental processing to be enabled/disabled in the widget.
virtual void	setPlaybackDeviceList (const std::vector< std::string > &devices)=0
	Sets the list of available playback devices.
virtual void	setCaptureDeviceList (const std::vector< std::string > &devices)=0
	Sets the list of available capture devices.

Public Attributes
Audio settings signals.
boost::signal< void(bool)>	signal_AudioEnabledChanged
	Signal emitted when the user changes the audio enabled checkbox in the widget.
boost::signal< void(int)>	signal_VolumeChanged
	Signal emitted when the user changes the main volume in the widget.
boost::signal< void(std::string)>	signal_AudioPlaybackDeviceChanged
	Signal emitted when the user changes the audio playback device in the widget.
boost::signal< void(std::string)>	signal_AudioCaptureDeviceChanged
	Signal emitted when the user changes the audio capture device in the widget.
boost::signal< void(double)>	signal_SpeedOfSoundChanged
	Signal emitted when the user changes the speed of sound in the widget.
boost::signal< void(int)>	signal_MaxVoicesChanged
	signal emitted when the user changes the max voices in the widget
boost::signal< void(double)>	signal_MaxmimumOutputDecibelCapability
	signal emitted when the user changes the max output of the system in the widget
boost::signal< void(bool)>	signal_EnvironmentalProcessingEnabledChanged

Detailed Description

Interface for the DtAudioSettingsWidget.

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]

enabled

is the new state of audio.

Implemented in makVrv::DtAudioSettingsWidget.

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

pure virtual

Sets the audio volume level in the widget.

Parameters

[in]

vol

is 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]

enabled

is 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]

enabled

is 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]

enabled

is 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]

vol

is the new speed of sound

Implemented in makVrv::DtAudioSettingsWidget.

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

pure virtual

Set the max numbers.

Parameters

[in]

vol

is 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]

vol

is 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]

enabled

is 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]

enabled

is 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]

the

list 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]

the

list of device names to use in the widget

Implemented in makVrv::DtAudioSettingsWidget.

Member Data Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvAudioQt/DtAudioSettingsWidgetInterface.h