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, audioHandler: AudioHandler, closeableManager: CloseableManager, e2EEManagerFactory: E2EEManager.Factory, communicationWorkaround: CommunicationWorkaround, audioProcessingController: AudioProcessingController, lkObjects: LKObjects, networkCallbackManagerFactory: NetworkCallbackManagerFactory) : RTCEngine.Listener, ParticipantListener

Types

Sid

@Serializable()

@JvmInline()

value class Sid(sid: String)

State

enum State : Enum<Room.State>

Functions

connect

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

Connect to a LiveKit Room.

disconnect

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.

getSid

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.

onDataReceived

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.

onTrackPublished

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

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

release

fun release()

Release all resources held by this object.

Properties

activeSpeakers

@FlowObservable()

val activeSpeakers: List<Participant>

adaptiveStream

var adaptiveStream: Boolean = false

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.

audioHandler

val audioHandler: AudioHandler

audioProcessingController

val audioProcessingController: AudioProcessingController

audioProcessorIsEnabled

var audioProcessorIsEnabled: Boolean = false

audio processing is enabled

audioTrackCaptureDefaults

var audioTrackCaptureDefaults: LocalAudioTrackOptions

Default options to use when creating an audio track.

audioTrackPublishDefaults

var audioTrackPublishDefaults: AudioTrackPublishDefaults