RTCPeerConnection

RTCPeerConnection インターフェイスはローカルコンピューターとリモートピア間の WebRTC コネクションを表現します。このインターフェイスはリモートピアへ接続や、その接続の保守や監視するメソッド、さらに、不要になった接続を閉じるメソッドを提供します。

廃止されたメソッド

以下のメソッドは廃止されており、すべての主要なブラウザーで未実装です。

RTCPeerConnection.createDTMFSender() これは廃止された API であり、動作は保証されていません。
特定の MediaStreamTrack と関連付けられた新たな RTCDTMFSender (en-US) を生成します。これにより、その接続において DTMF 音(電話のトーン信号、プッシュ音)を送れるようになるでしょう。

イベント

これらのイベントを待ち受けするには、 addEventListener() を使用するか、イベントリスナーをこのインターフェイスの onイベント名 プロパティに代入するかしてください。

connectionstatechange (en-US)
RTCPeerConnection の全体的な接続ステータスが変更されると、 RTCPeerConnection オブジェクトに送信されます。
onconnectionstatechange (en-US) イベントハンドラプロパティからも使用できます。
datachannel (en-US)
Sent to the RTCPeerConnection object when the remote peer adds an RTCDataChannel to the connection.
Also available through the ondatachannel (en-US) event handler property.
icecandidate (en-US)
Sent to the peer connection to request that the specified candidate be transmitted to the remote peer.
Also available through the onicecandidate (en-US) event handler property.
icecandidateerror (en-US)
An error of type RTCPeerConnectionIceErrorEvent (en-US) which is sent to the connection if an error occurred during ICE candidate gathering. The event's properties describe the error.
Also available through the onicecandidateerror (en-US) event handler property.
iceconnectionstatechange (en-US)
Sent to the RTCPeerConnection when the state of the ICE connection changes, such as when it disconnects.
Also available using the oniceconnectionstatechange (en-US) event handler property.
icegatheringstatechange (en-US)
Sent to the RTCPeerConnection when the ICE layer's gathering state, reflected by iceGatheringState (en-US), changes. This indicates whether ICE negotiation has not yet begun (new), has begun gathering candidates (gathering), or has completed (complete).
Also available using the onicegatheringstatechange (en-US) event handler property.
isolationchange
Sent to the RTCPeerConnection when the isolated property on one of the MediaStreamTrack objects associated with the connection changes value. A track is isolated if its content cannot be accessed by the owning document due to lack of authentication or if the track comes from a cross-origin source.
Also available through the onisolationchange event handler property.
negotiationneeded (en-US)
Sent to the RTCPeerConnection when negotiation or renegotiation of the ICE connection needs to be performed; this can happen both when first opening a connection as well as when it's neccessary to adapt to changing network conditions. The receiver should respond by creating an offer and sending it to the other peer.
Also available as the onnegotiationneeded (en-US) event handler property.
signalingstatechange (en-US)
The signalingstatechange event is sent to the RTCPeerConnection when the connection's ICE signaling state changes.
Also available through the onsignalingstatechange (en-US) event handler property.
statsended
The statsended event is sent when a statistics object being monitored is deleted. The RTCStatsEvent includes the final report on the deleted object (or objects, if multiple objects have been deleted since the last report was delivered). A statistics object is deleted, for example, when the connection is closed and deleted.
Available as the onstatsended event handler property.
track (en-US)
The track event is sent after a new track has been added to one of the RTCRtpReceiver (en-US) instances which comprise the connection.
Available as the ontrack (en-US) event handler property.

廃止されたイベント

