ConnectOptions

data class ConnectOptions(val autoSubscribe: Boolean = true, val iceServers: List<PeerConnection.IceServer>? = null, val rtcConfig: PeerConnection.RTCConfiguration? = null, val audio: Boolean = false, val video: Boolean = false, val protocolVersion: ProtocolVersion = ProtocolVersion.v12)

Options for using with Room.connect.

Constructors

Link copied to clipboard
constructor(autoSubscribe: Boolean = true, iceServers: List<PeerConnection.IceServer>? = null, rtcConfig: PeerConnection.RTCConfiguration? = null, audio: Boolean = false, video: Boolean = false, protocolVersion: ProtocolVersion = ProtocolVersion.v12)

Properties

Link copied to clipboard
val audio: Boolean = false

capture and publish audio track on connect, defaults to false

Link copied to clipboard

Auto subscribe to room tracks upon connect, defaults to true

Link copied to clipboard
val iceServers: List<PeerConnection.IceServer>? = null

A user-provided list of ice servers. This will be merged into the ice servers in rtcConfig if it is also provided.

Link copied to clipboard

the protocol version to use with the server.

Link copied to clipboard
val rtcConfig: PeerConnection.RTCConfiguration? = null

A user-provided RTCConfiguration to override options.

Link copied to clipboard
val video: Boolean = false

capture and publish video track on connect, defaults to false