ktor-client-webrtc/io.ktor.client.webrtc/WebRtc

WebRtc

An object containing WebRtc protocol entities and abstractions. Provides the core types and interfaces needed for WebRtc peer-to-peer communication.

Types

BundlePolicy

enum BundlePolicy : Enum<WebRtc.BundlePolicy>

Represents the bundle policy for media negotiation.

ConnectionState

enum ConnectionState : Enum<WebRtc.ConnectionState>

Represents the state of the peer connection.

DataChannel

interface DataChannel : AutoCloseable

Abstract class representing a network channel which can be used for bidirectional peer-to-peer transfers of arbitrary data. Every data channel is associated with an WebRtcPeerConnection.

DegradationPreference

enum DegradationPreference : Enum<WebRtc.DegradationPreference>

Represents the degradation preference for media quality when bandwidth is constrained.

DtmfSender

interface DtmfSender

Interface for sending DTMF (Dual-Tone Multi-Frequency) tones.

IceCandidate

@Serializable

data class IceCandidate(val candidate: String, val sdpMid: String, val sdpMLineIndex: Int)

Represents an ICE candidate in the WebRtc connection process.

IceConnectionState

enum IceConnectionState : Enum<WebRtc.IceConnectionState>

Represents the state of the ICE connection.

IceException

class IceException(message: String?, cause: Throwable? = null) : RuntimeException

This exception indicates problems with ICE candidates gathering, processing, or connectivity during the WebRTC peer connection establishment.

IceGatheringState

enum IceGatheringState : Enum<WebRtc.IceGatheringState>

Represents the state of the ICE gathering process.

IceServer

data class IceServer(val urls: String, val username: String? = null, val credential: String? = null)

Represents an ICE server configuration for WebRtc connections.

IceTransportPolicy

enum IceTransportPolicy : Enum<WebRtc.IceTransportPolicy>

Represents the ICE candidate policy for the connection.

RtcpMuxPolicy

enum RtcpMuxPolicy : Enum<WebRtc.RtcpMuxPolicy>

Represents the RTCP mux policy for the connection.

RtpHeaderExtensionParameters

data class RtpHeaderExtensionParameters(val id: Int, val uri: String, val encrypted: Boolean)

Represents parameters for RTP header extensions.

RtpParameters

interface RtpParameters

Interface representing parameters for RTP transmission.

RtpSender

interface RtpSender

Interface for sending RTP media.

SdpException

class SdpException(message: String?, cause: Throwable? = null) : RuntimeException

This exception indicates problems with creating, parsing, or validating SDP descriptions during the WebRTC connection establishment process.

SessionDescription

@Serializable

data class SessionDescription(val type: WebRtc.SessionDescriptionType, val sdp: String)

Represents a session description in the WebRtc connection process.

SessionDescriptionType

@Serializable

enum SessionDescriptionType : Enum<WebRtc.SessionDescriptionType>

Represents the type of session description in the WebRtc connection process.

SignalingState

enum SignalingState : Enum<WebRtc.SignalingState>

Represents the signaling state of the peer connection.

Stats

data class Stats(val id: String, val type: String, val timestamp: Long, val props: Map<String, Any?>)

Represents statistics about the WebRtc connection.

WebRtc

See also

Types