Detailed Description

Represents a single input or output audio device available to the user.

Discord will initialize the audio engine with the system default input and output devices. You can change the device through the Client by passing the id of the desired audio device.

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

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

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

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

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

bool	Equals (discordpp::AudioDevice rhs)
	Compares the ID of two AudioDevice objects for equality.

std::string	Id () const
	The ID of the audio device.

void	SetId (std::string Id)
	Setter for AudioDevice::Id.

std::string	Name () const
	The display name of the audio device.

void	SetName (std::string Name)
	Setter for AudioDevice::Name.

bool	IsDefault () const
	Whether the audio device is the system default device.

void	SetIsDefault (bool IsDefault)
	Setter for AudioDevice::IsDefault.

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

Constructor & Destructor Documentation

◆ AudioDevice() [1/2]

discordpp::AudioDevice::AudioDevice ( AudioDevice && other )

noexcept

Move constructor for AudioDevice.

◆ AudioDevice() [2/2]

discordpp::AudioDevice::AudioDevice ( const AudioDevice & arg0 )

Copy constructor for AudioDevice.

Member Function Documentation

◆ Equals()

bool discordpp::AudioDevice::Equals ( discordpp::AudioDevice rhs )

Compares the ID of two AudioDevice objects for equality.

◆ Id()

std::string discordpp::AudioDevice::Id ( ) const

The ID of the audio device.

◆ IsDefault()

bool discordpp::AudioDevice::IsDefault ( ) const

Whether the audio device is the system default device.

◆ Name()

std::string discordpp::AudioDevice::Name ( ) const

The display name of the audio device.

◆ operator bool()

discordpp::AudioDevice::operator bool ( ) const

inline

Returns true if the instance contains a valid object.

◆ operator=() [1/2]

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

noexcept

Move assignment operator for AudioDevice.

◆ operator=() [2/2]

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

Copy assignment operator for AudioDevice.

◆ SetId()

void discordpp::AudioDevice::SetId ( std::string Id )

Setter for AudioDevice::Id.

◆ SetIsDefault()

void discordpp::AudioDevice::SetIsDefault ( bool IsDefault )

Setter for AudioDevice::IsDefault.

◆ SetName()

void discordpp::AudioDevice::SetName ( std::string Name )

Setter for AudioDevice::Name.

Member Data Documentation

◆ nullobj

const AudioDevice discordpp::AudioDevice::nullobj

static

Uninitialized instance of AudioDevice.