RTCIceTransport: statechange event
Baseline2024Newly available
Since April 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
Astatechange
event occurs when theRTCIceTransport
changes state. Thestate
can be used to determine how far through the process of examining, verifying, and selecting a valid candidate pair is prior to successfully connecting the two peers for WebRTC communications.
This event is not cancelable and does not bubble.
Syntax
Use the event name in methods likeaddEventListener()
, or set an event handler property.
addEventListener("statechange", (event) => { })onstatechange = (event) => { }
Event type
A genericEvent
.
Examples
Given anRTCPeerConnection
,pc
, the following code creates an event handler that calls a function namedhandleFailure()
if the ICE transport enters a failure state.
let iceTransport = pc.getSenders()[0].transport.iceTransport;iceTransport.addEventListener( "statechange", (ev) => { if (iceTransport.state === "failed") { handleFailure(pc); } }, false,);
The same code, using theonstatechange
event handler property, looks like this:
let iceTransport = pc.getSenders()[0].transport.iceTransport;iceTransport.onstatechange = (ev) => { if (iceTransport.state === "failed") { handleFailure(pc); }};
Specifications
Specification |
---|
WebRTC: Real-Time Communication in Browsers # event-icetransport-statechange |
WebRTC: Real-Time Communication in Browsers # dom-rtcicetransport-onstatechange |