social.colibri.beta.voice.defs
Details · defs
| Kind | defs |
|---|---|
| Authority | voice.beta.colibri.social |
| Indexed |
#ack
objectAnswers a heartbeat.
Properties
#callElsewhere
objectThe call in the requested channel runs on another node. Clients join it there.
Properties
The voice channel.
The node hosting the call.
Base URL for voice signaling on that node.
#closeProducer
objectCloses a producer this connection owns.
Properties
The producer to close.
#codecUnsupported
objectA viewer in the voice channel can't decode the video codec of this client's screen share. The client can produce the screen share again with a more widely supported codec. Sent at most once per producer, only to the client that owns it.
Properties
The screen share producer a viewer couldn't consume.
#connectTransport
objectCompletes DTLS negotiation for a transport this connection created.
Properties
The opaque mediasoup DTLS parameters blob.
The transport to connect.
#consume
objectStarts consuming another peer's producer on a receive transport this connection created.
Properties
The producer to consume.
This connection's opaque mediasoup RTP capabilities blob.
The receive transport to consume on.
#consumerOptions
objectParameters for consuming one producer.
Properties
The consumer's identifier.
The media kind.
knownValues: audio | video
The producer being consumed.
The opaque mediasoup RTP parameters blob.
#createTransport
objectRequests a new WebRTC transport for the joined channel.
Properties
Whether this transport will send or receive media.
knownValues: send | recv
#disconnected
objectThe server removed this client from the voice channel. Sent only to the client it applies to.
Properties
reason
stringWhy it happened. 'nodeClosed' means the node hosting the call shut down before the call could move. 'migrated' means the call moved to another node and this connection is no longer needed.
knownValues: moderator | superseded | channelGone | forbidden | nodeClosed | migrated
#error
objectSomething the client sent could not be acted on.
#getRtpCapabilities
objectRequests the router's RTP capabilities for the joined channel.
Properties
#heartbeat
objectKeeps the connection alive. The server answers with an ack.
Properties
#join
objectJoins a voice channel. A connection must join before sending any other frame, and joining a second channel leaves the first.
Properties
The voice channel to join.
#joined
objectConfirms this connection has joined a voice channel.
#leave
objectLeaves the voice channel this connection is joined to.
Properties
#migrateTo
objectThe call moves to another node. Clients join the same channel there, switch their media over, and then leave this node.
Properties
The voice channel.
The node the call moves to.
now
booleanTrue when a participant asked to move right away.
Base URL for voice signaling on that node.
#migrationCandidate
objectA voice node a call can move to.
Properties
Stable node identifier.
A cheap URL to measure the round trip to that node.
Region name.
Base URL for voice signaling on that node.
#migrationProposal
objectThis node is going offline and the call has to move. Clients measure the round trip to every candidate and answer with rttReport.
Properties
Voice nodes the call can move to.
When the call moves without further notice.
#moderationChanged
objectA peer's mute or deafen state changed, whether they did it themselves or a moderator did it to them.
Properties
Whether incoming audio is silenced, for any reason.
Whose state changed.
Whether the microphone is muted, for any reason.
serverDeafened
booleanWhether a moderator deafened them. When this is true the peer cannot undeafen themselves.
serverMuted
booleanWhether a moderator muted them. When this is true the peer cannot unmute themselves.
#moveNow
objectAsks the node to move the call to the chosen node right away, without waiting for the deadline.
Properties
#moved
objectA moderator moved this client to another voice channel. The server has already removed it from the previous one. Sent only to the client it applies to.
Properties
The voice channel to join.
#peerJoined
objectAnother peer joined the voice channel this connection is in.
Properties
Who joined.
#peerLeft
objectA peer left the voice channel this connection is in.
Properties
Who left.
#produce
objectStarts producing media on a send transport this connection created.
Properties
The media kind.
knownValues: audio | video
The opaque mediasoup RTP parameters blob.
What this producer captures.
knownValues: microphone | camera | screen
The send transport to produce on.
#producerInfo
objectA media producer available to consume.
#producerRemoved
objectA peer's producer closed.
Properties
Whose producer this was.
The producer that closed.
#resumeConsumer
objectResumes a consumer this connection created, which is created paused by default.
Properties
The consumer to resume.
#rtpCapabilities
objectThe RTP capabilities a WebRTC endpoint supports.
Properties
payload
unknownThe opaque mediasoup capability blob.
#rttReport
objectRound trips this client measured to the candidates of a migrationProposal.
Properties
One result per candidate.
#rttResult
objectOne measured round trip.
#setConsumerPreference
objectSets the highest simulcast or SVC layers a consumer this connection created should receive, and whether it should receive media at all. The server picks layers within the transport's bandwidth estimate and keeps a consumer paused while deafen silences it.
Properties
The consumer to update.
Whether the viewer wants this consumer paused, for example while its tile is off screen.
The highest spatial layer to receive, where 0 is the lowest resolution.
minimum: 0
temporalLayer
integerThe highest temporal layer to receive. When absent, the server uses the highest one available.
minimum: 0
#setSelfState
objectUpdates this connection's own mute or deafen state. An absent field leaves the current value unchanged.
#setSpeaking
objectReports whether this connection's user is speaking, as detected on their device. Once a connection sends this, the server stops detecting speech from its audio level. The server reports false while the user is muted.
Properties
Whether the user is currently speaking.
#speakingUpdate
objectA change in whether someone is currently speaking.
#transportOptions
objectParameters for creating one side of a WebRTC transport.
Properties
direction
stringWhich side of the call this transport carries.
knownValues: send | recv
The opaque mediasoup DTLS parameters blob.
The mediasoup ICE candidates, one opaque blob per candidate. This is an array, not a single object, because that is what a WebRTC transport hands back.
One opaque mediasoup ICE candidate.
The opaque mediasoup ICE parameters blob.
iceServers
arraySTUN and TURN servers the client should use while gathering candidates. Absent when the server has none configured.
One opaque RTCIceServer entry.
The transport's identifier.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Opens a WebSocket to the community hub AppView's embedded voice SFU (mediasoup) for a single voice channel. Bidirectional signaling: the client sends transport/produce/consume requests and the server replies and pushes producer and active-speaker events. Media itself flows over WebRTC (SRTP), not this socket. Requires service auth (aud = the community hub AppView's did:web, lxm = social.colibri.voice.signal), carried via the Sec-WebSocket-Protocol subprotocol as with subscribeEvents.