Class RTCPeerConnectionIceEvent
- Namespace
- CSharpToJavaScript.APIs.JS
- Assembly
- CSharpToJavaScript.dll
The RTCPeerConnectionIceEvent interface represents events that occur in relation to {{Glossary("ICE")}} candidates with the target, usually an RTCPeerConnection.
[Value("RTCPeerConnectionIceEvent")]
public class RTCPeerConnectionIceEvent : Event
- Inheritance
-
RTCPeerConnectionIceEvent
- Inherited Members
Remarks
Only one event is of this type: RTCPeerConnection.Icecandidate.
-WebRTC
-Its usual target: RTCPeerConnection.
Constructors
RTCPeerConnectionIceEvent()
public RTCPeerConnectionIceEvent()
RTCPeerConnectionIceEvent(string, RTCPeerConnectionIceEventInit)
The RTCPeerConnectionIceEvent() constructor creates a new
RTCPeerConnectionIceEvent object.
public RTCPeerConnectionIceEvent(string type, RTCPeerConnectionIceEventInit eventInitDict = null)
Parameters
typestringeventInitDictRTCPeerConnectionIceEventInit
Remarks
-WebRTC
-Its usual target: RTCPeerConnection.
Properties
Candidate
The read-only candidate property
of the RTCPeerConnectionIceEvent interface returns the
RTCIceCandidate associated with the event.
[Value("candidate")]
public RTCIceCandidate? Candidate { get; }
Property Value
- RTCIceCandidate
An RTCIceCandidate object representing the ICE candidate that has been
received, ornullto indicate that there are no further candidates for this
negotiation session.
Remarks
-RTCPeerConnection.Icecandidate
-RTCPeerConnection
Url
IMPORTANT
Deprecatedurl property of the RTCPeerConnectionIceEvent interface returns the URL of the {{Glossary("STUN")}} or {{Glossary("TURN")}} server used to gather the ICE candidate that caused the event. If the candidate was not gathered from a {{Glossary("STUN")}} or {{Glossary("TURN")}} server, the value is null.
[Value("url")]
public string? Url { get; }
Property Value
- string
A string containing the URL of the STUN or TURN server used to gather this candidate, or
nullif the candidate was not gathered from a server (for example, a local host candidate).
Remarks
NOTE
This property is considered deprecated by the specification in favor of the
urlproperty on the RTCIceCandidate interface itself.
-RTCPeerConnection.Icecandidate
-Candidate
-RTCPeerConnection