RTCIceServer

The RTCIceServer dictionary defines how to connect to a single ICE server (such as a STUN or TURN server). Objects of this type are provided in the configuration of an RTCPeerConnection, in the iceServers array.

Instance properties

credential Optional

The credential to use when logging into the server. This is only used if the RTCIceServer represents a TURN server.

credentialType Optional

If the RTCIceServer represents a TURN server, this attribute specifies what kind of credential is to be used when connecting. The default is password.

urls

This required property is either a single string or an array of strings, each specifying a URL which can be used to connect to the server.

username Optional

If the RTCIceServer is a TURN server, then this is the username to use during the authentication process.

Avoid specifying an unnecessarily large number of URLs in the urls property; the startup time for your connection will go up substantially. Every server in the list will be contacted and tried out before one is selected to be used for negotiation.

Note: Older versions of the WebRTC specification included an url property instead of urls; this was changed in order to let you specify multiple addresses for each server in the list, as shown in the example below.

Obsolete properties

The following properties have been removed from the specification and should not be used.

url

This obsolete property is a string specifies a single ICE server's URL. Do not use this property; use urls instead. Because many older books and examples still use this, we include it to help developers update their code or make sense of older examples.

Example

The configuration below establishes two ICE servers. The first one, stun:stun.services.mozilla.com, requires authentication, so the username and password are provided. The second server has two URLs: stun:stun.example.com and stun:stun-1.example.com.

js

const configuration = {
  iceServers: [
    {
      urls: "stun:stun.services.mozilla.com",
      username: "louis@mozilla.com",
      credential: "webrtcdemo",
    },
    {
      urls: ["stun:stun.example.com", "stun:stun-1.example.com"],
    },
  ],
};

const pc = new RTCPeerConnection(configuration);

Once the configuration object has been created, it is passed into the RTCPeerConnection() constructor to use it as the configuration for the new peer connection.

Browser compatibility

BCD tables only load in the browser

See also