videosdk-android-sdk/live.videosdk.rtc.android.lib

Package-level declarations

Types

Holds AudioDevice, the names of the audio routes. A route's name is the deviceId of its MicrophoneDeviceInfo, which is what Room.changeMic takes. It has no members of its own — there is never a reason to instantiate it.

BitrateMode

enum BitrateMode : Enum<BitrateMode>

How aggressively a video track spends the uplink, chosen per track when it is created with VideoSDK.createCameraVideoTrack.

CallType

enum CallType : Enum<CallType>

Which way a cellular call on the device was placed.

EntryDecision

enum EntryDecision : Enum<EntryDecision>

The answer to a waiting participant's entry request, sent with Room.respondEntry.

HLSState

enum HLSState : Enum<HLSState>

Where an HLS stream stands, as RoomEventListener.onHlsStateChanged reports it and Room.hlsState holds it.

LeaveReason

enum LeaveReason : Enum<LeaveReason>

Why a participant left a room, delivered by RoomEventListener.onRoomLeft for the local participant and RoomEventListener.onParticipantLeft for everyone else.

LiveStreamState

enum LiveStreamState : Enum<LiveStreamState>

Where a livestream stands, as RoomEventListener.onLivestreamStateChanged reports it and Room.liveStreamState holds it.

Mode

enum Mode : Enum<Mode>

How a participant takes part in a room, as VideoSDK.createRoom and Room.changeMode take it and Participant.mode reports it.

NoiseConfig

@Immutable

data class NoiseConfig(val noiseSuppression: Boolean? = true, val echoCancellation: Boolean? = true, val autoGainControl: Boolean? = true, val highPassFilter: Boolean? = false)

Audio-processing switches for a microphone track, passed to VideoSDK.createMicrophoneAudioTrack.

PubSubMessage

class PubSubMessage

One message delivered on a PubSub topic, through PubSubMessageListener.

QualityLimitationState

enum QualityLimitationState : Enum<QualityLimitationState>

Which edge of a quality limitation this event marks. Each QualityLimitationType fires once on entry and once on exit, never repeatedly while the condition lasts.

QualityLimitationType

enum QualityLimitationType : Enum<QualityLimitationType>

Why the media this device is sending is being held back, reported by RoomEventListener.onQualityLimitation.

RecordingState

enum RecordingState : Enum<RecordingState>

Where cloud recording stands, as RoomEventListener.onRecordingStateChanged reports it and Room.recordingState holds it.

RelayDecision

enum RelayDecision : Enum<RelayDecision>

How the destination room answered a Room.requestMediaRelay request.

RoomState

enum RoomState : Enum<RoomState>

Where the room's connection stands, as reported by RoomEventListener.onRoomStateChanged and readable at any time from Room.roomState.

StreamState

enum StreamState : Enum<StreamState>

Health of a remote video or screen-share stream, delivered to the listener set with RTCStream.setOnStreamStateChangedListener.

VideoSDKError

class VideoSDKError(val code: Int, val name: String, val message: String)

Every error the SDK can report, and the code you match on to handle it.

VideoSDKException

open class VideoSDKException(val code: Int, val name: String, message: String) : RuntimeException

Thrown when an action is refused or fails — by the suspending methods on Room, Participant and RTCStream, and by the VideoSDK methods whose docs list it.