Switchboard

The top-level Switchboard object serves as the primary interface for interacting with the SDK instance. It provides access to various methods and properties that allow developers to configure, initialize, and manage the SDK's functionality. This object acts as the central point for the highest-level operations related to the Switchboard SDK.

Initializing the SDK

To initialize the Switchboard SDK, call the SwitchboardV3.initialize method and pass in a configuration map. The configuration map should include the parameters described in the Configuration section below.

The method returns the object ID of the SDK instance, which can be used in subsequent calls. Note that only one instance of the SDK can exist at a time.

C++

Config sdkConfig({
    { "appID", "demo" },
    { "appSecret", "demo" }
});
const Result<ObjectID> result = SwitchboardV3::initialize(sdkConfig);

Deinitializing the SDK

To deinitialize the Switchboard SDK, call the SwitchboardV3.deinitialize method. This will clean up all resources associated with the SDK, and any objects created by the SDK will be destroyed. It is important to ensure that the SDK is deinitialized when it is no longer needed to avoid resource leaks.

C++

const Result<void> result = SwitchboardV3::deinitialize();

Configuration

Name	Type	Description
appID	String	The app ID value of the integrating app.
appSecret	String	The app secret value of the integrating app.
tempDirPath	String	The path to the directory that can hold temporary files.

Values

Name	Type	Description
tempDirPath	String	The path to the directory that can hold temporary files.
logLevel	String	The logging level for the SDK. Possible values: none, error, warning, info, debug, trace.
appID (Read only)	String	The app ID value of the integrating app.
versionName (Read only)	String	The version name of the SDK.
buildNumber (Read only)	uint	The build number of the SDK.
maxNumberOfFrames (Read only)	uint	The maximum number of frames allowed.

Actions

This object does not provide any actions.

Events

This object does not provide any events.