Discord Social SDK
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
discordpp::ClientCreateOptions Class Reference

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.
 
ClientCreateOptionsoperator= (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.
 
ClientCreateOptionsoperator= (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.
 

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.

◆ 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. This may impose an additional CPU cost as software components for gain control, acoustic echo cancellation and noise suppression will be used, but allows for the normal media volume behavior to be used instead of in-call volume control.

◆ 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)

◆ SetExperimentalAudioSystem()

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

◆ SetWebBase()

void discordpp::ClientCreateOptions::SetWebBase ( std::string 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.