icecandidate_event update the meaning of null candidate

[bardiharborow]

Request type

• New documentation
• Correction or update

Details

See icecandidate event.

The code sample in "Sharing a new candidate" checks if event.candidate is truthy before delivering it to the remote peer. "Indicating the end of a generation of candidates" says that events where event.candidate == "" should be delivered, but the empty string is falsy in JavaScript and this signal would not be delivered. "Indicating that ICE gathering is complete" says that events where event.complete == null should not be delivered but then refers to the event.candidate == true test.

There is clearly a nuance here that I'm missing, but in any case this may need to be clarified. An uninformed reader would form the conclusion that actually a event.complete != null test is needed.

There's also mixed references to RTCPeerConnectionIceEvent (bluelinked) and RTCPeerIceCandidateEvent (redlinked), not sure if that's intentional.

[a2sheppy]

Yeah, the meaning of a null candidate changed a while back and the document clearly has not fully caught up. That needs to be cleared up. And yes, the references to RTCPeerIceCanddiateEvent are wrong and should be RTCPeerConnectionIceEvent.

[bardiharborow]

@chrisdavidmills the main issue here doesn't appear to have been resolved, though the incorrect reference to RTCPeerIceCanddiateEvent seems to be gone.

[chrisdavidmills]

@bardiharborow OK, thanks for the heads up. I'll reopen this and move it to our current content repo.

[Rumyra]

To whoever fixes this issue, it looks like the following is needed:

• Check the meaning of null candidate and update examples accordingly
• Update any text to reflect changes

[sideshowbarker]

@dontcallmedom This seems like something that a contributor with WebRTC domain knowledge could make short work of. Do you think there’s any chance we could rope in somebody to take a look at it?

[fippo]

the recommendation to only signal non-null candidates is a pretty old one (2013?) which predates the icegatheringstatechange event. You should actually signal when you have gathered all candidates so the other side knows.

"Indicating the end of a generation of candidates" says that events where event.candidate == "" should be delivered,

This part actually works as intended since that candidate has event.candidate set to {candidate: "", sdpMid: ...}
Tagging @docfaraday who knows most about that end-of-candidates candidate but I might take this one

[Rumyra]

@danjenkins would you happen to be able to help with the above issue?