* Change version field to a string
And add the notes on how the version field works.
* Add spec requiring tracks to be within streams.
* Put streams spec in its own section
* Add 'invitee' field
* Add party_id
* Remember how JSON works
* Add m.call.select_answer
* Update examples
* Add select_answer to call flow example diagram
* Add m.call.reject
* Make party_id required in other events
* Add possible ways for client to handle an invite
* Convert hangup & reject events to YAML
So we can have a bulleted list in the description for the values
of 'reason'.
* Add new reason codes to hangup & reject
* Add m.call.negotiate
* Add other sections
* Revert changes to package lock
* Typos
* Fix type of other version fields, fix anchor.
* Add newsfragment
* Fix reason in hangup/reject
* Change tense
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Tense, typos & grammar
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Linkify
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Remove unnecessary parts from link
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Capitalise
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Fix hangup reasons
* Clarify who can answer
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Linkify
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Remove reference to 'this MSC'.
* Move common VoIP fields into a call event type.
* Move common voip events to the content, not the actual event
* Remove reason from reject event
I confused myself, but it's not in the MSC and it shouldn't be.
* Failure to YAML
* Fix number of room members allowed when sending voip events.
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Add 'added in' version
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Another added-in
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
* Add missing comma
---------
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
Co-authored-by: Travis Ralston <travisr@matrix.org>
"description": "Sent by either party to signal their termination of the call. This can be sent either once the call has has been established or before to abort the call.",
description:|
"allOf": [{
Sent by either party to signal their termination of the call. This can
"$ref": "core-event-schema/room_event.yaml"
be sent either once the call has has been established or before to abort the call.
}],
"properties": {
The meanings of the `reason` field are as follows:
"content": {
* `ice_failed`:ICE negotiation has failed and a media connection could not be established.
"type": "object",
* `ice_timeout`:The connection failed after some media was exchanged (as opposed to `ice_failed`
"properties": {
which means no media connection could be established). Note that, in the case of an ICE
"call_id": {
renegotiation, a client should be sure to send `ice_timeout` rather than `ice_failed` if media
"type": "string",
had previously been received successfully, even if the ICE renegotiation itself failed.
"description": "The ID of the call this event relates to."
* `invite_timeout`:The other party did not answer in time.
},
* `user_hangup`:Clients must now send this code when the user chooses to end the call, although
"version": {
for backwards compatibility with version 0, a clients should treat an absence of the `reason`
"type": "integer",
field as `user_hangup`.
"description": "The version of the VoIP specification this message adheres to. This specification is version 0."
* `user_media_failed`:The client was unable to start capturing media in such a way that it is unable
},
to continue the call.
"reason": {
* `user_busy`:The user is busy. Note that this exists primarily for bridging to other networks such
"type": "string",
as the PSTN. A Matrix client that receives a call whilst already in a call would not generally reject
"description": "Optional error reason for the hangup. This should not be provided when the user naturally ends or rejects the call. When there was an error in the call negotiation, this should be `ice_failed` for when ICE negotiation fails or `invite_timeout` for when the other party did not answer in time.",
the new call unless the user had specifically chosen to do so.
"enum": [
* `unknown_error`:Some other failure occurred that meant the client was unable to continue the call
"ice_failed",
rather than the user choosing to end it.
"invite_timeout"
allOf:
]
- "$ref": core-event-schema/room_event.yaml
}
properties:
},
content:
"required": ["call_id","version"]
type:object
},
allOf:
"type": {
- "$ref": core-event-schema/call_event.yaml
"type": "string",
properties:
"enum": ["m.call.hangup"]
reason:
}
type:string
}
description:Reason for the hangup. Note that this was optional in
}
previous previous versions of the spec, so a missing value should be
"description": "A unique identifier for the call."
},
"offer": {
"offer": {
"type": "object",
"type": "object",
"title": "Offer",
"title": "Offer",
@ -29,16 +28,17 @@
},
},
"required": ["type","sdp"]
"required": ["type","sdp"]
},
},
"version": {
"type": "integer",
"description": "The version of the VoIP specification this message adheres to. This specification is version 0."
},
"lifetime": {
"lifetime": {
"type": "integer",
"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."
"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."
},
"invitee": {
"type": "string",
"description": "The ID of the user being called. If omitted, any user in the room can answer.",
"description": "This event is sent by the caller's client once it has decided which other client to talk to, by selecting one of multiple possible incoming `m.call.answer` events. Its `selected_party_id` field indicates the answer it's chosen. The `call_id` and `party_id` of the caller is also included. If the callee's client sees a `select_answer` for an answer with party ID other than the one it sent, it ends the call and informs the user the call was answered elsewhere. It does not send any events. Media can start flowing before this event is seen or even sent. Clients that implement previous versions of this specification will ignore this event and behave as they did before.",
"x-addedInMatrixVersion": "1.7",
"allOf": [{
"$ref": "core-event-schema/room_event.yaml"
}],
"properties": {
"content": {
"type": "object",
"allOf": [{
"$ref": "core-event-schema/call_event.yaml"
}],
"properties": {
"selected_party_id": {
"type": "string",
"description": "The `party_id` field from the answer event that the caller chose."