Detailed Description

Options for creating a new Client instance.

This class may be used to set advanced initialization-time options on Client.

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

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

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

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

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

std::string	WebBase () const
	The base URL for the Discord web application.

void	SetWebBase (std::string WebBase)
	Setter for ClientCreateOptions::WebBase.

std::string	ApiBase () const
	The base URL for the Discord API.

void	SetApiBase (std::string ApiBase)
	Setter for ClientCreateOptions::ApiBase.

discordpp::AudioSystem	ExperimentalAudioSystem () const
	The audio system to use. Defaults to AudioSystem::Standard.

void	SetExperimentalAudioSystem (discordpp::AudioSystem ExperimentalAudioSystem)
	Setter for ClientCreateOptions::ExperimentalAudioSystem.

bool	ExperimentalAndroidPreventCommsForBluetooth () const
	Whether to prevent communications mode on Android when Bluetooth is connected.

void	SetExperimentalAndroidPreventCommsForBluetooth (bool ExperimentalAndroidPreventCommsForBluetooth)
	Setter for ClientCreateOptions::ExperimentalAndroidPreventCommsForBluetooth.

std::optional< uint64_t >	CpuAffinityMask () const
	CPU affinity mask hint for certain platforms. Depending on platform support, may or may not be ignored.

void	SetCpuAffinityMask (std::optional< uint64_t > CpuAffinityMask)
	Setter for ClientCreateOptions::CpuAffinityMask.

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

Constructor & Destructor Documentation

◆ ClientCreateOptions() [1/2]

discordpp::ClientCreateOptions::ClientCreateOptions ( ClientCreateOptions && other )

noexcept

Move constructor for ClientCreateOptions.

◆ ClientCreateOptions() [2/2]

discordpp::ClientCreateOptions::ClientCreateOptions ( const ClientCreateOptions & arg0 )

Copy constructor for ClientCreateOptions.

Member Function Documentation

◆ ApiBase()

std::string discordpp::ClientCreateOptions::ApiBase ( ) const

The base URL for the Discord API.

◆ CpuAffinityMask()

std::optional< uint64_t > discordpp::ClientCreateOptions::CpuAffinityMask ( ) const

CPU affinity mask hint for certain platforms. Depending on platform support, may or may not be ignored.

◆ ExperimentalAndroidPreventCommsForBluetooth()

bool discordpp::ClientCreateOptions::ExperimentalAndroidPreventCommsForBluetooth ( ) const

Whether to prevent communications mode on Android when Bluetooth is connected.

This is an experimental API which may be removed or changed in a future release.

When set to true, the SDK will not enter communications mode when Bluetooth is connected. This setting is only meaningful on Android. It allows you to retain full quality stereo audio playback when in-call and avoids mixing issues caused by Bluetooth Absolute Volume, but will use the device microphone instead of the headset one.

◆ ExperimentalAudioSystem()

discordpp::AudioSystem discordpp::ClientCreateOptions::ExperimentalAudioSystem ( ) const

The audio system to use. Defaults to AudioSystem::Standard.

This is an experimental API which may be removed or changed in a future release.

The game audio system alters the behavior of Discord Voice on mobile platforms to use standard media-type streams instead of voice-specific audio APIs when possible. Currently this will be used on iOS 18.2+ on devices which return true from -[AVAudioSession isEchoCancelledInputAvailable] and on Android devices.

◆ operator bool()

discordpp::ClientCreateOptions::operator bool ( ) const

inline

Returns true if the instance contains a valid object.

◆ operator=() [1/2]

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

noexcept

Move assignment operator for ClientCreateOptions.

◆ operator=() [2/2]

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

Copy assignment operator for ClientCreateOptions.

◆ SetApiBase()

void discordpp::ClientCreateOptions::SetApiBase ( std::string ApiBase )

Setter for ClientCreateOptions::ApiBase.

◆ SetCpuAffinityMask()

void discordpp::ClientCreateOptions::SetCpuAffinityMask ( std::optional< uint64_t > CpuAffinityMask )

Setter for ClientCreateOptions::CpuAffinityMask.

◆ SetExperimentalAndroidPreventCommsForBluetooth()

void discordpp::ClientCreateOptions::SetExperimentalAndroidPreventCommsForBluetooth ( bool ExperimentalAndroidPreventCommsForBluetooth )

Setter for ClientCreateOptions::ExperimentalAndroidPreventCommsForBluetooth.

◆ SetExperimentalAudioSystem()

void discordpp::ClientCreateOptions::SetExperimentalAudioSystem ( discordpp::AudioSystem ExperimentalAudioSystem )

Setter for ClientCreateOptions::ExperimentalAudioSystem.

◆ SetWebBase()

void discordpp::ClientCreateOptions::SetWebBase ( std::string WebBase )

Setter for ClientCreateOptions::WebBase.

◆ WebBase()

std::string discordpp::ClientCreateOptions::WebBase ( ) const

The base URL for the Discord web application.

Member Data Documentation

◆ nullobj

const ClientCreateOptions discordpp::ClientCreateOptions::nullobj

static

Uninitialized instance of ClientCreateOptions.