00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
50 lines
2.1 KiB
YAML
50 lines
2.1 KiB
YAML
{
|
|
"type": "object",
|
|
"description": "This event is sent by callers after sending an invite and by the callee after answering. Its purpose is to give the other party additional ICE candidates to try using to communicate.",
|
|
"allOf": [{
|
|
"$ref": "core-event-schema/room_event.yaml"
|
|
}],
|
|
"properties": {
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"description": "The ID of the call this event relates to."
|
|
},
|
|
"candidates": {
|
|
"type": "array",
|
|
"description": "Array of objects describing the candidates.",
|
|
"items": {
|
|
"type": "object",
|
|
"title": "Candidate",
|
|
"properties": {
|
|
"sdpMid": {
|
|
"type": "string",
|
|
"description": "The SDP media type this candidate is intended for."
|
|
},
|
|
"sdpMLineIndex": {
|
|
"type": "number",
|
|
"description": "The index of the SDP 'm' line this candidate is intended for."
|
|
},
|
|
"candidate": {
|
|
"type": "string",
|
|
"description": "The SDP 'a' line of the candidate."
|
|
}
|
|
},
|
|
"required": ["candidate", "sdpMLineIndex", "sdpMid"]
|
|
}
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"description": "The version of the VoIP specification this messages adheres to. This specification is version 0."
|
|
}
|
|
},
|
|
"required": ["call_id", "candidates", "version"]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["m.call.candidates"]
|
|
}
|
|
}
|
|
}
|