2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

VoxeetSDK

VoxeetSDK is the main object providing methods that interact with the Voxeet service. 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 instance method.

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

3. The application uses the proper method to retrieve the unique instance for a service that will be used (such as using the conference method to retrieve the ConferenceService instance).

4. To use the EventBus, the application calls the getEventBus method to retrieve its unique instance. Then, it calls the register method to register the object into the EventBus and the unregister to unregister from the instance.

Available in the package com.voxeet.VoxeetSDK.

Methods

instance

instance(): VoxeetSDK

Accesses the instance of the SDK which enables to use methods specific for the SDK. Services are available using static methods.

Note: Every service method can return a null object if the SDK is initialized for the first time.

Returns: @NonNull VoxeetSDK - The SDK instance if the static initialize method was called.

initialize

initialize(@NonNull appId: String, @NonNull password: String): void

Initializes the Voxeet SDK. This function determines Voxeet SDK functions. It should be called as soon as possible.

Parameters

NameTypeDescription
appIdStringnon null application ID
passwordStringnon null password

initialize

initialize(@NonNull accessToken: String, @NonNull refreshToken: RefreshTokenCallback): void

Initializes the Voxeet SDK. This function invokes the SDK with a third-party authentication feature. It determines Voxeet SDK functions, so it should be called as soon as possible.

Parameters

NameTypeDescription
accessTokenStringnon null default accessToken
refreshTokenRefreshTokenCallbacknon null refreshToken callback

conference

conference(): ConferenceService

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

Returns: @NonNull ConferenceService - With an initialized SDK, the instance of the ConferenceService.

mediaDevice

mediaDevice(): MediaDeviceService

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

Returns: @NonNull MediaDeviceService - With an initialized SDK, the instance of the MediaDeviceService.

screenShare

screenShare(): ScreenShareService

Retrieves the unique ScreenShareService instance which enables the participant to use the screen sharing option.

Returns: @NonNull ScreenShareService - With an initialized SDK, the instance of the ScreenShareService.

session

session(): SessionService

Retrieves the unique SessionService instance which enables the participant to use sessions.

Returns: @NonNull SessionService - With an initialized SDK, the instance of the SessionService.

filePresentation

filePresentation(): FilePresentationService

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

Returns: @NonNull FilePresentationService - With an initialized SDK, the instance of the FilePresentationService.

videoPresentation

videoPresentation(): VideoPresentationService

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

The UXKit also provides components extending this service with automatic injection of various plugins such as Youtube or MP4.

Returns: @NonNull VideoPresentationService - With an initialized SDK, the instance of the VideoPresentationService.

audio

audio(): AudioService

Retrieves the unique AudioService instance which enables the participant to manage the audio connection.

Returns: @NonNull AudioService - With an initialized SDK, the instance of the AudioService.

recording

recording(): RecordingService

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

This service wraps the recording related calls.

Returns: @NonNull RecordingService - With an initialized SDK, the instance of the RecordingService.

command

command(): CommandService

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

Returns: @NonNull CommandService - With an initialized SDK, the instance of the CommandService.

notification

notification(): NotificationService

Retrieves the unique NotificationService instance which enables forwarding notifications from developer to the properly registered manager.

Returns: @NonNull NotificationService - With an initialized SDK, the instance of the NotificationService.

getEventBus

getEventBus(): EventBus

Retrieves the instance of EventBus used by the SDK.

Returns: @NonNull EventBus - The instance of the EventBus used internally.

register

register(@Nullable subscriber: Object): boolean

Registers object into the EventBus of the SDK. Call this method before creating or joining any conference to trigger events.

Parameters

NameTypeDescription
subscriberObjectnullable subscriber

Returns: boolean

unregister

unregister(@NonNull subscriber: Object): void

Unregisters from the EventBus instance. Call this method to remove your Activity or Fragment.

Parameters

NameTypeDescription
subscriberObjectnon null subscriber

region

region(@NonNull region: String): void

Change the region used by the VoxeetSdk. This method must be used outside of any connected sessions.

Parameters

NameTypeDescription
regionStringnon null