switchboard::SwitchboardSDK Class Reference

Initializes and configures the Switchboard SDK. More...

#include <SwitchboardSDK.hpp>

Static Public Member Functions
static WASM void	initialize (const char *clientID, const char *clientSecret)
static void	initialize (const std::string clientID, const std::string clientSecret)
static bool	isInitialized ()
static std::string	getAPIUrl ()
static WASM std::string	getClientID ()
static WASM std::string	getClientSecret ()
static std::string	getAppID ()
static void	setAppID (const std::string &appID)
static std::string	getDeviceID ()
static void	setDeviceID (const std::string &deviceID)
static std::string	getTemporaryDirectoryPath ()
static void	setTemporaryDirectoryPath (const std::string &path)
static uint	getMaxNumberOfFrames ()
static LicenseManager *	getLicenseManager ()

Detailed Description

Initializes and configures the Switchboard SDK.

SwitchboardSDK class.

Member Function Documentation

getAPIUrl()

std::string switchboard::SwitchboardSDK::getAPIUrl ( )

static

Gets the base url of the Switchboard API.

Returns

The url of the API.

getAppID()

std::string switchboard::SwitchboardSDK::getAppID ( )

static

Gets the parent app's appID.

Returns

The appID value.

getClientID()

std::string switchboard::SwitchboardSDK::getClientID ( )

static

Gets the client ID value that was used to initialize the SDK.

Returns

The client ID value.

getClientSecret()

std::string switchboard::SwitchboardSDK::getClientSecret ( )

static

Gets the client secret value that was used to initialize the SDK.

Returns

The client secret value.

getDeviceID()

std::string switchboard::SwitchboardSDK::getDeviceID ( )

static

Gets an ID which is unique to each install or for a device.

Returns

The unique identifier of the device.

getLicenseManager()

LicenseManager * switchboard::SwitchboardSDK::getLicenseManager ( )

static

Gets the shared license manager instance.

Returns

The shared license manager instance.

getMaxNumberOfFrames()

uint switchboard::SwitchboardSDK::getMaxNumberOfFrames ( )

static

Indicates the maximum number of frames that can be accommodated in the audio buffer It's typically used to determine the buffer size needed for audio processing tasks.

Returns

uint The maximum number of frames that can be accommodated in the audio buffer.

getTemporaryDirectoryPath()

std::string switchboard::SwitchboardSDK::getTemporaryDirectoryPath ( )

static

Gets the path to the temporary directory.

Returns

The path to the temporary directory.

initialize()

void switchboard::SwitchboardSDK::initialize ( const std::string clientID, const std::string clientSecret )

static

Initializes the Switchboard SDK.

Parameters

clientID	The client ID value that identifies the user of the SDK.
clientSecret	The client secret ID.

isInitialized()

bool switchboard::SwitchboardSDK::isInitialized ( )

static

Gets whether the SDK has been initialized or not.

Returns

True if the SDK has been initialized, false otherwise.

setAppID()

void switchboard::SwitchboardSDK::setAppID ( const std::string & appID )

static

Sets the app's appID.

Parameters

appID

The app's ID.

setDeviceID()

void switchboard::SwitchboardSDK::setDeviceID ( const std::string & deviceID )

static

Sets the device's unique ID.

Parameters

deviceID

The device's ID.

setTemporaryDirectoryPath()

void switchboard::SwitchboardSDK::setTemporaryDirectoryPath ( const std::string & path )

static

Sets the path to the temporary directory.

Parameters

path	The path to the temporary directory.