Home Reference Source
public class | source

RTCDataChannel

Extends:

src/PeerConnection/RTCDataChannelEventTarget.js~DATA_CHANNEL_EVENTSsrc/PeerConnection/RTCDataChannelEventTarget.js~RTCDataChannelEventTarget → RTCDataChannel

DataChannel 接続を表すオブジェクトです。

Constructor Summary

Public Constructor
public

RTCDataChannel のオブジェクトを生成します。 ユーザはここから直接 RTCDataChannel インスタンスを作成することはありません。

Member Summary

Public Members
public get

送信できるデータのbinaryType を表します。 現在は 'arraybuffer' のみ対応しています。

public set

送信できるデータのbinaryType を表します。 現在は 'arraybuffer' のみ対応しています。

public get

DataChannel の現在の bufferedAmount を表します。

public

DataChannel の bufferedAmount に対するしきい値です。 bufferedAmount がこの値以下になったとき、onbufferedamountlow イベントが発火します。 デフォルト値は 0 です。

public get

DataChannel の id を表します。 デフォルトは -1 です。 DataChannel の作成時にのみ指定可能です。

public get

DataChannel のラベルを表します。 DataChannel の作成時にのみ指定可能です。

public get

DataChannel の maxPacketLifeTime を表します。 デフォルトは null です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get

DataChannel の maxRetransmits を表します。 デフォルトは null です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get

DataChannel の negotiated フラグです。 デフォルトは false です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get

DataChannel の ordered フラグです。 デフォルトは false です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get

DataChannel の user-defined に指定した protocol を表します。 デフォルトは '' です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get

DataChannel の現在の接続状態を表します。

Method Summary

Public Methods
public

close(): void

RTCDataChannel の接続を閉じます。

public

send(data: string | ArrayBuffer | ArrayBufferView): Promise<void>

RTCDataChannel でデータを送信します。

Public Constructors

public constructor(info: Object) source

RTCDataChannel のオブジェクトを生成します。 ユーザはここから直接 RTCDataChannel インスタンスを作成することはありません。

Params:

NameTypeAttributeDescription
info Object

Listen:

open

RTCEvent: readyStateopen になると送信されます。

closing

RTCEvent: readyStateclosing になると送信されます。

close

RTCEvent: readyStateclosed になると送信されます。

message

RTCDataChannelMessageEvent: リモートからデータを受信すると送信されます。

bufferedamountlow

RTCEvent: bufferedAmount が bufferedAmountLowThreshold で指定した値以下になると送信されます。

Public Members

public get binaryType: string source

送信できるデータのbinaryType を表します。 現在は 'arraybuffer' のみ対応しています。

public set binaryType: string source

送信できるデータのbinaryType を表します。 現在は 'arraybuffer' のみ対応しています。

public get bufferedAmount: number source

DataChannel の現在の bufferedAmount を表します。

public bufferedAmountLowThreshold: number source

DataChannel の bufferedAmount に対するしきい値です。 bufferedAmount がこの値以下になったとき、onbufferedamountlow イベントが発火します。 デフォルト値は 0 です。

public get id: number source

DataChannel の id を表します。 デフォルトは -1 です。 DataChannel の作成時にのみ指定可能です。

public get label: string source

DataChannel のラベルを表します。 DataChannel の作成時にのみ指定可能です。

public get maxPacketLifeTime: number | null source

DataChannel の maxPacketLifeTime を表します。 デフォルトは null です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get maxRetransmits: number | null source

DataChannel の maxRetransmits を表します。 デフォルトは null です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get negotiated: boolean source

DataChannel の negotiated フラグです。 デフォルトは false です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get ordered: boolean source

DataChannel の ordered フラグです。 デフォルトは false です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get protocol: string source

DataChannel の user-defined に指定した protocol を表します。 デフォルトは '' です。 DataChannel の作成時にのみ指定可能です。 Android ではこのプロパティの取得は未対応です。

public get readyState: RTCDataChannelState source

DataChannel の現在の接続状態を表します。

Public Methods

public close(): void source

RTCDataChannel の接続を閉じます。

Return:

void

public send(data: string | ArrayBuffer | ArrayBufferView): Promise<void> source

RTCDataChannel でデータを送信します。

Params:

NameTypeAttributeDescription
data string | ArrayBuffer | ArrayBufferView

送信するデータ

Return:

Promise<void>

結果を表す Promise