switchboard::SwitchboardSDK Class Reference

Initializes and configures the Switchboard SDK. More...

#include <SwitchboardSDK.hpp>

Static Public Member Functions
static WASM void	initialize (const char *appID, const char *appSecret)
static void	initialize (const std::string appID, const std::string appSecret)
static bool	isInitialized ()
static std::string	getVersionName ()
static uint	getBuildNumber ()
static std::string	getAPIUrl ()
static WASM std::string	getAppID ()
static WASM std::string	getAppSecret ()
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 app ID value that was used to initialize the SDK.

Returns

The app ID value.

getAppSecret()

std::string switchboard::SwitchboardSDK::getAppSecret ( )

static

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

Returns

The app secret value.

getBuildNumber()

uint switchboard::SwitchboardSDK::getBuildNumber ( )

static

Gets the build number of the SDK.

Returns

The build number of the SDK.

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.

getVersionName()

std::string switchboard::SwitchboardSDK::getVersionName ( )

static

Gets the version number of the SDK.

Returns

The version number of the SDK.

initialize()

void switchboard::SwitchboardSDK::initialize ( const std::string appID, const std::string appSecret )

static

Initializes the Switchboard SDK.

Parameters

appID	The app ID value that identifies the user of the SDK.
appSecret	The app 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.

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.