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

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>
pull/1742/head
Kévin Commaille 3 months ago
parent 38f70f3871
commit 7633d2c299
No known key found for this signature in database
GPG Key ID: 29A48C1F03620416

@ -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:

Loading…
Cancel
Save