RTCIceCandidate.type

The RTCIceCandidate interface's read-only type specifies the type of candidate the object represents.

The type field's value is set when the RTCIceCandidate() constructor is used. You can't specify the value of type in the options object, but the address is automatically extracted from the candidate a-line, if it's formatted properly, being taken from its cand-type field.

Syntax

var type = RTCIceCandidate.type;

Value

A DOMString whose value is one of those defined by the RTCIceCandidateType enumerated type.

These candidate types are listed in order of priority; the higher in the list they are, the more efficient they are.

If type is null, that information was missing from the candidate's a-line, which will cause RTCPeerConnection.addIceCandidate() to throw an OperationError exception.

Example

In this example, the candidate's type is used to present a modified user interface for host candidates (those where the ip refers directly to the remote peer, rather than an intermediary).

if (candidate.type == "host") {
  showHostControls();
} else {
  hideHostControls();
}

Specifications

Browser compatibility

See also

• WebRTC API
• Introduction to WebRTC protocols
• WebRTC connectivity
• RTCIceCandidate.tcpType