SwitchboardSDK/com.synervoz.switchboard.sdk/Switchboard

Switchboard

object Switchboard

Entry point for the Switchboard SDK.

Provides methods to initialize the SDK, create and control audio engines, read and write object properties, and subscribe to events. Objects (the engine and the nodes within it) are referenced by their string ObjectID. Every method returns a SwitchboardResult describing success or failure.

Properties

val gson: Gson

Functions

addEventListener

fun addEventListener(objectId: ObjectID, eventName: String, callback: SwitchboardEventCallback): SwitchboardResult<ListenerID>

fun addEventListener(objectId: ObjectID, eventName: String, callback: (eventName: String, eventData: Any?) -> Unit): SwitchboardResult<ListenerID>

Adds an event listener for the specified event on the object with the given object ID.

fun callAction(objectId: ObjectID, actionName: String, params: Map<String, Any> = emptyMap()): SwitchboardResult<String>

Calls an action on the object with the specified object ID.

fun createEngine(configJson: String): SwitchboardResult<ObjectID>

Creates an engine with the given JSON configuration.

fun createEngine(config: Map<String, Any>): SwitchboardResult<ObjectID>

Creates an engine with the given configuration.

fun deinitialize(): SwitchboardResult<Unit>

Deinitializes the Switchboard SDK, releasing the resources it holds.

fun destroyEngine(objectId: ObjectID): SwitchboardResult<Unit>

Destroys the engine with the given object ID, releasing its resources.

fun getValue(objectId: ObjectID, key: String): SwitchboardResult<Any?>

Gets the value for the given key from the object with the specified object ID.

fun initialize(context: Context, config: Map<String, Any>): SwitchboardResult<Unit>

Initializes the Switchboard SDK with the given configuration.

fun initialize(context: Context, appId: String, appSecret: String, extensions: Map<String, Any> = emptyMap()): SwitchboardResult<Unit>

Initializes the Switchboard SDK with the given credentials and extensions.

loadExtensionLibrary

fun loadExtensionLibrary(libraryName: String): Boolean

Loads a native extension library.

removeEventListener

fun removeEventListener(objectId: ObjectID, callbackId: ListenerID): SwitchboardResult<Unit>

Removes an event listener with the specified listener ID from the object with the given object ID.

fun setValue(objectId: ObjectID, key: String, value: Any): SwitchboardResult<Unit>

Sets the value for the given key on the object with the specified object ID.