RTCIceServer.credentialType

The RTCIceServer dictionary's credentialType property is a string value from the RTCIceCredentialType enum which indicates what type of credential the RTCIceServer.credential value is. The default is "password".

Syntax

var iceServer = {
                  ...
                  credentialType = ["password" | "token"],
                  ...
                };

var credential = iceServer.credentialType;

iceServer.credential = ["password" | "token"];

Constants

RTCIceCredentialType enum

The RTCIceCredentialType enum specifies values which can be returned by the credentialType property to define what kind of authentication credential is being provided in the RTCIceServer.credential property. This can be one of the values below.

Example

This example creates a new RTCPeerConnection which will use a TURN server at turnserver.example.org to negotiate connections. Logging into the TURN server will use the username "webrtc" and the creative password "turnpassword".

myPeerConnection = new RTCPeerConnection({
  iceServers: [
    {
      urls: "turn:turnserver.example.org",  // A TURN server
      username: "webrtc",
      credential: "turnpassword",
      credentialType: "password"
    }
  ]
});

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• RTCIceServer
• RTCIceServer.credential