Skip to content

Commit

Permalink
Clarify that sdpMid and sdpMLineIndex are not required in `m.call.can…
Browse files Browse the repository at this point in the history
…didates`

MSC2746, merged in v1.17,
introduced the end-of-candidates candidate,
where only the `candidate` property is set to an empty string.

Besides, the [WebRTC specification](https://www.w3.org/TR/webrtc/)
says that only one of those fields is required in a normal candidate.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
  • Loading branch information
zecakeh committed Mar 5, 2024
1 parent 38f70f3 commit 7633d2c
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions data/event-schemas/schema/m.call.candidates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,26 @@ properties:
properties:
sdpMid:
type: string
description: The SDP media type this candidate is intended for.
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.
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.
description: |-
The SDP 'a' line of the candidate.
If this is an end-of-candidates candidate, this is empty.
required:
- candidate
- sdpMLineIndex
- sdpMid
required:
- candidates
type:
Expand Down

0 comments on commit 7633d2c

Please sign in to comment.