RTCPeerConnection

Интерфейс RTCPeerConnection представляет собой подключение WebRTC между локальным компьютером и удалённым узлом. Он предоставляет методы для подключения к удалённому узлу, поддержания и мониторинга подключения, а также закрытия подключения, когда оно больше не требуется.

RTCPeerConnection()

Возвращает новый RTCPeerConnection, представляющий собой соединение между локальным устройством и удалённым узлом.

Также наследует свойства от EventTarget.

canTrickleIceCandidates Только для чтения

Возвращает значение boolean, указывающее, может ли удалённый узел принимать каскадные ICE-кандидаты.

connectionState Только для чтения

Указывает текущее состояние подключения peer, возвращая одну из строк: new, connecting, connected, disconnected, failed, или closed.

currentLocalDescription Только для чтения

Возвращает объект RTCSessionDescription, описывающий локальный конец соединения, как он был последним успешно согласован с момента последнего завершения переговоров и подключения к удалённому узлу этим RTCPeerConnection. Также включает список любых ICE-кандидатов, которые могли быть сгенерированы агентом ICE с момента первоначальной инициализации предложения или ответа, представленных описанием.

currentRemoteDescription Только для чтения

Возвращает объект RTCSessionDescription, описывающий удалённый конец соединения, как он был последним успешно согласован с момента последнего завершения переговоров и подключения к удалённому узлу этим RTCPeerConnection. Также включает список любых ICE-кандидатов, которые могли быть сгенерированы агентом ICE с момента первоначальной инициализации предложения или ответа, представленных описанием.

iceConnectionState Только для чтения

Возвращает строку, которая описывает состояние агента ICE, связанного с этим RTCPeerConnection. Она может иметь следующие значения: new, checking, connected, completed, failed, disconnected, или closed.

iceGatheringState Только для чтения

Возвращает строку, описывающую состояние сбора ICE-кандидатов подключения. Это позволяет, например, определить, когда завершился сбор ICE-кандидатов. Возможные значения: new, gathering, или complete.

localDescription Только для чтения

Возвращает RTCSessionDescription, описывающий сеанс для локального конца соединения. Если он ещё не установлен, возвращает null.

peerIdentity Только для чтения

Возвращает Promise, который разрешается в RTCIdentityAssertion, содержащую строку, идентифицирующую удалённый узел. После успешного разрешения этой промисы, полученная идентичность является идентичностью целевого узла и не будет изменяться на протяжении всего подключения.

pendingLocalDescription Только для чтения

Возвращает объект RTCSessionDescription, описывающий ожидаемое изменение конфигурации для локального конца соединения. Это не описывает соединение в текущем состоянии, а то, каким оно может быть в ближайшем будущем.

pendingRemoteDescription Только для чтения

Возвращает объект RTCSessionDescription, описывающий ожидаемое изменение конфигурации для удалённого конца соединения. Это не описывает соединение в текущем состоянии, а то, каким оно может быть в ближайшем будущем.

remoteDescription Только для чтения

Возвращает объект RTCSessionDescription, описывающий сеанс, включая конфигурацию и информацию о медиа, для удалённого конца соединения. Если он ещё не задан, возвращает null.

sctp Только для чтения

Возвращает объект RTCSctpTransport, описывающий транспортный уровень SCTP, по которому отправляются и принимаются данные SCTP. Если SCTP не был согласован, это значение равно null.

signalingState Только для чтения

Возвращает строку, описывающую состояние процесса сигнализации на локальном конце подключения во время подключения или повторного подключения к другому узлу. Это одно из следующих значений: stable, have-local-offer, have-remote-offer, have-local-pranswer, have-remote-pranswer, или closed.

RTCPeerConnection.generateCertificate()

Создаёт сертификат X.509 и соответствующий ему закрытый ключ, возвращая Promise, который разрешается с новым RTCCertificate после его генерации.

Также наследует методы от EventTarget.

addIceCandidate()

Добавляет новый удалённый кандидат в удалённое описание RTCPeerConnection, которое описывает состояние удалённого конца соединения.

addTrack()

Добавляет новый MediaStreamTrack в набор потоков, которые будут переданы другому участнику.

addTransceiver()

Создаёт новый RTCRtpTransceiver и добавляет его в набор трансиверов, связанных с соединением. Каждый трансивер представляет двунаправленный поток, с соответствующим RTCRtpSender и RTCRtpReceiver.

close()

Закрывает текущее соединение с удалённым участником.

createAnswer()

Инициализирует создание ответа SDP на полученное предложение от удалённого участника во время переговоров предложение/ответ в соединении WebRTC. Ответ содержит информацию о любых медиа, уже присоединённых к сессии, кодеках и опциях, поддерживаемых браузером, и любых ICE кандидатах, уже собранных.

createDataChannel()

Инициализирует создание нового канала, связанного с удалённым участником, по которому может передаваться любой тип данных. Это может быть полезно для сторонней информации, такой как изображения, передача файлов, текстовый чат, пакеты обновлений игры и так далее.

createOffer()

