matrix-spec/data/event-schemas/schema/m.call.candidates.yaml
Kévin Commaille 38f70f3871
Convert m.call.candidates schema to YAML
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-03-05 18:08:20 +01:00

40 lines
1.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
allOf:
- $ref: core-event-schema/call_event.yaml
properties:
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
required:
- candidates
type:
type: string
enum:
- m.call.candidates