social.colibri.beta.voice.defs

colibri.social

Documentation

ack object

Answers a heartbeat.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Answers a heartbeat."
}
closeProducer object

Closes a producer this connection owns.

Properties

producerId string Required

The producer to close.

View raw schema 
{
  "type": "object",
  "required": [
    "producerId"
  ],
  "properties": {
    "producerId": {
      "type": "string",
      "description": "The producer to close."
    }
  },
  "description": "Closes a producer this connection owns."
}
connectTransport object

Completes DTLS negotiation for a transport this connection created.

Properties

dtlsParameters unknown Required

The opaque mediasoup DTLS parameters blob.

transportId string Required

The transport to connect.

View raw schema 
{
  "type": "object",
  "required": [
    "transportId",
    "dtlsParameters"
  ],
  "properties": {
    "transportId": {
      "type": "string",
      "description": "The transport to connect."
    },
    "dtlsParameters": {
      "type": "unknown",
      "description": "The opaque mediasoup DTLS parameters blob."
    }
  },
  "description": "Completes DTLS negotiation for a transport this connection created."
}
consume object

Starts consuming another peer's producer on a receive transport this connection created.

Properties

producerId string Required

The producer to consume.

rtpCapabilities unknown Required

This connection's opaque mediasoup RTP capabilities blob.

transportId string Required

The receive transport to consume on.

View raw schema 
{
  "type": "object",
  "required": [
    "transportId",
    "producerId",
    "rtpCapabilities"
  ],
  "properties": {
    "producerId": {
      "type": "string",
      "description": "The producer to consume."
    },
    "transportId": {
      "type": "string",
      "description": "The receive transport to consume on."
    },
    "rtpCapabilities": {
      "type": "unknown",
      "description": "This connection's opaque mediasoup RTP capabilities blob."
    }
  },
  "description": "Starts consuming another peer's producer on a receive transport this connection created."
}
consumerOptions object

Parameters for consuming one producer.

Properties

id string Required

The consumer's identifier.

kind string Required

The media kind.

Known values: audio, video
producerId string Required

The producer being consumed.

rtpParameters unknown Required

The opaque mediasoup RTP parameters blob.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "producerId",
    "kind",
    "rtpParameters"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The consumer's identifier."
    },
    "kind": {
      "type": "string",
      "description": "The media kind.",
      "knownValues": [
        "audio",
        "video"
      ]
    },
    "producerId": {
      "type": "string",
      "description": "The producer being consumed."
    },
    "rtpParameters": {
      "type": "unknown",
      "description": "The opaque mediasoup RTP parameters blob."
    }
  },
  "description": "Parameters for consuming one producer."
}
createTransport object

Requests a new WebRTC transport for the joined channel.

Properties

direction string Required

Whether this transport will send or receive media.

Known values: send, recv
View raw schema 
{
  "type": "object",
  "required": [
    "direction"
  ],
  "properties": {
    "direction": {
      "type": "string",
      "description": "Whether this transport will send or receive media.",
      "knownValues": [
        "send",
        "recv"
      ]
    }
  },
  "description": "Requests a new WebRTC transport for the joined channel."
}
disconnected object

The server removed this client from the voice channel. Sent only to the client it applies to.

Properties

reason string Optional

Why it happened.

Known values: moderator, superseded, channelGone
View raw schema 
{
  "type": "object",
  "required": [],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Why it happened.",
      "knownValues": [
        "moderator",
        "superseded",
        "channelGone"
      ]
    }
  },
  "description": "The server removed this client from the voice channel. Sent only to the client it applies to."
}
error object

Something the client sent could not be acted on.

Properties

error string Required

Error name.

Known values: InvalidFrame, NotJoined, ChannelNotFound, NotVoiceChannel, Forbidden, NotFound
message string Optional

Human-readable detail.

View raw schema 
{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "string",
      "description": "Error name.",
      "knownValues": [
        "InvalidFrame",
        "NotJoined",
        "ChannelNotFound",
        "NotVoiceChannel",
        "Forbidden",
        "NotFound"
      ]
    },
    "message": {
      "type": "string",
      "description": "Human-readable detail."
    }
  },
  "description": "Something the client sent could not be acted on."
}
getRtpCapabilities object

