NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

VoxeetSDK

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

NameTypeDescription
consumerKeyStringThe customer key.
consumerSecretStringThe customer secret.

initialize

▸ initializeaccessToken: String, refreshTokenClosureWithParam: VTSessionService.RefreshTokenHandlerWithParam)

Initializes the Voxeet SDK and invokes the SDK with a third-party authentication feature. This method determines Voxeet SDK functions. It should be called as soon as possible. The refreshTokenClosureWithParam parameter takes the isExpired boolean parameter to check if the previous token has expired.

Parameters

NameTypeDescription
accessTokenStringThe 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.

Did this page help you?