VoxeetSDK

Suggest Edits

The VoxeetSDK is the main object that allows the application to interact with Voxeet services. The SDK is asynchronous and uses promise at its core.

The typical VoxeetSDK usage:

1. The application accesses the Voxeet SDK instance by calling the shared method.

2. The application initializes the Voxeet SDK through the initialize method.

3. The application uses the proper accessor to retrieve the proper instance. For example, the application uses the conference accessor to retrieve the VTConferenceService instance. Only after using the conference accessor, the application can use VTConferenceService.

Accessors

session

▸ session: VTSessionService

Retrieves the VTSessionService instance that allows the participant to use sessions.

Returns: VTSessionService

conference

▸ conference: VTConferenceService

Retrieves the VTConferenceService instance that allows the participant to interact with conferences.

Returns: VTConferenceService

recording

▸ recording: VTRecordingService

Retrieves the VTRecordingService instance that allows the participant to record conferences.

This service wraps the recording related calls.

Returns: VTRecordingService

command

▸ command: VTCommandService

Retrieves the VTCommandService instance that allows the participant to send messages to the specified conferences.

Returns: VTCommandService

mediaDevice

▸ mediaDevice: VTMediaDeviceService

Retrieves the VTMediaDeviceService instance that allows the participant to interact with devices through the system.

Returns: VTMediaDeviceService

notification

▸ notification: VTNotificationService

Retrieves the VTNotificationService instance that allows forwarding notifications from developers to the properly registered managers.

Returns: VTNotificationService

filePresentation

▸ filePresentation: VTFilePresentationService

Retrieves the VTFilePresentationService instance that allows the participant to use file presentations.

Returns: VTFilePresentationService

videoPresentation

▸ videoPresentation: VTVideoPresentationService

Retrieves the VTVideoPresentationService instance that allows the participant to use video presentations.

Returns: VTVideoPresentationService

Methods

shared

▸ shared: VoxeetSDK

Accesses the iOS SDK.

Returns: VoxeetSDK

initialize

▸ initialize( consumerKey: String, consumerSecret: String)

Initializes the SDK using the customer key and secret.

Parameters

Name	Type	Description
`consumerKey`	String	The customer key.
`consumerSecret`	String	The customer secret.

initialize

▸ initialize( accessToken: String, refreshTokenClosureWithParam: VTSessionService.RefreshTokenHandlerWithParam)

Initializes the SDK with the client access token provided by the Dolby.io platform. The client access token protects customer's conferences from unauthorized access and can be generated only by the Dolby.io platform via an application's authentication server and the client access token request.

The method requires providing two parameters - the client access token received from the Dolby.io platform and the refresh token callback. The callback must be a function that requests a new token and returns a promise containing the refreshed client access token when the token is incorrect or needs to be refreshed. The refresh token callback uses an isExpired boolean parameter to inform whether the currently used client access token is expired.

For more information, see the Accessing Dolby.io Platform guide.

Parameters

Name	Type	Description
`accessToken`	String	The access token provided by the customer's backend.
`refreshToken` `ClosureWithParam`	VTSessionService .RefreshTokenHandlerWithParam	A callback that returns a promise when the access token needs to be refreshed. The callback parameter takes the isExpired boolean parameter to check if the previous token has expired.

Updated 4 months ago