Room

class Room

Room the user joined. Contains the local and remote participants with their media streams. Also exposes functions such as muting or toggling video. Raises RealtimeSdkListener events when participants join/leave or media streams change.

Functions

cameraFacingMode

fun cameraFacingMode(): String

Camera facing mode.

hasAudio

fun hasAudio(): Boolean

Check if user is sending audio.

hasHdVideo

fun hasHdVideo(): Boolean

Check if user is sending HD video.

hasVideo

fun hasVideo(): Boolean

Check if user is sending video.

isMuted

fun isMuted(): Boolean

Check if user is muted.

isVideoScaledDown

fun isVideoScaledDown(connectionId: String?): Boolean

Checks if video resolution is being scaled down for the given connection or all connections.

leave

suspend fun leave()

Leave the room.

localParticipant

fun localParticipant(): LocalParticipant

Local participant.

name

fun name(): String?

Room name.

remoteParticipants

fun remoteParticipants(): Array<RemoteParticipant>

Remote participants.

replaceVideoStream

fun replaceVideoStream(stream: MediaStream)

Replace the sending video stream.

roomId

fun roomId(): String?

Room identifier generated by the server.

scaleDownVideo

fun scaleDownVideo(enable: Boolean, connectionId: String?, width: Int?)

Enables/disables scaling down video resolution for a given connection or all connections.

sendMessageToParticipant

fun sendMessageToParticipant(message: String, address: String? = null)

Sends a message through the active data channel.

switchCamera

fun switchCamera()

Switch the camera between 'environment' and 'user'.

toggleAudio

fun toggleAudio(): Boolean

Toggle sending local audio.

toggleHdVideo

fun toggleHdVideo(): Boolean

Toggle between SD and HD if user is sending video.

toggleMute

fun toggleMute(): Boolean

Mute/unmute audio input.

toggleVideo

fun toggleVideo(hdVideo: Boolean = false): Boolean

Toggle sending local video.