2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

VoxeetSDK

The VoxeetSDK is the main object that allows the application to interact with Voxeet services. It is the entry point to call the embedded services and the static elements provided to the developers. The SDK is asynchronous and uses promise at its core.

Typical application workflow:

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 unique instance for a service that will be used (such as using the conference to retrieve the VTConferenceService instance).

Accessors

session

session: VTSessionService

Retrieves the unique VTSessionService instance, which enables the participant to use sessions.

Returns: VTSessionService

conference

conference: VTConferenceService

Retrieves the unique VTConferenceService instance, which enables the participant to interact with conferences.

Returns: VTConferenceService

recording

recording: VTRecordingService

Retrieves the unique VTRecordingService instance, which enables the participant to use the recording option.

This service wraps the recording related calls.

Returns: VTRecordingService

command

command: VTCommandService

Retrieves the unique VTCommandService instance, which enables the participant to send messages in a string shape into specified conferences.

Returns: VTCommandService

mediaDevice

mediaDevice: VTMediaDeviceService

Retrieves the unique VTMediaDeviceService instance, which enables the participant to interact with devices through the system.

Returns: VTMediaDeviceService

notification

notification: VTNotificationService

Retrieves the unique VTNotificationService instance, which enables forwarding notifications from a developer to a properly registered manager.

Returns: VTNotificationService

filePresentation

filePresentation: VTFilePresentationService

Retrieves the unique VTFilePresentationService instance, which enables the participant to use file presentations.

Returns: VTFilePresentationService

videoPresentation

videoPresentation: VTVideoPresentationService

Retrieves the unique VTVideoPresentationService instance, which enables the participant to use video presentations.

Returns: VTVideoPresentationService

Methods

shared

shared: VoxeetSDK

Accesses an SDK singleton from which SDK specific methods are available.

Returns: VoxeetSDK

initialize

initialize( consumerKey: String, consumerSecret: String)

Initializes Voxeet SDK and determines Voxeet SDK functions. It should be called as soon as possible.

Parameters

NameType
consumerKeyString
consumerSecretString

initialize

initialize( accessToken: String, refreshTokenClosure: VTSessionService.RefreshTokenHandler)

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.

Parameters

NameType
accessTokenString
refreshTokenClosureVTSessionService.RefreshTokenHandler