Home Reference Source
public class | source

RTCPeerConnection

Extends:

src/PeerConnection/RTCPeerConnectionEventTarget.js~PEER_CONNECTION_EVENTSsrc/PeerConnection/RTCPeerConnectionEventTarget.js~RTCPeerConnectionEventTarget → RTCPeerConnection

クライアントとの接続を表すオブジェクトです。

Constructor Summary

Public Constructor
public

constructor(configuration: RTCConfiguration | null, constraints: RTCMediaConstraints | null)

オブジェクトを生成し、リモートのピアまたはサーバーに接続します。

Member Summary

Public Members
public

クライアントとの総合的な接続状態を表します。

public

ICE 接続の状態を表します。

public

ICE ギャザリングの状態を表します。

public

ローカルマシンで生成した SDP です。

public

レシーバーのリスト。 リストの並びは順不同です。

since 1.1.0
public

リモートから受信した SDP です。

public

センダーのリスト。 リストの並びは順不同です。

since 1.1.0
public

シグナリング接続の状態を表します。

public

トランシーバーのリスト。 リストの並びは順不同です。

since 1.1.0

Method Summary

Public Methods
public

ICE candidate を追加します。

public
this method was deprecated. ストリームの操作は廃止されました。 addTrack() を使用してください。
version 1.1.0
public

addStream(stream: RTCMediaStream): void

this method was deprecated. ストリームの操作は廃止されました。 addTrack() を使用してください。
version 1.1.0
public

指定したストリームにトラックを追加します。

since 1.1.0
public

close(): void

接続を解除します。 すべてのストリームの接続も閉じられます。

public

Answer SDP を生成します。

public

DataChannel を作成します。

since 2020.3.0
public

Offer SDP を生成します。

public
this method was deprecated. ストリームの操作は廃止されました。 senders を使用してください。
version 1.1.0
public
this method was deprecated. ストリームの操作は廃止されました。 receivers を使用してください。
version 1.1.0
public
this method was deprecated. ストリームの操作は廃止されました。 removeTrack() を使用してください。
version 1.1.0
public

removeTrack(sender: RTCRtpSender): Promise<void>

送信用のトラックを取り除きます。

since 1.1.0
public

setConfiguration(configuration: RTCConfiguration): void

設定を反映します。

public

setLocalDescription(sessionDescription: RTCSessionDescription): Promise<void>

ローカルの SDP を設定します。

public

setRemoteDescription(sessionDescription: RTCSessionDescription): Promise<void>

リモートの SDP を設定します。

Public Constructors

public constructor(configuration: RTCConfiguration | null, constraints: RTCMediaConstraints | null) source

オブジェクトを生成し、リモートのピアまたはサーバーに接続します。

Params:

NameTypeAttributeDescription
configuration RTCConfiguration | null
  • optional
  • default: null

設定

constraints RTCMediaConstraints | null
  • optional
  • default: null

メディアに関する制約

Listen:

connectionstatechange

RTCEvent: connectionState が変更されると送信されます。

icecandidate

RTCIceCandidateEvent: ICE Candidate が生成されると送信されます。

iceconnectionstatechange

RTCEvent: iceConnectionState が変更されると送信されます。

icegatheringstatechange

RTCIceCandidateEvent | RTCIceCandidateEvent: iceGatheringState が変更されると送信されるイベント

negotiationneeded

RTCEvent: ネゴシエーションが必要になったときに送信されます。

signalingstatechange

RTCEvent: signalingState が変更されると送信されます。

track

RTCEvent: RTCPeerConnection にトラックが追加・削除されると送信されます。

datachannel

RTCDataChannelEvent: RTCPeerConnection に DataChannel がリモートから追加されると送信されます。

addstream

このイベントは廃止されました。

removestream

このイベントは廃止されました。

Public Members

public connectionState: RTCPeerConnectionState source

クライアントとの総合的な接続状態を表します。

public iceConnectionState: RTCIceConnectionState source

ICE 接続の状態を表します。

public iceGatheringState: RTCIceGatheringState source

ICE ギャザリングの状態を表します。

public localDescription: RTCSessionDescription | nullliteral source

ローカルマシンで生成した SDP です。

public receivers: Array<RTCRtpReceiver> since 1.1.0 source

レシーバーのリスト。 リストの並びは順不同です。

