Package-level declarations

Types

Link copied to clipboard
data class IceConfig(val iceServers: List<IceServer>, val iceTransportPolicy: IceTransportPolicy = IceTransportPolicy.All)

ICE configuration handed to the browser's RTCPeerConnection.

Link copied to clipboard
sealed interface IceServer
Link copied to clipboard

Out-of-band channel used to exchange SignalingMessages between two WebRTC endpoints during bootstrap. The library does not specify how messages get from one endpoint to the other — that is the implementation's concern (e.g. WebSocket relay, QR code, BroadcastChannel).

Link copied to clipboard
@Serializable
sealed interface SignalingMessage

Wire-format messages exchanged between two WebRTC peers via the SignalingChannel during connection bootstrap.

Link copied to clipboard

JSON codec for SignalingMessage. The wire form uses a "type" discriminator (offer / answer / ice / bye / role).

Link copied to clipboard

One end of an open signaling exchange. Carries messages in both directions until close is called or the peer disconnects.