Skip to content

Commit

Permalink
Convert m.call.candidates schema to YAML
Browse files Browse the repository at this point in the history
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
  • Loading branch information
zecakeh committed Mar 5, 2024
1 parent 4e1b364 commit 38f70f3
Showing 1 changed file with 40 additions and 45 deletions.
85 changes: 40 additions & 45 deletions data/event-schemas/schema/m.call.candidates.yaml
Original file line number Diff line number Diff line change
@@ -1,45 +1,40 @@
{
"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"]
}
}
}
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

0 comments on commit 38f70f3

Please sign in to comment.