livekit-android-sdk/io.livekit.android.room/Room

Room

class Room @AssistedInject constructor(@Assisted context: Context, engine: RTCEngine, eglBase: EglBase, localParticipantFactory: LocalParticipant.Factory, defaultsManager: DefaultsManager, @Named(value = "dispatcher_default") defaultDispatcher: CoroutineDispatcher, @Named(value = "dispatcher_io") ioDispatcher: CoroutineDispatcher, val audioHandler: AudioHandler, closeableManager: CloseableManager, e2EEManagerFactory: E2EEManager.Factory, communicationWorkaround: CommunicationWorkaround, val audioProcessingController: AudioProcessingController, val lkObjects: LKObjects, networkCallbackManagerFactory: NetworkCallbackManagerFactory, audioDeviceModule: AudioDeviceModule, regionUrlProviderFactory: RegionUrlProvider.Factory, connectionWarmer: ConnectionWarmer) : RTCEngine.Listener, ParticipantListener

Constructors

@AssistedInject

constructor(@Assisted context: Context, engine: RTCEngine, eglBase: EglBase, localParticipantFactory: LocalParticipant.Factory, defaultsManager: DefaultsManager, @Named(value = "dispatcher_default") defaultDispatcher: CoroutineDispatcher, @Named(value = "dispatcher_io") ioDispatcher: CoroutineDispatcher, audioHandler: AudioHandler, closeableManager: CloseableManager, e2EEManagerFactory: E2EEManager.Factory, communicationWorkaround: CommunicationWorkaround, audioProcessingController: AudioProcessingController, lkObjects: LKObjects, networkCallbackManagerFactory: NetworkCallbackManagerFactory, audioDeviceModule: AudioDeviceModule, regionUrlProviderFactory: RegionUrlProvider.Factory, connectionWarmer: ConnectionWarmer)

Types

@Serializable

value class Sid(val sid: String)

enum State : Enum<Room.State>

Properties

@FlowObservable

@get:FlowObservable

val activeSpeakers: List<Participant>

var adaptiveStream: Boolean

Automatically manage quality of subscribed video tracks, subscribe to the an appropriate resolution based on the size of the video elements that tracks are attached to.

val audioHandler: AudioHandler

audioProcessingController

val audioProcessingController: AudioProcessingController

audioProcessorIsEnabled

var audioProcessorIsEnabled: Boolean

audio processing is enabled

audioTrackCaptureDefaults

var audioTrackCaptureDefaults: LocalAudioTrackOptions

Default options to use when creating an audio track.

audioTrackPublishDefaults

var audioTrackPublishDefaults: AudioTrackPublishDefaults

Default options to use when publishing an audio track.

var dynacast: Boolean

Dynamically pauses video layers that are not being consumed by any subscribers, significantly reducing publishing CPU and bandwidth usage.

var e2eeManager: E2EEManager?

end-to-end encryption manager

var e2eeOptions: E2EEOptions?

Options for end-to-end encryption. Must be setup prior to connect.

val events: EventListenable<RoomEvent>

@FlowObservable

@get:FlowObservable

var isRecording: Boolean

val lkObjects: LKObjects

A holder for objects that are used internally within LiveKit.

localParticipant

val localParticipant: LocalParticipant

@FlowObservable

@get:FlowObservable

var metadata: String?

@FlowObservable

@get:FlowObservable

var name: String?

remoteParticipants

@FlowObservable

@get:FlowObservable

val remoteParticipants: Map<Participant.Identity, RemoteParticipant>

@FlowObservable

@get:FlowObservable

var sid: Room.Sid?

The session id of the room.

@FlowObservable

@get:FlowObservable

var state: Room.State

videoTrackCaptureDefaults

var videoTrackCaptureDefaults: LocalVideoTrackOptions

Default options to use when creating a video track.

videoTrackPublishDefaults

var videoTrackPublishDefaults: VideoTrackPublishDefaults

Default options to use when publishing a video track.

Functions

suspend fun connect(url: String, token: String, options: ConnectOptions = ConnectOptions()): Nothing?

Connect to a LiveKit Room.

fun disconnect()

Disconnect from the room.

getParticipantByIdentity

fun getParticipantByIdentity(identity: Participant.Identity): Participant?

fun getParticipantByIdentity(identity: String): Participant?

getParticipantBySid

fun getParticipantBySid(sid: Participant.Sid): Participant?

fun getParticipantBySid(sid: String): Participant?

getPublisherRTCStats

fun getPublisherRTCStats(callback: RTCStatsCollectorCallback)

Get stats for the publisher peer connection.

suspend fun getSid(): Room.Sid

Gets the sid of the room.

getSubscriberRTCStats

fun getSubscriberRTCStats(callback: RTCStatsCollectorCallback)

Get stats for the subscriber peer connection.

initVideoRenderer

fun initVideoRenderer(viewRenderer: TextureViewRenderer)

Initialize a TextureViewRenderer for rendering a video from this room.

fun initVideoRenderer(viewRenderer: SurfaceViewRenderer)

Initialize a SurfaceViewRenderer for rendering a video from this room.

open fun onDataReceived(data: ByteArray, participant: RemoteParticipant)

Received data published by another participant

onEngineResumed

open fun onEngineResumed()

onEngineResuming

open fun onEngineResuming()

onSpeakingChanged

open fun onSpeakingChanged(participant: Participant)

Fired when the current participant's isSpeaking property changes. (including LocalParticipant)

onTrackPublished

open fun onTrackPublished(publication: RemoteTrackPublication, participant: RemoteParticipant)

When a new track is published to room after the local participant has joined.

prepareConnection

suspend fun prepareConnection(url: String, token: String? = null)

prepareConnection should be called as soon as the page is loaded, in order to speed up the connection attempt. This function will

Release all resources held by this object.

setMicrophoneMute

fun setMicrophoneMute(muted: Boolean)

Control muting/unmuting the audio input.

fun setRoomOptions(options: RoomOptions)

Copies all the options to the Room object.

fun setSpeakerMute(muted: Boolean)

Control muting/unmuting all audio output.