Requests the router's RTP capabilities for the joined channel.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Requests the router's RTP capabilities for the joined channel."
}
heartbeat object

Keeps the connection alive. The server answers with an ack.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Keeps the connection alive. The server answers with an ack."
}
join object

Joins a voice channel. A connection must join before sending any other frame, and joining a second channel leaves the first.

Properties

channel string space-ref Required

The voice channel to join.

View raw schema 
{
  "type": "object",
  "required": [
    "channel"
  ],
  "properties": {
    "channel": {
      "type": "string",
      "format": "space-ref",
      "description": "The voice channel to join."
    }
  },
  "description": "Joins a voice channel. A connection must join before sending any other frame, and joining a second channel leaves the first."
}
joined object

Confirms this connection has joined a voice channel.

Properties

channel string space-ref Required

The voice channel now joined.

View raw schema 
{
  "type": "object",
  "required": [
    "channel"
  ],
  "properties": {
    "channel": {
      "type": "string",
      "format": "space-ref",
      "description": "The voice channel now joined."
    }
  },
  "description": "Confirms this connection has joined a voice channel."
}
leave object

Leaves the voice channel this connection is joined to.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "required": [],
  "properties": {},
  "description": "Leaves the voice channel this connection is joined to."
}
moderationChanged object

A peer's mute or deafen state changed, whether they did it themselves or a moderator did it to them.

Properties

deafened boolean Required

Whether incoming audio is silenced, for any reason.

did string did Required

Whose state changed.

muted boolean Required

Whether the microphone is muted, for any reason.

serverDeafened boolean Optional

Whether a moderator deafened them. When this is true the peer cannot undeafen themselves.

serverMuted boolean Optional

Whether a moderator muted them. When this is true the peer cannot unmute themselves.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "muted",
    "deafened"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Whose state changed."
    },
    "muted": {
      "type": "boolean",
      "description": "Whether the microphone is muted, for any reason."
    },
    "deafened": {
      "type": "boolean",
      "description": "Whether incoming audio is silenced, for any reason."
    },
    "serverMuted": {
      "type": "boolean",
      "description": "Whether a moderator muted them. When this is true the peer cannot unmute themselves."
    },
    "serverDeafened": {
      "type": "boolean",
      "description": "Whether a moderator deafened them. When this is true the peer cannot undeafen themselves."
    }
  },
  "description": "A peer's mute or deafen state changed, whether they did it themselves or a moderator did it to them."
}
peerJoined object

Another peer joined the voice channel this connection is in.

Properties

did string did Required

Who joined.

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Who joined."
    }
  },
  "description": "Another peer joined the voice channel this connection is in."
}
peerLeft object

A peer left the voice channel this connection is in.

Properties

did string did Required

Who left.

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Who left."
    }
  },
  "description": "A peer left the voice channel this connection is in."
}
produce object

Starts producing media on a send transport this connection created.

Properties

kind string Required

The media kind.

Known values: audio, video
rtpParameters unknown Required

The opaque mediasoup RTP parameters blob.

source string Required

What this producer captures.

Known values: microphone, camera, screen
transportId string Required

The send transport to produce on.

View raw schema 
{
  "type": "object",
  "required": [
    "transportId",
    "kind",
    "rtpParameters",
    "source"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "description": "The media kind.",
      "knownValues": [
        "audio",
        "video"
      ]
    },
    "source": {
      "type": "string",
      "description": "What this producer captures.",
      "knownValues": [
        "microphone",
        "camera",
        "screen"
      ]
    },
    "transportId": {
      "type": "string",
      "description": "The send transport to produce on."
    },
    "rtpParameters": {
      "type": "unknown",
      "description": "The opaque mediasoup RTP parameters blob."
    }
  },
  "description": "Starts producing media on a send transport this connection created."
}
producerInfo object

A media producer available to consume.

Properties

did string did Required

Who is producing this media.

kind string Required

The media kind.

Known values: audio, video
paused boolean Optional

Whether the producer is currently paused.

producerId string Required

The producer's identifier.

source string Optional

