Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that sdpMid and sdpMLineIndex are not required in m.call.candidates #1742

Merged
merged 4 commits into from
Mar 8, 2024
Merged

Clarify that sdpMid and sdpMLineIndex are not required in m.call.candidates #1742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38f70f3
Convert m.call.candidates schema to YAML
zecakeh Mar 5, 2024
7633d2c
Clarify that sdpMid and sdpMLineIndex are not required in `m.call.can…
zecakeh Mar 5, 2024
561767a
Add changelog
zecakeh Mar 5, 2024
0d1d6c8
Link to the "End-of-candidates" section, and clarify what "empty" means
zecakeh Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1742.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that `sdpMid` and `sdpMLineIndex` are not required in `m.call.candidates`.
94 changes: 49 additions & 45 deletions data/event-schemas/schema/m.call.candidates.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
{
"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.

At least one of `sdpMid` or `sdpMLineIndex` is required, unless
this an end-of-candidates candidate.
sdpMLineIndex:
type: number
description: |-
The index of the SDP 'm' line this candidate is intended for.

At least one of `sdpMid` or `sdpMLineIndex` is required, unless
this an end-of-candidates candidate.
candidate:
type: string
description: |-
The SDP 'a' line of the candidate.

If this is an [end-of-candidates](/client-server-api/#end-of-candidates)
candidate, this is the empty string.
required:
- candidate
required:
- candidates
type:
type: string
enum:
- m.call.candidates
Loading