RTCIceServer.credential

Draft: This page is not complete.

I'm experimenting with structure for pages documenting members of dictionaries. Please contact sheppy with any feedback.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The RTCIceServer dictionary's credential property is a string providing the credential to use when connecting to the described server. This is typically a password, key, or other secret.

Note: This value is used when the RTCIceServer describes a TURN server.

Syntax

var iceServer = {
                  ...
                  credential = credential,
                  ...
                };

var credential = iceServer.credential;

iceServer.credential = newCredential;

Example

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

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

Specifications

Specification
WebRTC 1.0: Real-Time Communication Between Browsers
# dom-rtciceserver-credential

Browser compatibility

BCD tables only load in the browser

See also