mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-05-16 15:00:42 +02:00
ba960f8d32
* Convert m.call.* schemas syntax to YAML For consistency. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Clarify user ID format in m.call.invite Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Add links to definitions Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Improve call schemas To look more consistent with other schemas. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Clarify URI format in GET /voip/turnServer Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Add changelog Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Fix regex Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> --------- Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
48 lines
1.4 KiB
YAML
48 lines
1.4 KiB
YAML
$schema: https://json-schema.org/draft/2020-12/schema
|
|
|
|
type: object
|
|
description: This event is sent by the caller when they wish to establish a call.
|
|
x-weight: 10
|
|
allOf:
|
|
- $ref: core-event-schema/room_event.yaml
|
|
properties:
|
|
content:
|
|
type: object
|
|
allOf:
|
|
- $ref: core-event-schema/call_event.yaml
|
|
properties:
|
|
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
|
|
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.
|
|
invitee:
|
|
type: string
|
|
description: The ID of the user being called. If omitted, any user in the room can answer.
|
|
x-addedInMatrixVersion: '1.7'
|
|
format: mx-user-id
|
|
pattern: "^@"
|
|
sdp_stream_metadata:
|
|
$ref: components/sdp_stream_metadata.yaml
|
|
required:
|
|
- offer
|
|
- lifetime
|
|
type:
|
|
type: string
|
|
enum:
|
|
- m.call.invite
|