RTCIceCandidatePairChangedEvent event

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Represents events that fire due to a change in the local and remote candidate pairing of the RTCIceCandidatePairChangedEvent icestatechange object.

Firing an RTCIceCandidatePairChangedEvent event named X with an RTCIceCandidatePair pair means that an event with the name X, which does not bubble (except where otherwise stated) and is not cancelable (except where otherwise stated), and which uses the RTCIceCandidatePairChangedEvent interface with the pair attribute set to the nominated RTCIceCandidatePair, must be created and dispatched at the given target.

Syntax

Event Property object.RTCIceCandidatePairChangedEvent = handler;

 

Event information

Synchronous No
Bubbles No
Cancelable No

 

Event handler parameters

  • pair
    Type: RTCIceCandidatePair

    The pair attribute is the nominated RTCIceCandidatePair that caused the event.

    readonly

Standards information

Remarks

WebIDL

dictionary RTCIceCandidatePairChangedEventInit : EventInit {
             RTCIceCandidatePair pair;
};

[Constructor(DOMString type, RTCIceCandidatePairChangedEventInit eventInitDict)]
interface RTCIceCandidatePairChangedEvent : Event {
    readonly    attribute RTCIceCandidatePair pair;
};

See also

RTCIceTransport