public remoteDescription: RTCSessionDescription | nullliteral source

リモートから受信した SDP です。

public senders: Array<RTCRtpSender> since 1.1.0 source

センダーのリスト。 リストの並びは順不同です。

public signalingState: RTCSignalingState source

シグナリング接続の状態を表します。

public transceivers: Array<RTCRtpTransceiver> since 1.1.0 source

トランシーバーのリスト。 リストの並びは順不同です。

Public Methods

public addIceCandidate(candidate: RTCIceCandidate): Promise<Void> source

ICE candidate を追加します。

Params:

NameTypeAttributeDescription
candidate RTCIceCandidate

ICE candidate

Return:

Promise<Void>

結果を示す Promise

public addLocalStream(stream: RTCMediaStream): void version 1.1.0 source

this method was deprecated. ストリームの操作は廃止されました。 addTrack() を使用してください。

Params:

NameTypeAttributeDescription
stream RTCMediaStream

Return:

void

public addStream(stream: RTCMediaStream): void version 1.1.0 source

this method was deprecated. ストリームの操作は廃止されました。 addTrack() を使用してください。

Params:

NameTypeAttributeDescription
stream RTCMediaStream

Return:

void

public addTrack(track: RTCMediaStreamTrack, streamIds: Array<string>): Promise<RTCRtpSender> since 1.1.0 source

指定したストリームにトラックを追加します。

Params:

NameTypeAttributeDescription
track RTCMediaStreamTrack

追加するトラック

streamIds Array<string>

トラックを追加するストリーム ID

Return:

Promise<RTCRtpSender>

結果を表す Promise 。追加されたトラックを返す

public close(): void source

接続を解除します。 すべてのストリームの接続も閉じられます。

Return:

void

public createAnswer(constraints: RTCMediaConstraints): Promise<RTCSessionDescription> source

Answer SDP を生成します。

Params:

NameTypeAttributeDescription
constraints RTCMediaConstraints

制約

Return:

Promise<RTCSessionDescription>

生成結果を示す Promise

public createDataChannel(label: string, options: RTCDataChannelInit | null): Promise<RTCDataChannel> since 2020.3.0 source

DataChannel を作成します。

Params:

NameTypeAttributeDescription
label string

DataChannel の label

options RTCDataChannelInit | null

DataChannel で指定するオプション

Return:

Promise<RTCDataChannel>

結果を表す Promise。作成した DataChannel を返す

public createOffer(constraints: RTCMediaConstraints): Promise<RTCSessionDescription> source

Offer SDP を生成します。

Params:

NameTypeAttributeDescription
constraints RTCMediaConstraints

制約

Return:

Promise<RTCSessionDescription>

生成結果を示す Promise

public getLocalStreams(): Array<RTCMediaStream> version 1.1.0 source

this method was deprecated. ストリームの操作は廃止されました。 senders を使用してください。

public getRemoteStreams(): Array<RTCMediaStream> version 1.1.0 source

this method was deprecated. ストリームの操作は廃止されました。 receivers を使用してください。

public removeLocalStream(stream: RTCMediaStream): void version 1.1.0 source

this method was deprecated. ストリームの操作は廃止されました。 removeTrack() を使用してください。

Params:

NameTypeAttributeDescription
stream RTCMediaStream

Return:

void

public removeTrack(sender: RTCRtpSender): Promise<void> since 1.1.0 source

送信用のトラックを取り除きます。

Params:

NameTypeAttributeDescription
sender RTCRtpSender

取り除くトラック

Return:

Promise<void>

public setConfiguration(configuration: RTCConfiguration): void source

設定を反映します。

Params:

NameTypeAttributeDescription
configuration RTCConfiguration

設定

Return:

void

public setLocalDescription(sessionDescription: RTCSessionDescription): Promise<void> source

ローカルの SDP を設定します。

Params:

NameTypeAttributeDescription
sessionDescription RTCSessionDescription

設定する SDP

Return:

Promise<void>

セットした結果を示す Promise

public setRemoteDescription(sessionDescription: RTCSessionDescription): Promise<void> source

リモートの SDP を設定します。

Params:

NameTypeAttributeDescription
sessionDescription RTCSessionDescription

設定する SDP

Return:

Promise<void>

セットした結果を示す Promise