Обработчики событий
Интерфейс RTCPeerConnection
представляет соединение WebRTC между локальным пиром (участником соединения) на локальном компьютере и удаленным пиром на удаленном компьютере. Он предоставляет методы для соединения с удаленным участником соединения, обслуживания, мониторинга и закрытия соединения.
<div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 11.666666666666666%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-50 0 600 70" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/ru/docs/Web/API/EventTarget" target="_top"><rect x="1" y="1" width="110" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="56" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">EventTarget</text></a><polyline points="111,25 121,20 121,30 111,25" stroke="#D4DDE4" fill="none"/><line x1="121" y1="25" x2="151" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/ru/docs/Web/API/RTCPeerConnection" target="_top"><rect x="151" y="1" width="170" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text x="236" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">RTCPeerConnection</text></a></svg></div>
a:hover text { fill: #0095DD; pointer-events: all;}
Конструктор
RTCPeerConnection()
- Конструктор RTCPeerConnection() возвращает новый экземпляр объекта RTCPeerConnection, который представляет соединение между локальным устройством и удаленным пиром (участником соединения)
canTrickleIceCandidates
- Свойство только для чтения canTrickleIceCandidates , объекта RTCPeerConnection, возвращает значение типа Boolean , которое указывает на то, может ли удаленный пир принимать кандидаты, согласно спецификации trickled ICE candidates.
connectionState
- Только для чтения свойство connectionState интерфейса RTCPeerConnection указывает на текущее состояние соединения, возвращая одно из строковых значений, определяемых в перечислении RTCPeerConnectionState.
currentLocalDescription
Только для чтения- Только для чтения свойство RTCPeerConnection.currentLocalDescription возвращает объект RTCSessionDescription , описывающий локальную сторону соединения, как самый последний, удачно согласованный объект описания, с момента последнего завершения согласования RTCPeerConnection и соединения с удаленным пиром (участником соединения) .
currentRemoteDescription
Только для чтения- Только для чтения свойство RTCPeerConnection.currentRemoteDescription возвращает объект RTCSessionDescription , представляющий удаленную сторону соединения, как последний, успешно согласованный объект данных, с момента завершения согласования и установки соединения объектом RTCPeerConnection с удаленным пиром.
getDefaultIceServers()
- Метод getDefaultIceServers() интерфейса RTCPeerConnection , возвращает массив объектов RTCIceServer, который указывает, какие серверы ICE браузер будет использовать по умолчанию, если они не указаны в параметре RTCConfiguration конструктора RTCPeerConnection
iceConnectionState
Только для чтения [Перевести]- The read-only property
RTCPeerConnection.iceConnectionState
returns an enum of typeRTCIceConnectionState
which state of the ICE agent associated with theRTCPeerConnection
. iceGatheringState
Только для чтения [Перевести]- The read-only property
RTCPeerConnection.iceGatheringState
returns an enum of typeRTCIceGatheringState
that describes connection's ICE gathering state. This lets you detect, for example, when collection of ICE candidates has finished. localDescription
Только для чтения [Перевести]- The read-only property
RTCPeerConnection.localDescription
returns anRTCSessionDescription
describing the session for the local end of the connection. If it has not yet been set, this is null. peerIdentity
Только для чтения [Перевести]- The read-only
RTCPeerConnection
propertypeerIdentity
returns a JavaScriptPromise
that resolves to anRTCIdentityAssertion
which contains aDOMString
identifying the remote peer. pendingLocalDescription
Только для чтения [Перевести]- The read-only property
RTCPeerConnection.pendingLocalDescription
returns anRTCSessionDescription
object describing a pending configuration change for the local end of the connection. This does not describe the connection as it currently stands, but as it may exist in the near future. UseRTCPeerConnection.currentLocalDescription
orRTCPeerConnection.localDescription
to get the current state of the endpoint. For details on the difference, see Pending and current descriptions in WebRTC connectivity. pendingRemoteDescription
Только для чтения [Перевести]- The read-only property
RTCPeerConnection.pendingRemoteDescription
returns anRTCSessionDescription
object describing a pending configuration change for the remote end of the connection. This does not describe the connection as it currently stands, but as it may exist in the near future. UseRTCPeerConnection.currentRemoteDescription
orRTCPeerConnection.remoteDescription
to get the current session description for the remote endpoint. For details on the difference, see Pending and current descriptions in WebRTC connectivity. remoteDescription
Только для чтения [Перевести]- The read-only property
RTCPeerConnection.remoteDescription
returns aRTCSessionDescription
describing the session (which includes configuration and media information) for the remote end of the connection. If this hasn't been set yet, this isnull
. sctp
[Перевести]- The read-only
sctp
property on theRTCPeerConnection
interface returns anRTCSctpTransport
describing the SCTP transport over which SCTP data is being sent and received. If SCTP hasn't been negotiated, this value isnull
. signalingState
Только для чтения [Перевести]- The read-only
signalingState
property on theRTCPeerConnection
interface returns one of the string values specified by theRTCSignalingState
enum; these values describe the state of the signaling process on the local end of the connection while connecting or reconnecting to another peer. See Signaling in Lifetime of a WebRTC session for more details about the signaling process. onaddstream
[Перевести]- The
RTCPeerConnection.onaddstream
event handler is a property containing the code to execute when theaddstream
event, of typeMediaStreamEvent
, is received by thisRTCPeerConnection
. Such an event is sent when aMediaStream
is added to this connection by the remote peer. The event is sent immediately after the callsetRemoteDescription()
and doesn't wait for the result of the SDP negotiation. onconnectionstatechange
[Перевести]- The
RTCPeerConnection.onconnectionstatechange
property specifies anEventHandler
which is called to handle theconnectionstatechange
event when it occurs on an instance ofRTCPeerConnection
. This happens whenever the aggregate state of the connection changes. ondatachannel
[Перевести]- The
RTCPeerConnection.ondatachannel
property is anEventHandler
which specifies a function which is called when thedatachannel
event occurs on anRTCPeerConnection
. This event, of typeRTCDataChannelEvent
, is sent when anRTCDataChannel
is added to the connection by the remote peer callingcreateDataChannel()
. onicecandidate
[Перевести]- The
RTCPeerConnection
propertyonicecandidate
property is anEventHandler
which specifies a function to be called when theicecandidate
event occurs on anRTCPeerConnection
instance. This happens whenever the local ICE agent needs to deliver a message to the other peer through the signaling server. oniceconnectionstatechange
[Перевести]- The
RTCPeerConnection.oniceconnectionstatechange
property is an event handler which specifies a function to be called when theiceconnectionstatechange
event is fired on anRTCPeerConnection
instance. This happens when the state of the connection's ICE agent, as represented by theiceConnectionState
property, changes. onicegatheringstatechange
[Перевести]- The
RTCPeerConnection.onicegatheringstatechange
property is anEventHandler
which specifies a function to be called when theicegatheringstatechange
event is sent to anRTCPeerConnection
instance. This happens when the ICE gathering state—that is, whether or not the ICE agent is actively gathering candidates—changes. onidentityresult
[Перевести]- The
RTCPeerConnection.onidentityresult
event handler is a property containing the code to execute when theidentityresult
event, of typeRTCIdentityEvent
, is received by thisRTCPeerConnection
. Such an event is sent when an identity assertion is generated, viagetIdentityAssertion()
or during the creation of an offer or an answer. [Перевести]onidpassertionerror
- The
RTCPeerConnection.onidpassertionerror
event handler is a property containing the code to execute whent theidpassertionerror
event, of typeRTCIdentityErrorEvent
, is received by thisRTCPeerConnection
. Such an event is sent when the associated identity provider (IdP) encounters an error while generating an identity assertion. [Перевести]onidpvalidationerror
- The
RTCPeerConnection.onidpvalidationerror
event handler is a property containing the code to execute whent theidpvalidationerror
event, of typeRTCIdentityErrorEvent
, is received by thisRTCPeerConnection
. Such an event is sent when the associated identity provider (IdP) encounters an error while validating an identity assertion. onnegotiationneeded
[Перевести]- The
RTCPeerConnection
interface'sonnegotiationneeded
property is anEventListener
which specifies a function which is called to handle thenegotiationneeded
event when it occurs on anRTCPeerConnection
instance. This event is fired when a change has occurred which requires session negotiation. This negotiation should be carried out as the offerer, because some session changes cannot be negotiated as the answerer. [Перевести]onpeeridentity
- The
RTCPeerConnection.onpeeridentity
event handler is a property containing the code to execute whent thepeeridentity
event, of typeEvent
, is received by thisRTCPeerConnection
. Such an event is sent when an identity assertion, received from a peer, has been successfully validated. onremovestream
[Перевести]- The
RTCPeerConnection.onremovestream
event handler is a property containing the code to execute when theremovestream
event, of typeMediaStreamEvent
, is received by thisRTCPeerConnection
. Such an event is sent when aMediaStream
is removed from this connection. onsignalingstatechange
[Перевести]- The
onsignalingstatechange
event handler property of theRTCPeerConnection
interface specifies a function to be called when thesignalingstatechange
event occurs on anRTCPeerConnection
interface. ontrack
[Перевести]- The
RTCPeerConnection
propertyontrack
is anEventHandler
which specifies a function to be called when thetrack
event occurs, indicating that a track has been added to theRTCPeerConnection
. addIceCandidate()
[Перевести]- When a web site or app using
RTCPeerConnection
receives a new ICE candidate from the remote peer over its signaling channel, it delivers the newly-received candidate to the browser's ICE agent by callingRTCPeerConnection.addIceCandidate()
. addStream()
[Перевести]- The obsolete
RTCPeerConnection
methodaddStream()
adds aMediaStream
as a local source of audio or video. Instead of using this obsolete method, you should instead useaddTrack()
once for each track you wish to send to the remote peer. addTrack()
[Перевести]- The
RTCPeerConnection
methodaddTrack()
adds a new media track to the set of tracks which will be transmitted to the other peer. close()
[Перевести]- The
RTCPeerConnection.close()
method closes the current peer connection. createAnswer()
[Перевести]- The
createAnswer()
method on theRTCPeerConnection
interface creates an SDP answer to an offer received from a remote peer during the offer/answer negotiation of a WebRTC connection. The answer contains information about any media already attached to the session, codecs and options supported by the browser, and any ICE candidates already gathered. The answer is delivered to the returnedPromise
, and should then be sent to the source of the offer to continue the negotiation process. createDataChannel()
[Перевести]- The
createDataChannel()
method on theRTCPeerConnection
interface creates a new channel linked with the remote peer, over which any kind of data may be transmitted. createOffer()
[Перевести]- The
createOffer()
method of theRTCPeerConnection
interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer. generateCertificate() static function
[Перевести]- The static
RTCPeerConnection.generateCertificate()
function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the newRTCCertificate
once it's generated. getConfiguration()
[Перевести]- The
RTCPeerConnection.getConfiguration()
method returns anRTCConfiguration
object which indicates the current configuration of theRTCPeerConnection
on which the method is called. getIdentityAssertion()
[Перевести]- The
RTCPeerConnection.getIdentityAssertion()
method initiates the gathering of an identity assertion. This has an effect only if thesignalingState
is not"closed"
. getReceivers()
[Перевести]- The
RTCPeerConnection.getReceivers()
method returns an array ofRTCRtpReceiver
objects, each of which represents one RTP receiver. Each RTP receiver manages the reception and decoding of data for aMediaStreamTrack
on anRTCPeerConnection
getSenders()
[Перевести]- The
RTCPeerConnection
methodgetSenders()
returns an array ofRTCRtpSender
objects, each of which represents the RTP sender responsible for transmitting one track's data. getStats()
[Перевести]- The
RTCPeerConnection
methodgetStats()
returns a promise which resolves with data providing statistics about either the overall connection or about the specifiedMediaStreamTrack
. getStreamById()
[Перевести]- The
RTCPeerConnection.getStreamById()
method returns theMediaStream
with the given id that is associated with local or remote end of the connection. If no stream matches, it returnsnull
. getTransceivers()
[Перевести]- The
RTCPeerConnection
interface'sgetTransceivers()
method returns a list of theRTCRtpTransceiver
objects being used to send and receive data on the connection. removeStream()
[Перевести]- The
RTCPeerConnection.removeStream()
method removes aMediaStream
as a local source of audio or video. If the negotiation already happened, a new one will be needed for the remote peer to be able to use it. Because this method has been deprecated, you should instead useremoveTrack()
if your target browser versions have implemented it. removeTrack()
[Перевести]- The
RTCPeerConnection.removeTrack()
method tells the local end of the connection to stop sending media from the specified track, without actually removing the correspondingRTCRtpSender
from the list of senders as reported byRTCPeerConnection.getSenders()
. restartIce()
[Перевести]- The WebRTC API's
RTCPeerConnection
interface offers therestartIce()
method to allow a web application to easily request that ICE candidate gathering be redone on both ends of the connection. setConfiguration()
[Перевести]- The
RTCPeerConnection.setConfiguration()
method sets the current configuration of theRTCPeerConnection
based on the values included in the specifiedRTCConfiguration
object. This lets you change the ICE servers used by the connection and which transport policies to use. setIdentityProvider()
[Перевести]- The
RTCPeerConnection.setIdentityProvider()
method sets the Identity Provider (IdP) to the triplet given in parameter: its name, the protocol used to communicate with it (optional) and an optional username. The IdP will be used only when an assertion is needed. setLocalDescription()
[Перевести]- The
RTCPeerConnection
methodsetLocalDescription()
changes the local description associated with the connection. This description specifies the properties of the local end of the connection, including the media format. setRemoteDescription()
[Перевести]- The
RTCPeerConnection
methodsetRemoteDescription()
sets the specified session description as the remote peer's current offer or answer. The description specifies the properties of the remote end of the connection, including the media format.
Свойства
Also inherits свойства from: EventTarget
Also inherits обработчики событий from: EventTarget
Методы
Also inherits методы from: EventTarget
Устаревший метод
Метод ниже, является устаревшим и не будет в дальнейшем реализован в современных браузерах.
RTCPeerConnection.createDTMFSender()
- Создает новый объект типа
RTCDTMFSender
, связанный с определенным объектомMediaStreamTrack
, который сможет отправить объект сигнализации DTMF поверх соединения..
События
Для прослушивания событий используется функция добавления обработчика события addEventListener()
или используется стандартное свойство интерфейса по схеме onимясобытия
(префикс on к которому добавляется имя события прописными буквами) для установки обработчика события.
connectionstatechange
- Событие объекта
RTCPeerConnection
возникает, когда общий статус объекта сосединенияRTCPeerConnection
изменился.
Так же, доступно через свойство установки обработчика событияonconnectionstatechange
. datachannel
- Событие объекта
RTCPeerConnection
возникает, когда удаленный пир (участник соединения) добавляет объект данныхRTCDataChannel
в текущее соединение.
Так же, доступно через свойство установки обработчика событияondatachannel
. icecandidate
- Событие объекта
RTCPeerConnection
возникает, когда специальный объект ICE кандидата (RTCIceCandidate) сгенерированRTCPeerConnection
и готов для передачи удаленному пиру по каналу сигнализации.Сам сгененрированный объект кандидата передается в параметр вызванного обработчика.
Так же, доступно через свойство установки обработчика событияonicecandidate
. icecandidateerror
- Событие типа ошибки
RTCPeerConnectionIceErrorEvent
, возникает на объекте соединения при генерации ICE кандидата (RTCIceCandidate), если при этом возникла ошибка. Свойства объекта ошибки, возвращаемого в обработчик, описывают подробности ошибки.
Так же, доступно через свойство установки обработчика событияonicecandidateerror
. iceconnectionstatechange
- Событие объекта
RTCPeerConnection
возникает при изменении статуса ICE соединения. К примеру, ICE соединение разорвано.
Так же, доступно через свойство установки обработчика событияoniceconnectionstatechange
. icegatheringstatechange
- Событие объекта
RTCPeerConnection,
возникает, когда статус сборки, представленный классомiceGatheringState
, изменяется. Это указывает на то, что : согласование соединения ICE еще не началось (статус равен значению "new
"); согласование соединения ICE началось (статус равен значеню "gathering
"); согласование ICE соединения завершено (статус равен значению "complete
").
Так же, доступно через свойство установки обработчикаonicegatheringstatechange
. isolationchange
- Событие объекта
RTCPeerConnection
возникает, когда свойствоisolated
на одном из объектовMediaStreamTrack
, связанного с соединением изменяет свое значение. Объект трека является изолированнымisolated
, если его содержимое не может быть доступно содержащему его документу, по причине невозможности аутентификации, или объект трека прибыл не из источника происхождения страницы.
Так же, доступно через свойство установки обработчикаonisolationchange
. negotiationneeded
- Событие объекта
RTCPeerConnection
возникает, когда необходимо запустить согласование (пересогласование) ICE соединения; может произойти при первом открытии соединения , или при необходимости принятия изменений условий сети. Получатель должен ответить, создав предложение и отправив его другому партнеру.
Так же, доступно через свойство установки обработчикаonnegotiationneeded
. signalingstatechange
- Событие
signalingstatechange
возникает, когда статус сигнализации ICE соединения изменился..
Так же, доступно через свойство установки обработчикаonsignalingstatechange
. track
- Событие
track
возникает после того, как новый объект трека был добавлен в один из объектов интерфейсаRTCRtpReceiver
, которые входят в состав соединения.
Так же, доступно через свойство установки обработчикаontrack
.
Устаревшие события
addstream
- Возникает, когда новый объект
MediaStream
был добавлен в соединение. Вместо наблюдения за этим устаревшим событием, разработчику следует наблюдать за каждым событиемtrack
, возникающим при добавлении в соединение объектаMediaStreamTrack
..
Установка обработчика возможна через свойствоonaddstream
. identityresult
- В старой версии спецификации WebRTC это событие использовалось для указания доступности подтверждения идентичности. Теперь, следует ждать возвращение промиса от
peerIdentity
для подтверждения личности.
Установка обработчика возможна через свойствоonidentityresult
. idpassertionerror
- В старой версии спецификации WebRTC это событие использовалось для определения возникшей ошибки при попытке генерации подтверждения идентичности. Теперь, нужно ожидать результата работы промиса, возвращаемого методом доступа
peerIdentity
, передающий в метод перехвата ошибок промиса, возникшую ошибку.
Установка обработчика возможна через свойствоonidpinsertionerror
.. idpvalidationerror
- В старой версии спецификации WebRTC это событие использовалось для определения того, что ошибка возникла при попытке подтверждения идентичности. Теперь, следует ожидать результат работы промиса, возвращаемого методом доступа
peerIdentity
, для перехвата ошибки в соответствующем методе.
Установка обработчика возможна через свойствоonpeerdentity
. peeridentity
- В старой версии спецификации WebRTC это событие использовалось для доставки полученной идентичности. Теперь, нужно ожидать результата работы промиса, возвращаемого методом доступа
peerIdentity
, для получения идентичности. removestream
- Возникает на объекте
RTCPeerConnection,
когда объектMediaStream
удаляется из соединения. Теперь, необходимо наблюдать за событиямиremovetrack
на каждом потоке, входящем в состав объекта соединенияRTCPeerConnection
.
Установка обработчика возможна через свойствоonaddstream
.
Константы
Перечисление RTCBundlePolicy
Перечисление RTCBundlePolicy
(политика сборки пакетов) определяет строковые константы, которые используются для запроса определенной политики при сборке ICE кандидатов, в случае, если удаленный участник соединения (удаленная точка) не совместим со стандартом SDP BUNDLE standard для объединения нескольких медиапотоков в один транспортный пакет.
Примечание : В технических терминах BUNDLE (пакет) позволяет всем медиапотокам между двумя пирами проходить через один 5 - ти элементный кортеж (тип транспортного протокола передачи сообщений при установки TCP, UDP, и ICMP соединений, состоящий из пяти элементов анализа данных). То есть, с одного IP-адреса и порта на одном узле на один IP-адрес и порт на другом узле с использованием одного и того же транспортного протокола.
Константа | Описание |
---|---|
"balanced" |
Сбалансированный. Агент ICE изначально создает по одному объекту |
"max-compat" |
Максимально совместимый. Агент ICE изначально создает один объект RTCDtlsTransport для каждой медиа-дорожки и отдельный для каналов данных. Если удаленная точка не поддерживает опознавание пакета, все согласовывается на этих отдельных DTLS транспортах |
"max-bundle" |
Максимальный пакет. Агент ICE изначально создает только один объект RTCDtlsTransport для переноса всех данных RTCPeerConnection. Если удаленная точка не поддерживает опознавание пакета, то согласовывается только одна дорожка, а остальные игнорируются. |
Перечисление RTCIceConnectionState
Перечисление RTCIceConnectionState
определяет строковые константы, использующиеся для описания текущего состояния ICE агента и его соединения с ICE сервером STUN или TURN .
Константа | Описание |
---|---|
"new" |
ICE агент собирает адреса или ожидает получения удаленных кандидатов от вызова метода RTCPeerConnection.addIceCandidate() . Или все сразу. |
"checking" |
ICE агент получил один или несколько удаленных кандидатов и проверяет парность локального и удаленного кандидатов относительно друг друга, пытаясь обнаружить совместимости. Но еще не обнаружил пару, соответствующую устанавливаемому удаленному соединению.Не исключено, что сборка кандидатов продолжиться. |
"connected" |
Совместимая парность локального и удаленного кандидатов найдена для всех компонентов соединения, и соединение было установлено. Не исключено продолжение сборки и проверки кандидатов в процессе соединения, для наилучший совместимости. |
"completed" |
Агент ICE завершил сбор кандидатов, проверил все пары относительно друг друга, и установил все соединения для всех компонентов. |
"failed" |
Агент ICE проверил все пары кандидатов между собой и не нашел совместимых сопоставлений для всех компонентов соединения. Или не нашел совместимых соединений для некоторых компонентов. |
"disconnected" |
Проверяет, что компоненты все еще подключены, хотябы для одного объекта RTCPeerConnection . Это менее строгий тест, чем "failed" , и он может периодически запускаться и разрешаться спонтанно в менее надежных сетях, или во время временного отключения. Когда проблема исчезнет, соединение может вернуться в состояние "connected". |
"closed" |
ICE агент закрыл соединение для объекта RTCPeerConnection и больше не обрабатывает запросы. |
Перечисление RTCIceGatheringState
Перечисление RTCIceGatheringState
определяет строковые константы, которые описывают текущий статус ICE сборки, возвращаемый свойством RTCPeerConnection.iceGatheringState
. Для определения изменнения этого свойства можно подписаться на событие icegatheringstatechange
.
Константы | Описание |
---|---|
"new" |
Соединение только что создано, и еще не имело сетевой активности. |
"gathering" |
Агент ICE находиться в процессе сборки кандидатов соединения. |
"complete" |
Агент ICE завершил сборку кандидатов. Если произойдет, что-то (например, добавление нового ICE сервера), для чего потребуется новая сборка кандидатов, статус переключиться в значение "gathering " и начнется пересборка кандидатов. |
Перечисление RTCIceTransportPolicy
Перечисление RTCIceTransportPolicy
определяет строковые константы, использующиеся для ограничения политик передачи ICE кандидатов, учитывающихся во время процесса соединения..
Константа | Описание |
---|---|
"all" |
Все ICE кандидаты будут рассмотрены. |
"public" |
Будут рассматриваться ICE кандидаты, только имеющие публичные IP адреса. Удален в спецификации от 13 мая 2016 (working draft). |
"relay" |
Будут рассматриваться ICE кандидаты, только с переданными IP адресами через TURN сервер. |
Перечисление RTCPeerConnectionState
Перечисление RTCPeerConnectionState
определяет строковые константы, описывающие статус RTCPeerConnection
. Эти значения возвращаются свойством (методом доступа) connectionState
. Этот статус представляет собирательный статус всех ICE передач (которые имеют тип RTCIceTransport
или RTCDtlsTransport
) , использующиеся соединением.
Константа | Описание |
---|---|
"new" |
Новый. По меньшей мере один из объектов ICE передачи (RTCIceTransport или RTCDtlsTransport ) в соединении находиться в статусе "new" и ни один из них не находиться в одном из перечисленных статусов : "connecting" , "checking" , "failed" , или "disconnected" , или все объекты передач соединения находятся в статусе "closed" . |
"connecting" |
В процессе соединения. Один или несколько объектов ICE передачи находятся в процессе установки соединения. Т.е. их свойство RTCIceConnectionState либо имеет значение "checking" , либо "connected" , и ни один из объектов передачи не находиться в статусе "failed" . <<< Make this a link once I know where that will be documented |
"connected" |
Соединен. Каждый объект ICE передачи, использующийся соединением либо используется (имеет статус "connected" или "completed" ) , либо закрыт (имеет статус "closed" ); кроме того, по крайней мере один объект передачи имеет статус либо "connected" , либо "completed" . |
"disconnected" |
Разъединен. По меньшей мере один из объектов ICE передачи в соединении имеет статус "disconnected" и ни один из объекто передачи не находиться в статусе : "failed" , "connecting" , или "checking" . |
"failed" |
Неудачно. Один или несколько объектов передачи могут находиться в статусе "failed" . |
"closed" |
Закрыто. Соединение Ранее входило в значения перечисления |
Перечисление RTCRtcpMuxPolicy
Перечисление RTCRtcpMuxPolicy
содержит строковые константы, определяющие , что собираемые кандидаты должны иметь поддержку немультиплексированного 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. |
Перечисление RTCSignalingState
Перечисление RTCSignalingState
определяет возможные значения состояния сигнализирования RTCPeerConnection.signalingState
, указывая в каком месте процесса сигнализации в настоящее время находиться обмен предложением или ответом.
Константа | Описание |
---|---|
"stable" |
Стабильно. Текущего процесса обмена предложения/ответ не происходит. Это может означать, что объект соединения |
"have-local-offer" |
Имеет локальное предложение. Локальный пир вызвал метод RTCPeerConnection.setLocalDescription() , передав в него объект описания SDP , представляющий предложение (обычно, созданного вызовом метода RTCPeerConnection.createOffer() ), и это предложение было успешно применено. |
"have-remote-offer" |
Имеет удаленное предложение. Удаленный пир создал предложение, использовал сервер сигнализации для передачи этого предложения локальному пользователю, которое было установлено им в параметр, через вызов метода RTCPeerConnection.setRemoteDescription() . |
"have-local-pranswer" |
Имеет локальный предварительный ответ. Предложение удаленного пира было применено, и ответ был создан (обычно, через вызов метода RTCPeerConnection.createAnswer() ) и использовано в параметре метода установки локального дескриптора RTCPeerConnection.setLocalDescription() . Этот предварительный ответ описывает поддерживаемые медиа форматы и тому подобное. Но он не имееет включенных в него полного набора ICE кандидатов. Позже, дополнительные кандидаты будут доставлены отдельно. |
"have-remote-pranswer" |
Имеет предварительный удаленный ответ. Предварительный удаленный ответ был получен и успешно применен в ответ на предложение, отправленное ранее и установленное методом setLocalDescription() . |
"closed" |
Закрыто. Соединение закрыто. Примечание : Это значение перенесено в перечисление |
Спецификации
Спецификация | Статус | Комментарий |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers Определение 'RTCPeerConnection' в этой спецификации. |
Кандидат в рекомендации | Initial definition. |
Совместимость с браузерами
BCD tables only load in the browser
Смотри так же
- https://github.com/jesup/nightly-gupshup/blob/master/static/js/chat.js
- http://www.html5rocks.com/en/tutorials/webrtc/basics/#toc-simple
- TutorRoom: Node.js HTML5 video capture, peer-to-peer video and filesharing application (source on GitHub)