What the producer captures.

Known values: microphone, camera, screen
View raw schema 
{
  "type": "object",
  "required": [
    "producerId",
    "did",
    "kind"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Who is producing this media."
    },
    "kind": {
      "type": "string",
      "description": "The media kind.",
      "knownValues": [
        "audio",
        "video"
      ]
    },
    "paused": {
      "type": "boolean",
      "description": "Whether the producer is currently paused."
    },
    "source": {
      "type": "string",
      "description": "What the producer captures.",
      "knownValues": [
        "microphone",
        "camera",
        "screen"
      ]
    },
    "producerId": {
      "type": "string",
      "description": "The producer's identifier."
    }
  },
  "description": "A media producer available to consume."
}
producerRemoved object

A peer's producer closed.

Properties

did string did Required

Whose producer this was.

producerId string Required

The producer that closed.

View raw schema 
{
  "type": "object",
  "required": [
    "producerId",
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Whose producer this was."
    },
    "producerId": {
      "type": "string",
      "description": "The producer that closed."
    }
  },
  "description": "A peer's producer closed."
}
resumeConsumer object

Resumes a consumer this connection created, which is created paused by default.

Properties

consumerId string Required

The consumer to resume.

View raw schema 
{
  "type": "object",
  "required": [
    "consumerId"
  ],
  "properties": {
    "consumerId": {
      "type": "string",
      "description": "The consumer to resume."
    }
  },
  "description": "Resumes a consumer this connection created, which is created paused by default."
}
rtpCapabilities object

The RTP capabilities a WebRTC endpoint supports.

Properties

payload unknown Optional

The opaque mediasoup capability blob.

View raw schema 
{
  "type": "object",
  "properties": {
    "payload": {
      "type": "unknown",
      "description": "The opaque mediasoup capability blob."
    }
  },
  "description": "The RTP capabilities a WebRTC endpoint supports."
}
setSelfState object

Updates this connection's own mute or deafen state. An absent field leaves the current value unchanged.

Properties

deafened boolean Optional

Whether incoming audio is silenced.

muted boolean Optional

Whether the microphone is muted.

View raw schema 
{
  "type": "object",
  "required": [],
  "properties": {
    "muted": {
      "type": "boolean",
      "description": "Whether the microphone is muted."
    },
    "deafened": {
      "type": "boolean",
      "description": "Whether incoming audio is silenced."
    }
  },
  "description": "Updates this connection's own mute or deafen state. An absent field leaves the current value unchanged."
}
speakingUpdate object

A change in whether someone is currently speaking.

Properties

did string did Required

Who this update is about.

level integer Optional

An audio level in dBFS.

speaking boolean Required

Whether they are currently speaking.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "speaking"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Who this update is about."
    },
    "level": {
      "type": "integer",
      "description": "An audio level in dBFS."
    },
    "speaking": {
      "type": "boolean",
      "description": "Whether they are currently speaking."
    }
  },
  "description": "A change in whether someone is currently speaking."
}
transportOptions object

Parameters for creating one side of a WebRTC transport.

Properties

direction string Optional

Which side of the call this transport carries.

Known values: send, recv
dtlsParameters unknown Required

The opaque mediasoup DTLS parameters blob.

iceCandidates array of unknown Required

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.

iceParameters unknown Required

The opaque mediasoup ICE parameters blob.

id string Required

The transport's identifier.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "iceParameters",
    "iceCandidates",
    "dtlsParameters"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The transport's identifier."
    },
    "direction": {
      "type": "string",
      "description": "Which side of the call this transport carries.",
      "knownValues": [
        "send",
        "recv"
      ]
    },
    "iceCandidates": {
      "type": "array",
      "items": {
        "type": "unknown",
        "description": "One opaque mediasoup ICE candidate."
      },
      "description": "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."
    },
    "iceParameters": {
      "type": "unknown",
      "description": "The opaque mediasoup ICE parameters blob."
    },
    "dtlsParameters": {
      "type": "unknown",
      "description": "The opaque mediasoup DTLS parameters blob."
    }
  },
  "description": "Parameters for creating one side of a WebRTC transport."
}

Lexicon Garden

@