Skip to content

VoiceSignal

A WebRTC signal from a session of the user to another session of a voice chat room. An offer and an answer carry sdp and no candidate, a candidate carries candidate and no sdp, and a restart, which asks the other session to restart ICE, carries neither.

object
session
required

The session of the user’s join.

string
to
required

The session that receives the signal.

string
kind
required

The kind of a WebRTC signal.

string
Allowed values: offer answer candidate restart
sdp

The session description of an offer or an answer.

string
<= 16384 characters
candidate

An ICE candidate, as the JSON of an RTCIceCandidateInit with only candidate, sdpMid, sdpMLineIndex, and usernameFragment; candidate is empty (no more candidates) or a candidate: attribute on one line.

string
<= 16384 characters

Example generated

{
"session": "example",
"to": "example",
"kind": "offer",
"sdp": "example",
"candidate": "example"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site