addstream (en-US) これは廃止された API であり、動作は保証されていません。
Sent when a new MediaStream has been added to the connection. Instead of watching for this obsolete event, you should watch each for track (en-US) events; one is sent for each MediaStreamTrack added to the connection.
Available as the onaddstream (en-US) event handler property.
identityresult これは廃止された API であり、動作は保証されていません。
In old versions of the WebRTC specification, this event was used to indicate that an identity assertion is available. Now, you should instead wait for a the promise returned by peerIdentity (en-US) to resolve with an identity.
Also available using the onidentityresult event handler property.
idpassertionerror これは廃止された API であり、動作は保証されていません。
In old versions of the WebRTC specification, this event was used to indicate that an error occurred while attempting to generate an identity assertion. Now, you should instead wait for a the promise returned by peerIdentity (en-US) to be rejected with an error.
Also available as the onidpinsertionerror event handler property.
idpvalidationerror これは廃止された API であり、動作は保証されていません。
In old versions of the WebRTC specification, this event was used to indicate that an error occurred while attempting to validate an identity assertion. Now, you should instead wait for a the promise returned by peerIdentity (en-US) to be rejected with an error.
Also available using the onpeerdentity event handler property.
peeridentity これは廃止された API であり、動作は保証されていません。
In old versions of the WebRTC specification, this event was used to deliver a received identity. Now, you should instead wait for a the promise returned by peerIdentity (en-US) to resolve with an identity.
removestream (en-US) これは廃止された API であり、動作は保証されていません。
Sent to the RTCPeerConnection when a MediaStream is removed from the connection. Instead of watching for this obsolete event, you should watch each stream for removetrack (en-US) events on each stream within the RTCPeerConnection.
Also available as the onaddstream (en-US) event handler property.

定数

RTCBundlePolicy 列挙型

この RTCBundlePolicy 列挙型は、リモートピアが、単一の転送リンクにおいて複数のメディアストリームをまとめるための SDP BUNDLE standard と互換していない場合に、ICEの候補を収集するために特定のポリシーを要求する時に使用される文字列定数を定義します。

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

Constant Description
"balanced" On BUNDLE-aware connections, the ICE agent should gather candidates for all of the media types in use (audio, video, and data). Otherwise, the ICE agent should only negotiate one audio and video track on separate transports.
"max-compat" The ICE agent should gather candidates for each track, using separate transports to negotiate all media tracks for connections which aren't BUNDLE-compatible.
"max-bundle" The ICE agent should gather candidates for just one track. If the connection isn't BUNDLE-compatible, then the ICE agent should negotiate just one media track.

RTCIceConnectionState 列挙型

The RTCIceConnectionState enum defines the string constants used to describe the current state of the ICE agent and its connection to the ICE server (that is, the STUN (en-US) or TURN (en-US) server).

Constant Description
"new" The ICE agent is gathering addresses or is waiting to be given remote candidates through calls to RTCPeerConnection.addIceCandidate() (en-US) (or both).
"checking" The ICE agent has been given one or more remote candidates and is checking pairs of local and remote candidates against one another to try to find a compatible match, but has not yet found a pair which will allow the peer connection to be made. It's possible that gathering of candidates is also still underway.
"connected" A usable pairing of local and remote candidates has been found for all components of the connection, and the connection has been established. It's possible that gathering is still underway, and it's also possible that the ICE agent is still checking candidates against one another looking for a better connection to use.
"completed" The ICE agent has finished gathering candidates, has checked all pairs against one another, and has found a connection for all components.
"failed" The ICE candidate has checked all candidates pairs against one another and has failed to find compatible matches for all components of the connection. It is, however, possible that the ICE agent did find compatible connections for some components.
"disconnected" Checks to ensure that components are still connected failed for at least one component of the RTCPeerConnection. This is a less stringent test than "failed" and may trigger intermittently and resolve just as spontaneously on less reliable networks, or during temporary disconnections. When the problem resolves, the connection may return to the "connected" state.
"closed" The ICE agent for this RTCPeerConnection has shut down and is no longer handling requests.

RTCIceGatheringState 列挙型

The RTCIceGatheringState enum defines string constants which reflect the current status of ICE gathering, as returned using the RTCPeerConnection.iceGatheringState (en-US) property. You can detect when this value changes by watching for an event of type icegatheringstatechange.

