ktor-client-webrtc/io.ktor.client.webrtc/WebRtcDataChannelOptions

WebRtcDataChannelOptions

Configuration options for creating a WebRTC data channel.

Constructors

constructor()

Properties

A 16-bit numeric ID for the channel; permitted values are 0 to 65534. If you don't include this option, the user agent will select an ID for you.

maxPacketLifeTime

var maxPacketLifeTime: Duration?

The maximum number of milliseconds that attempts to transfer a message may take in unreliable mode. Default: null.

maxRetransmits

var maxRetransmits: Int?

The maximum number of times the user agent should attempt to retransmit a message which fails the first time in unreliable mode. Default: null.

negotiated

var negotiated: Boolean

By default, (false), data channels are negotiated in-band, where one side calls WebRtcPeerConnection.createDataChannel, and the other side listens to the event using the WebRtcPeerConnection.createDataChannel event handler. Alternatively (true), they can be negotiated out of-band, where both sides call WebRtcPeerConnection.createDataChannel with an agreed-upon ID. Default: false.

ordered

var ordered: Boolean

Indicates whether messages sent on the WebRtcDataChannel are required to arrive at their destination in the same order in which they were sent (true), or if they're allowed to arrive out-of-order (false). Default: true.

protocol

var protocol: String

The name of the sub-protocol being used on the WebRtcDataChannel, if any; otherwise, the empty string (""). Default: empty string ("").

receiveOptions

var receiveOptions: DataChannelReceiveOptions.() -> Unit

Configurations for message receiver Channel.

WebRtcDataChannelOptions

See also

Constructors

Properties