SignalingMessage

@Serializable
sealed interface SignalingMessage

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

Once the data channel is open, no further SignalingMessages flow — application bytes ride the data channel directly.

Inheritors

Types

Link copied to clipboard
@Serializable
@SerialName(value = "answer")
data class Answer(val sdp: String) : SignalingMessage
Link copied to clipboard
@Serializable
@SerialName(value = "bye")
data object Bye : SignalingMessage
Link copied to clipboard
@Serializable
@SerialName(value = "ice")
data class IceCandidate(val candidate: String, val sdpMid: String? = null, val sdpMLineIndex: Int? = null) : SignalingMessage
Link copied to clipboard
@Serializable
@SerialName(value = "offer")
data class Offer(val sdp: String) : SignalingMessage
Link copied to clipboard
@Serializable
@SerialName(value = "role")
data class Role(val host: Boolean) : SignalingMessage

Server-assigned role frame, sent once on attach before any offer/answer exchange. host is true for the first attacher (who runs the offerer path), false for the second (who runs the answerer path).