Constant Description
"new" The peer connection was just created and hasn't done any networking yet.
"gathering" The ICE agent is in the process of gathering candidates for the connection.
"complete" The ICE agent has finished gathering candidates. If something happens that requires collecting new candidates, such as a new interface being added or the addition of a new ICE server, the state will revert to "gathering" to gather those candidates.

RTCIceTransportPolicy 列挙型

The 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.

Constant Description
"all" All ICE candidates will be considered.
"public" これは廃止された API であり、動作は保証されていません。 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.

RTCPeerConnectionState 列挙型

The RTCPeerConnectionState enum defines string constants which describe states in which the RTCPeerConnection may be. These values are returned by the connectionState (en-US) property. This state essentially represents the aggregate state of all ICE transports (which are of type RTCIceTransport (en-US) or RTCDtlsTransport (en-US)) being used by the connection.

Constant Description
"new" At least one of the connection's ICE transports (RTCIceTransport (en-US)s or RTCDtlsTransport (en-US)s) are in the "new" state, and none of them are in one of the following states: "connecting", "checking", "failed", or "disconnected", or all of the connection's transports are in the "closed" state.
"connecting" One or more of the ICE transports are currently in the process of establishing a connection; that is, their RTCIceConnectionState is either "checking" or "connected", and no transports are in the "failed" state. <<< Make this a link once I know where that will be documented
"connected" Every ICE transport used by the connection is either in use (state "connected" or "completed") or is closed (state "closed"); in addition, at least one transport is either "connected" or "completed".
"disconnected" At least one of the ICE transports for the connection is in the "disconnected" state and none of the other transports are in the state "failed", "connecting", or "checking".
"failed" One or more of the ICE transports on the connection is in the "failed" state.
"closed"

The RTCPeerConnection is closed.

This value was in the RTCSignalingState enum (and therefore found by reading the value of the signalingState (en-US)) property until the May 13, 2016 draft of the specification.

RTCRtcpMuxPolicy 列挙型

The 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.

Constant Description
"negotiate" Instructs the ICE agent to gather both RTP (en-US) and RTCP (en-US) 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 列挙型

The RTCSignalingState enum specifies the possible values of RTCPeerConnection.signalingState (en-US), which indicates where in the process of signaling the exchange of offer and answer the connection currently is.

Constant Description
"stable" There is no ongoing exchange of offer and answer underway. This may mean that the RTCPeerConnection object is new, in which case both the localDescription (en-US) and remoteDescription (en-US) are null; it may also mean that negotiation is complete and a connection has been established.
"have-local-offer" The local peer has called RTCPeerConnection.setLocalDescription() (en-US), passing in SDP representing an offer (usually created by calling RTCPeerConnection.createOffer() (en-US)), and the offer has been applied successfully.
"have-remote-offer" The remote peer has created an offer and used the signaling server to deliver it to the local peer, which has set the offer as the remote description by calling RTCPeerConnection.setRemoteDescription() (en-US).
"have-local-pranswer" The offer sent by the remote peer has been applied and an answer has been created (usually by calling RTCPeerConnection.createAnswer() (en-US)) and applied by calling RTCPeerConnection.setLocalDescription() (en-US). This provisional answer describes the supported media formats and so forth, but may not have a complete set of ICE candidates included. Further candidates will be delivered separately later.
"have-remote-pranswer" A provisional answer has been received and successfully applied in response to an offer previously sent and established by calling setLocalDescription().
"closed" これは廃止された API であり、動作は保証されていません。

The connection is closed.

Note: This value moved into the RTCPeerConnectionState enum in the May 13, 2016 draft of the specification, as it reflects the state of the RTCPeerConnection, not the signaling connection. You now detect a closed connection by checking for connectionState (en-US) to be "closed" instead.

仕様書

仕様書 状態 備考
WebRTC 1.0: Real-time Communication Between Browsers
RTCPeerConnection の定義
勧告候補 初回定義

ブラウザーの互換性

BCD tables only load in the browser

関連情報