RTCIceServer.username

The RTCIceServer dictionary's username property is a string which specifies the username to use when authenticating with the ICE server being described.

Syntax

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

var username = iceServer.username;

iceServer.username = newUsername;

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"
    }
  ]
});

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between Browser The definition of 'RTCIceServer.username' in that specification.	Working Draft	Initial specification.

Browser compatibility

[1] Prior to Firefox 23, Firefox only supported STUN connections; TURN support arrived in Firefox 23, along with support for the username property on the RTCIceServer dictionary. Before that, the username was specified in the URL ([email protected] for example).

See also

• RTCIceServer
• RTCIceServer.credential
• RTCIceServer.credentialType