Инициализирует создание предложения SDP для начала нового соединения WebRTC с удалённым участником. Предложение SDP включает информацию о любых MediaStreamTrack объектах, уже подключенных к сессии WebRTC, кодеках и опциях, поддерживаемых браузером, а также о любых кандидатах, уже собранных агентом ICE для отправки по каналу сигнализации потенциальному участнику для запроса подключения или для обновления конфигурации существующего соединения.

getConfiguration()

Возвращает объект, который указывает текущую конфигурацию соединения.

getIdentityAssertion()

Инициализирует сбор утверждения идентичности и возвращает Promise, который разрешается в утверждение идентичности, закодированное как строка. Это оказывает влияние только в том случае, если signalingState не closed.

getReceivers()

Возвращает массив объектов RTCRtpReceiver, каждый из которых представляет один приёмник RTP.

getSenders()

Возвращает массив объектов RTCRtpSender, каждый из которых представляет отправителя RTP, ответственного за передачу данных одного потока.

getStats()

Возвращает Promise, который разрешается данными, предоставляющими статистику либо по всему соединению, либо по указанному MediaStreamTrack.

getTransceivers()

Возвращает список всех объектов RTCRtpTransceiver, используемых для отправки и получения данных по соединению.

removeTrack()

Указывает локальному концу соединения прекратить отправку медиа из указанного потока, не удаляя фактически соответствующий RTCRtpSender из списка отправителей, как показано в getSenders(). Если поток уже остановлен или не входит в список отправителей соединения, этот метод не оказывает влияния.

restartIce()

Позволяет легко запросить повторный сбор ICE кандидатов на обоих концах соединения. Это упрощает процесс, позволяя одному и тому же методу быть использованным как вызывающей стороной, так и стороной, принимающей вызов, для запуска перезапуска ICE.

setConfiguration()

Устанавливает текущую конфигурацию соединения на основе значений, включённых в указанный объект. Это позволяет изменять ICE серверы, используемые соединением, и политики транспортировки.

setIdentityProvider()

Устанавливает поставщика идентификации (IdP) в тройку, заданную в параметре: его имя, протокол, используемый для связи с ним, и имя пользователя. Протокол и имя пользователя являются необязательными.

setLocalDescription()

Изменяет локальное описание, связанное с соединением. Это описание определяет свойства локального конца соединения, включая формат медиа. Возвращает Promise, который выполняется после асинхронного изменения описания.

setRemoteDescription()

Устанавливает указанное описание сессии как текущее предложение или ответ удалённого участника. Описание определяет свойства удалённого конца соединения, включая формат медиа. Возвращает Promise, который выполняется после асинхронного изменения описания.

addStream() Устаревший Нестандартный

Добавляет MediaStream как локальный источник аудио или видео. Вместо использования этого устаревшего метода, используйте addTrack() для каждого потока, который вы хотите отправить удалённому участнику.

createDTMFSender() Устаревший Нестандартный

Создаёт новый RTCDTMFSender, связанный с конкретным MediaStreamTrack, который сможет отправлять DTMF сигналы по соединению.

removeStream() Устаревший Нестандартный

Удаляет MediaStream как локальный источник аудио или видео. Вместо этого используйте removeTrack().

Прослушивайте эти события с помощью addEventListener() или назначив обработчик событий к свойству oneventname этого интерфейса.

connectionstatechange

Отправляется, когда изменяется общий статус подключения к RTCPeerConnection.

datachannel

Отправляется, когда удалённый участник добавляет RTCDataChannel к подключению.

icecandidate

Отправляется для запроса передачи указанного кандидата удалённому участнику.

icecandidateerror

Отправляется в подключение, если во время сбора кандидатов ICE произошла ошибка. Событие описывает ошибку.

iceconnectionstatechange

Отправляется, когда изменяется состояние подключения ICE, например, при отключении.

icegatheringstatechange

Отправляется, когда изменяется состояние сбора ICE слоя, отражённое в iceGatheringState. Это указывает, началась ли ICE-независимая проверка (new), началось ли собирание кандидатов (gathering) или процесс завершён (complete).

negotiationneeded

Отправляется, когда требуется выполнить согласование или повторное согласование подключения ICE; это может произойти как при первом открытии подключения, так и при необходимости адаптации к изменяющимся сетевым условиям. Получатель должен ответить, создав предложение и отправив его другому участнику.

signalingstatechange

Отправляется, когда изменяется состояние сигнализации ICE подключения.

track

Отправляется после добавления нового трека в один из RTCRtpReceiver экземпляров, составляющих подключение.

addstream Устаревшее Нестандартное

Отправляется, когда к подключению добавлен новый MediaStream. Вместо прослушивания этого устаревшего события, следует прослушивать события track; одно событие отправляется для каждого MediaStreamTrack добавленного к подключению.

removestream Устаревшее Нестандартное

Отправляется, когда MediaStream удаляется из подключения. Вместо прослушивания этого устаревшего события, следует прослушивать события removetrack на каждом потоке.

• https://github.com/jesup/nightly-gupshup/blob/master/static/js/chat.js
• Начало работы с WebRTC
• TutorRoom: приложение для обмена видео и файлами по технологии peer-to-peer и захвата видео с помощью Node.js HTML (исходный код на GitHub)