Detailed Description

A read-only snapshot of the user's voice settings in the connected Discord desktop client.

These belong to the Discord client, not to any individual Call.

Public Member Functions
	VoiceSettings (VoiceSettings &&other) noexcept
	Move constructor for VoiceSettings.

VoiceSettings &	operator= (VoiceSettings &&other) noexcept
	Move assignment operator for VoiceSettings.

	operator bool () const
	Returns true if the instance contains a valid object.

	VoiceSettings (const VoiceSettings &arg0)
	Copy constructor for VoiceSettings.

VoiceSettings &	operator= (const VoiceSettings &arg0)
	Copy assignment operator for VoiceSettings.

bool	SelfMute () const
	Self-mute state.

void	SetSelfMute (bool SelfMute)
	Setter for VoiceSettings::SelfMute.

bool	SelfDeaf () const
	Self-deafen state.

void	SetSelfDeaf (bool SelfDeaf)
	Setter for VoiceSettings::SelfDeaf.

discordpp::VoiceInputModeType	InputMode () const
	When the client transmits microphone audio.

void	SetInputMode (discordpp::VoiceInputModeType InputMode)
	Setter for VoiceSettings::InputMode.

std::string	PttKey () const
	Display string for the push-to-talk key, such as "SHIFT + F". Empty when nothing is bound.

void	SetPttKey (std::string PttKey)
	Setter for VoiceSettings::PttKey.

float	InputVolume () const
	Microphone volume, ranging from 0 to 100.

void	SetInputVolume (float InputVolume)
	Setter for VoiceSettings::InputVolume.

float	OutputVolume () const
	Speaker volume, ranging from 0 to 200.

void	SetOutputVolume (float OutputVolume)
	Setter for VoiceSettings::OutputVolume.

bool	AutomaticGainControl () const
	Automatic gain control state.

void	SetAutomaticGainControl (bool AutomaticGainControl)
	Setter for VoiceSettings::AutomaticGainControl.

bool	EchoCancellation () const
	Echo cancellation state.

void	SetEchoCancellation (bool EchoCancellation)
	Setter for VoiceSettings::EchoCancellation.

bool	NoiseSuppression () const
	Noise suppression state.

void	SetNoiseSuppression (bool NoiseSuppression)
	Setter for VoiceSettings::NoiseSuppression.

bool	NoiseCancellation () const
	Noise cancellation state.

void	SetNoiseCancellation (bool NoiseCancellation)
	Setter for VoiceSettings::NoiseCancellation.

Static Public Attributes
static const VoiceSettings	nullobj
	Uninitialized instance of VoiceSettings.

Constructor & Destructor Documentation

◆ VoiceSettings() [1/2]

discordpp::VoiceSettings::VoiceSettings ( VoiceSettings && other )

noexcept

Move constructor for VoiceSettings.

◆ VoiceSettings() [2/2]

discordpp::VoiceSettings::VoiceSettings ( const VoiceSettings & arg0 )

Copy constructor for VoiceSettings.

Member Function Documentation

◆ AutomaticGainControl()

bool discordpp::VoiceSettings::AutomaticGainControl ( ) const

Automatic gain control state.

◆ EchoCancellation()

bool discordpp::VoiceSettings::EchoCancellation ( ) const

Echo cancellation state.

◆ InputMode()

discordpp::VoiceInputModeType discordpp::VoiceSettings::InputMode ( ) const

When the client transmits microphone audio.

◆ InputVolume()

float discordpp::VoiceSettings::InputVolume ( ) const

Microphone volume, ranging from 0 to 100.

◆ NoiseCancellation()

bool discordpp::VoiceSettings::NoiseCancellation ( ) const

Noise cancellation state.

◆ NoiseSuppression()

bool discordpp::VoiceSettings::NoiseSuppression ( ) const

Noise suppression state.

◆ operator bool()

discordpp::VoiceSettings::operator bool ( ) const

inline

Returns true if the instance contains a valid object.

◆ operator=() [1/2]

VoiceSettings & discordpp::VoiceSettings::operator= ( const VoiceSettings & arg0 )

Copy assignment operator for VoiceSettings.

◆ operator=() [2/2]

VoiceSettings & discordpp::VoiceSettings::operator= ( VoiceSettings && other )

noexcept

Move assignment operator for VoiceSettings.

◆ OutputVolume()

float discordpp::VoiceSettings::OutputVolume ( ) const

Speaker volume, ranging from 0 to 200.

◆ PttKey()

std::string discordpp::VoiceSettings::PttKey ( ) const

Display string for the push-to-talk key, such as "SHIFT + F". Empty when nothing is bound.

◆ SelfDeaf()

bool discordpp::VoiceSettings::SelfDeaf ( ) const

Self-deafen state.

◆ SelfMute()

bool discordpp::VoiceSettings::SelfMute ( ) const

Self-mute state.

◆ SetAutomaticGainControl()

void discordpp::VoiceSettings::SetAutomaticGainControl ( bool AutomaticGainControl )

Setter for VoiceSettings::AutomaticGainControl.

◆ SetEchoCancellation()

void discordpp::VoiceSettings::SetEchoCancellation ( bool EchoCancellation )

Setter for VoiceSettings::EchoCancellation.

◆ SetInputMode()

void discordpp::VoiceSettings::SetInputMode ( discordpp::VoiceInputModeType InputMode )

Setter for VoiceSettings::InputMode.

◆ SetInputVolume()

void discordpp::VoiceSettings::SetInputVolume ( float InputVolume )

Setter for VoiceSettings::InputVolume.

◆ SetNoiseCancellation()

void discordpp::VoiceSettings::SetNoiseCancellation ( bool NoiseCancellation )

Setter for VoiceSettings::NoiseCancellation.

◆ SetNoiseSuppression()

void discordpp::VoiceSettings::SetNoiseSuppression ( bool NoiseSuppression )

Setter for VoiceSettings::NoiseSuppression.

◆ SetOutputVolume()

void discordpp::VoiceSettings::SetOutputVolume ( float OutputVolume )

Setter for VoiceSettings::OutputVolume.

◆ SetPttKey()

void discordpp::VoiceSettings::SetPttKey ( std::string PttKey )

Setter for VoiceSettings::PttKey.

◆ SetSelfDeaf()

void discordpp::VoiceSettings::SetSelfDeaf ( bool SelfDeaf )

Setter for VoiceSettings::SelfDeaf.

◆ SetSelfMute()

void discordpp::VoiceSettings::SetSelfMute ( bool SelfMute )

Setter for VoiceSettings::SelfMute.

Member Data Documentation

◆ nullobj

const VoiceSettings discordpp::VoiceSettings::nullobj

static

Uninitialized instance of VoiceSettings.