zn-android-sdk/live.videosdk.rtc.android/VideoSDK

VideoSDK

The main entry point for the VideoSDK. Use this class to initialize the SDK, configure authentication, create meetings, and manage media tracks.

VideoSDK provides methods for:

Initializing the underlying real-time communication engine
Storing and validating the authentication token
Creating and configuring Meeting instances
Creating custom audio and video tracks
Handling pre-call permissions and device discovery
Managing audio device selection and change events
Configuring SDK logging

Code Example:


// 1. Initialize (once, in Application or Activity)
VideoSDK.initialize(applicationContext)

// 2. Configure authentication token
VideoSDK.config("YOUR_TOKEN")

// 3. Create a meeting
val meeting = VideoSDK.initMeeting(
    context,              // Android context
    "meetingId",          // meeting ID
    "John Doe",           // display name
    true,                 // mic enabled
    true,                 // webcam enabled
    null,                 // participant ID (auto-generated)
    "SEND_AND_RECV",      // mode
    true,                 // multi-stream (simulcast)
    null,                 // custom tracks
    null                  // metadata
)

// 4. Join
meeting.join()

Constructors

constructor()

Types

AudioDeviceChangeEvent

interface AudioDeviceChangeEvent

Listener interface for audio device changes.

CustomTrackListener

interface CustomTrackListener

Listener interface for asynchronous custom track creation.

PreferredProtocol

enum PreferredProtocol

Defines the preferred network protocol for media transmission.

Properties

var bitrateMode: BitrateMode

Bitrate mode for video encoding.

val errorCodes: JSONObject

A JSON object containing all SDK error codes and their descriptions.

var maxLayer: Integer

Maximum number of simulcast layers for video tracks.

selectedAudioDevice

var selectedAudioDevice: AudioDeviceInfo

The currently selected audio input device.

selectedVideoDevice

var selectedVideoDevice: VideoDeviceInfo

The currently selected video (camera) device.

val token: String

The authentication token used for API requests and meeting creation.

val videoDevices: Set<VideoDeviceInfo>

The set of available video (camera) devices detected on this device.

Functions

applyVideoProcessor

fun applyVideoProcessor(videoFrameProcessor: VideoFrameProcessor)

Applies a video frame processor to the outgoing video stream.

checkPermissions

fun checkPermissions(context: Context, permission: List<Permission>, permissionHandler: PermissionHandler)

Checks and requests runtime permissions required by the SDK, without a rationale message or custom dialog options.

fun checkPermissions(context: Context, permission: List<Permission>, rationale: String, permissionHandler: PermissionHandler)

Checks and requests permissions with a rationale message.

fun checkPermissions(context: Context, permission: List<Permission>, options: Permissions.Options, permissionHandler: PermissionHandler)

Checks and requests permissions with custom options.

fun checkPermissions(context: Context, permission: List<Permission>, rationale: String, options: Permissions.Options, permissionHandler: PermissionHandler)

Checks and requests runtime permissions with a rationale message and custom dialog options.

fun config(token: String)

Configures the authentication token for the SDK.

createAudioTrack

fun createAudioTrack(encoderConfig: String, context: Context): CustomStreamTrack

Creates a custom audio track with the specified encoder configuration.

createCameraVideoTrack

fun createCameraVideoTrack(encoderConfig: String, facingMode: String, optimizationMode: CustomStreamTrack.VideoMode, multiStream: Boolean, context: Context, videoDeviceInfo: VideoDeviceInfo): CustomStreamTrack

fun createCameraVideoTrack(encoderConfig: String, facingMode: String, optimizationMode: CustomStreamTrack.VideoMode, multiStream: Boolean, context: Context, videoDeviceInfo: VideoDeviceInfo, maxLayer: Integer): CustomStreamTrack

fun createCameraVideoTrack(encoderConfig: String, facingMode: String, optimizationMode: CustomStreamTrack.VideoMode, multiStream: Boolean, context: Context, videoDeviceInfo: VideoDeviceInfo, bitrateMode: BitrateMode): CustomStreamTrack

fun createCameraVideoTrack(encoderConfig: String, facingMode: String, optimizationMode: CustomStreamTrack.VideoMode, multiStream: Boolean, context: Context, observer: CapturerObserver, videoDeviceInfo: VideoDeviceInfo): CustomStreamTrack

fun createCameraVideoTrack(encoderConfig: String, facingMode: String, optimizationMode: CustomStreamTrack.VideoMode, multiStream: Boolean, context: Context, videoDeviceInfo: VideoDeviceInfo, maxLayer: Integer, bitrateMode: BitrateMode): CustomStreamTrack

Creates a custom camera video track with full control over simulcast layers and bitrate mode.

createScreenShareVideoTrack

@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)

fun createScreenShareVideoTrack(encoderConfig: String, data: Intent, context: Context, listener: VideoSDK.CustomTrackListener)

Creates a screen share video track asynchronously.

getAudioDevices

fun getAudioDevices(): Set<AudioDeviceInfo>

Returns all available audio devices (speaker, earpiece, bluetooth, etc.).

fun getDevices(): Set<DeviceInfo>

Returns all available media devices (both audio and video).

fun getLogLevel(): LogLevel

Returns the current log level that controls the verbosity of client-facing Logcat output.

fun initialize(context: Context)

Initializes the VideoSDK.

fun initMeeting(context: Context, meetingId: String, name: String, micEnabled: Boolean, webcamEnabled: Boolean, @Nullable participantId: String, mode: String, multiStream: Boolean, customTracks: Map<String, CustomStreamTrack>, metaData: JSONObject): Meeting

fun initMeeting(context: Context, meetingId: String, name: String, micEnabled: Boolean, webcamEnabled: Boolean, @Nullable participantId: String, mode: String, multiStream: Boolean, customTracks: Map<String, CustomStreamTrack>, metaData: JSONObject, @Nullable signalingBaseUrl: String): Meeting

fun initMeeting(context: Context, meetingId: String, name: String, micEnabled: Boolean, webcamEnabled: Boolean, @Nullable participantId: String, mode: String, multiStream: Boolean, customTracks: Map<String, CustomStreamTrack>, metaData: JSONObject, @Nullable preferredProtocol: VideoSDK.PreferredProtocol): Meeting

fun initMeeting(context: Context, meetingId: String, name: String, micEnabled: Boolean, webcamEnabled: Boolean, @Nullable participantId: String, mode: String, multiStream: Boolean, customTracks: Map<String, CustomStreamTrack>, metaData: JSONObject, @Nullable signalingBaseUrl: String, @Nullable preferredProtocol: VideoSDK.PreferredProtocol): Meeting

Initializes and returns a Meeting instance configured with the provided parameters.

removeVideoProcessor

fun removeVideoProcessor()

Removes the currently applied video frame processor.

setActivityForLifeCycle

fun setActivityForLifeCycle(@NonNull activity: Activity)

Sets the activity to be used for lifecycle-based webcam management.

setAudioDeviceChangeListener

fun setAudioDeviceChangeListener(audioDeviceChangeEvent: VideoSDK.AudioDeviceChangeEvent)

Registers a listener for audio device change events.

fun setDebugMode(debugMode: Boolean)

Enables or disables debug mode for the SDK.

setEnableActivityLifecycle

fun setEnableActivityLifecycle(enableActivityLifecycle: Boolean)

Enables or disables automatic webcam management based on activity lifecycle.

fun setLogLevel(level: LogLevel)

Set the log level for SDK tracing.