RTCConfiguration

在此页

特性
常量
范例
规范
浏览器兼容性
相关话题

RTCConfiguration dictionary is used to provide configuration options for an RTCPeerConnection . It may be passed into the constructor when instantiating a connection, or used with the RTCPeerConnection.getConfiguration() and RTCPeerConnection.setConfiguration() methods, which allow inspecting and changing the configuration while a connection is established.

The options include ICE server and transport settings and identity information.

特性

bundlePolicy 可选: Specifies how to handle negotiation of candidates when the remote peer is not compatible with the SDP BUNDLE standard . This must be one of the values from the enum RTCBundlePolicy . If this value isn't included in the dictionary, "balanced" is assumed.
certificates 可选: 数组 of objects of type RTCCertificate which are used by the connection for authentication. If this property isn't specified, a set of certificates is generated automatically for each RTCPeerConnection instance. Although only one certificate is used by a given connection, providing certificates for multiple algorithms may improve the odds of successfully connecting in some circumstances. See Using certificates 了解进一步信息。 This configuration option cannot be changed after it is first specified; once the certificates have been set, this property is ignored in future calls to RTCPeerConnection.setConfiguration() .
iceCandidatePoolSize 可选: An unsigned 16-bit integer value which specifies the size of the prefetched ICE candidate pool. The default value is 0 (meaning no candidate prefetching will occur). You may find in some cases that connections can be established more quickly by allowing the ICE agent to start fetching ICE candidates before you start trying to connect, so that they're already available for inspection when RTCPeerConnection.setLocalDescription() 被调用。 Changing the size of the ICE candidate pool may trigger the beginning of ICE gathering.
iceServers 可选: An array of RTCIceServer objects, each describing one server which may be used by the ICE agent; these are typically STUN and/or TURN servers. If this isn't specified, the connection attempt will be made with no STUN or TURN server available, which limits the connection to local peers.
iceTransportPolicy 可选: The current ICE transport policy; this must be one of the values from the RTCIceTransportPolicy enumeration. If the policy isn't specified, all is assumed by default, allowing all candidates to be considered. A value of relay limits the candidates to those relayed through another server, such as a STUN or TURN server.
peerIdentity 可选: DOMString which specifies the target peer identity for the RTCPeerConnection . If this value is set (it defaults to null )， RTCPeerConnection will not connect to a remote peer unless it can successfully authenticate with the given name.
rtcpMuxPolicy 可选: The RTCP mux policy to use when gathering ICE candidates, in order to support non-multiplexed RTCP. The value must be one of those from the RTCRtcpMuxPolicy enum 。默认为 "require" .

常量

RTCBundlePolicy enum

RTCBundlePolicy enum defines string constants which are used to request a specific policy for gathering ICE candidates if the remote peer isn't "BUNDLE-aware" (compatible with the SDP BUNDLE standard for bundling multiple media streams on a single transport link). All browser implementations are BUNDLE-aware.

If the remote endpoint is BUNDLE-aware, all media tracks and data channels are bundled onto a single transport at the completion of negotiation, regardless of policy used, and any superfluous transports that were created initially are closed at that point.

注意： In technical terms, a BUNDLE lets all media flow between two peers flow across a single 5-tuple ; that is, from a single IP and port on one peer to a single IP and port on the other peer, using the same transport protocol.

常量	描述
`"balanced"`	The ICE agent initially creates one `RTCDtlsTransport` for each type of content added: audio, video, and data channels. If the remote endpoint is not BUNDLE-aware, then each of these DTLS transports then handles all the communication for one type of data.
`"max-compat"`	The ICE agent initially creates one `RTCDtlsTransport` per media track and a separate one for data channels. If the remote endpoint is not BUNDLE-aware, everything is negotiated on these separate DTLS transports.
`"max-bundle"`	The ICE agent initially creates only a single `RTCDtlsTransport` to carry all of the `RTCPeerConnection` 's data. If the remote endpoint is not BUNDLE-aware, then only a single track will be negotiated and the rest ignored.

RTCIceTransportPolicy enum

RTCIceTransportPolicy enum defines string constants which can be used to limit the transport policies of the ICE candidates to be considered during the connection process.

常量	描述
`"all"`	All ICE candidates will be considered.
`"public"`	Only ICE candidates with public IP addresses will be considered. Removed from the specification's May 13, 2016 working draft.
`"relay"`	Only ICE candidates whose IP addresses are being relayed, such as those being passed through a TURN server, will be considered.

RTCRtcpMuxPolicy enum

RTCRtcpMuxPolicy enum defines string constants which specify what ICE candidates are gathered to support non-multiplexed RTCP. <<<add a link to info about multiplexed RTCP.

常量	描述
`"negotiate"`	Instructs the ICE agent to gather both RTP and RTCP candidates. If the remote peer can multiplex RTCP, then RTCP candidates are multiplexed atop the corresponding RTP candidates. Otherwise, both the RTP and RTCP candidates are returned, separately.
`"require"`	Tells the ICE agent to gather ICE candidates for only RTP, and to multiplex RTCP atop them. If the remote peer doesn't support RTCP multiplexing, then session negotiation fails.

范例

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 .

var configuration = { iceServers: [{
                          urls: "stun:stun.services.mozilla.com",
                          username: "louis@mozilla.com",
                          credential: "webrtcdemo"
                      }, {
                          urls: ["stun:stun.example.com", "stun:stun-1.example.com"]
                      }]
};
var pc = new RTCPeerConnection(configuration);

规范

规范	状态	注释
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCConfiguration' in that specification.	候选推荐	初始定义。

浏览器兼容性

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request. 更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`RTCConfiguration`	Chrome 23	Edge ≤79	Firefox ?	IE 不支持 No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0
`bundlePolicy`	Chrome 23	Edge ≤79	Firefox ?	IE 不支持 No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0
`certificates`	Chrome 23	Edge ≤79	Firefox ?	IE 不支持 No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0
`iceCandidatePoolSize`	Chrome 23	Edge ≤79	Firefox ?	IE 不支持 No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0
`iceServers`	Chrome 23	Edge ≤79	Firefox ?	IE 不支持 No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0
`iceTransportPolicy`	Chrome 23	Edge ≤79	Firefox ?	IE 不支持 No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0
`peerIdentity`	Chrome 23	Edge ≤79	Firefox ?	IE 不支持 No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0
`rtcpMuxPolicy`	Chrome 57 注意事项 57 注意事项 Default for `rtcpMuxPolicy` is `require`	Edge ≤79 注意事项 ≤79 注意事项 Default for `rtcpMuxPolicy` is `require`	Firefox ?	IE 不支持 No	Opera 44 注意事项 44 注意事项 Default for `rtcpMuxPolicy` is `require`	Safari ?	WebView Android Yes	Chrome Android 57	Firefox Android ?	Opera Android Yes	Safari iOS ?	Samsung Internet Android 7.0

图例

完整支持
不支持
兼容性未知 ?

元数据

最后修改： Aug 25, 2020

在此页

特性

常量

RTCBundlePolicy enum

RTCIceTransportPolicy enum

RTCRtcpMuxPolicy enum

范例

规范

浏览器兼容性

图例

相关话题