RTCPeerConnection()

Конструктор RTCPeerConnection() возвращает  новый экземпляр объекта RTCPeerConnection, который представляет соединение между локальным устройством и удалённым пиром (участником соединения)

Синтаксис

pc = new RTCPeerConnection([configuration]);

Параметры

configuration Необязательный
Объект класса RTCConfiguration , предоставляющий свойства для конфигурации нового экземпляра соединения.

Объект конфигурации RTCConfiguration

bundlePolicy Optional
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 Optional
An Array 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 for further information.
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 Optional
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() is called.
Changing the size of the ICE candidate pool may trigger the beginning of ICE gathering.
iceServers Optional
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 Optional
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 Optional
A DOMString which specifies the target peer identity for the RTCPeerConnection. If this value is set (it defaults to null), the RTCPeerConnection will not connect to a remote peer unless it can successfully authenticate with the given name.
rtcpMuxPolicy Optional
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. The default is "require".

Возвращаемое значение

Экземпляр класса RTCPeerConnection , сконфигурированный по свойствам параметра configuration, если используется, иначе сконфигурированный по умолчанию.

Спецификации

Спецификации Статус Комментарий
WebRTC 1.0: Real-time Communication Between Browsers
Определение 'RTCPeerConnection()' в этой спецификации.
Кандидат в рекомендации Initial definition.

Совместимость с браузерами

BCD tables only load in the browser

Смотрите также