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, @Singleton() closeableManager: CloseableManager, e2EEManagerFactory: E2EEManager.Factory) : RTCEngine.Listener, ParticipantListener

Types

Sid

@JvmInline()

value class Sid(sid: String)

State

enum State : Enum<Room.State>

Functions

connect

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

disconnect

fun disconnect()

Disconnect from the room.

getParticipant

fun getParticipant(sid: String): Participant?

getPublisherRTCStats

fun getPublisherRTCStats(callback: RTCStatsCollectorCallback)

Get stats for the publisher peer connection.

getSubscriberRTCStats

fun getSubscriberRTCStats(callback: RTCStatsCollectorCallback)

Get stats for the subscriber peer connection.

initVideoRenderer

fun initVideoRenderer(viewRenderer: TextureViewRenderer)

// TODO(@dl): can this be moved out of Room/SDK?

fun initVideoRenderer(viewRenderer: SurfaceViewRenderer)

// TODO(@dl): can this be moved out of Room/SDK?

onDataReceived

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

Received data published by another participant

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

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.

dynacast

var dynacast: Boolean = false

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

e2eeManager