RTCConfiguration Dictionary object

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

The RTCConfiguration dictionary defines members that configure how the peer to peer communication is established or re-established via RTCPeerConnection .

Dictionary

MemberTypeDescription
iceServerssequence<RTCIceServer>An array of objects describing servers available to be used by ICE.
iceTransportPolicyRTCIceTransportPolicyIndicates which candidates the ICE agent is allowed to use. Set to "all" by default.
bundlePolicyRTCBundlePolicyIndicates which media-bundling policy to use when gathering ICE candidates. Set to "balanced" by default.
peerIdentityDOMStringSets the target peer identity for the RTCPeerConnection. The RTCPeerConnection will not connect to a remote peer unless it can be authenticated with the provided name.

 

Remarks

The RTCIceTransportPolicy enum (the type of the iceTransportPolicy dictionary member) has the following enumerations:

NameDescription
"none"The ICE agent can't use any candidates.
"relay"The ICE agent can only use media relay candidates.
"all"The ICE agent can use any type of candidates.

 

The RTCBundlePolicy enum (the type of the bundlePolicy dictionary member) has the following enumerations:

NameDescription
"balanced"Gather ICE candidates for each media type in use (audio, video, and data).
"max-compat"Gather ICE candidates for each track.
"max-bundle"Gather ICE candidates for only one track.

 

See also

RTCPeerConnection

 

 

Show: