Skip to content

Commit

Permalink
Merge pull request #2948 from jan-ivar/relayprotocol
Browse files Browse the repository at this point in the history
Clarify when RTCIceCandidate's relayProtocol and url members are null.
  • Loading branch information
jan-ivar committed Mar 21, 2024
2 parents 7fddf0a + 8ea7c8b commit 252ff88
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions webrtc.html
Expand Up @@ -6366,24 +6366,22 @@ <h2>
</dd>
<dt class="add-to-usernameFragment-desc">
<dfn>relayProtocol</dfn> of type <span class=
"idlMemberType">RTCIceServerTransportProtocol</span>
"idlMemberType">RTCIceServerTransportProtocol</span>, readonly, nullable
</dt>
<dd class="add-to-usernameFragment-desc">
<p>
The protocol used by the endpoint to communicate with the TURN server. This
is only present for local relay candidates.
</p>
For local candidates of type {{RTCIceCandidateType/"relay"}} this is the
protocol used by the endpoint to communicate with the TURN server. For
all other candidates it is `null`.
</dd>
<dt class="add-to-usernameFragment-desc">
<dfn>url</dfn> of type <span class=
"idlMemberType">DOMString</span>
"idlMemberType">DOMString</span>, readonly, nullable
</dt>
<dd class="add-to-usernameFragment-desc">
<p>
For local candidates of type {{RTCIceCandidateType/"srflx"}} or type
{{RTCIceCandidateType/"relay"}} this is the URL of the ICE server
from which the candidate was obtained.
</p>
For local candidates of type {{RTCIceCandidateType/"srflx"}} or type
{{RTCIceCandidateType/"relay"}} this is the URL of the ICE server
from which the candidate was obtained. For all other candidates it is
`null`.
</dd>
</dl>
</section>
Expand Down

0 comments on commit 252ff88

Please sign in to comment.