mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
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
49 lines
1.9 KiB
YAML
49 lines
1.9 KiB
YAML
{
|
|
"type": "object",
|
|
"description": "This event is sent by the caller when they wish to establish a call.",
|
|
"allOf": [{
|
|
"$ref": "core-event-schema/room_event.yaml"
|
|
}],
|
|
"properties": {
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"description": "A unique identifier for the call."
|
|
},
|
|
"offer": {
|
|
"type": "object",
|
|
"title": "Offer",
|
|
"description": "The session description object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["offer"],
|
|
"description": "The type of session description."
|
|
},
|
|
"sdp": {
|
|
"type": "string",
|
|
"description": "The SDP text of the session description."
|
|
}
|
|
},
|
|
"required": ["type", "sdp"]
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"description": "The version of the VoIP specification this message adheres to. This specification is version 0."
|
|
},
|
|
"lifetime": {
|
|
"type": "integer",
|
|
"description": "The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI."
|
|
}
|
|
},
|
|
"required": ["call_id", "offer", "version", "lifetime"]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["m.call.invite"]
|
|
}
|
|
}
|
|
}
|