Webrtc-rtcdatachannel-apis

提供:Dev Guides
移動先:案内検索

WebRTC-RTCDataChannel API

WebRTCは、オーディオストリームとビデオストリームの転送に優れているだけでなく、任意のデータを持っている可能性があります。 これは、RTCDataChannelオブジェクトが作用する場所です。

RTCDataChannel API

プロパティ

  • * RTCDataChannel.label(読み取り専用)*-データチャネル名を含む文字列を返します。
  • * RTCDataChannel.ordered(読み取り専用)*-メッセージの配信順序が保証されている場合はtrueを、保証されていない場合はfalseを返します。
  • * RTCDataChannel.protocol(読み取り専用)*-このチャネルに使用されるサブプロトコル名を含む文字列を返します。
  • * RTCDataChannel.id(読み取り専用)*-RTCDataChannelオブジェクトの作成時に設定されたチャネルの一意のIDを返します。
  • * RTCDataChannel.readyState(読み取り専用)*-接続の状態を表すRTCDataChannelState列挙を返します。 可能な値-
  • connecting -接続がまだアクティブではないことを示します。 これは初期状態です。
  • open -接続が実行されていることを示します。
  • closing -接続がシャットダウンの処理中であることを示します。 キャッシュされたメッセージは送受信中ですが、新しく作成されたタスクは受け付けていません。
  • closed -接続を確立できなかったか、シャットダウンされたことを示します。
  • * RTCDataChannel.bufferedAmount(読み取り専用)*-送信のためにキューに入れられたバイト数を返します。 これは、RTCDataChannel.send()を介してまだ送信されていないデータの量です。
  • RTCDataChannel.bufferedAmountLowThreshold -RTCDataChannel.bufferedAmountがローとして使用されるバイト数を返します。 RTCDataChannel.bufferedAmountがこのしきい値を下回ると、bufferedamountlowイベントが発生します。
  • RTCDataChannel.binaryType -接続によって送信されたバイナリデータのタイプを返します。 「blob」または「arraybuffer」にすることができます。
  • * RTCDataChannel.maxPacketLifeType(読み取り専用)*-メッセージングが信頼性の低いモードになっているときのウィンドウのミリ秒単位の長さを示す符号なしshortを返します。
  • * RTCDataChannel.maxRetransmits(読み取り専用)*-配信されない場合にチャネルがデータを再送信する最大回数を示す符号なしショートを返します。
  • * RTCDataChannel.negotiated(読み取り専用)*-チャネルがユーザーエージェントまたはアプリケーションによってネゴシエートされたかどうかを示すブール値を返します。
  • * RTCDataChannel.reliable(読み取り専用)*-接続が信頼できないモードでメッセージを送信できることを示すブール値を返します。
  • * RTCDataChannel.stream(読み取り専用)*-RTCDataChannel.idの同義語

イベントハンドラ

  • RTCDataChannel.onopen -このイベントハンドラは、openイベントが発生したときに呼び出されます。 このイベントは、データ接続が確立されたときに送信されます。
  • RTCDataChannel.onmessage -このイベントハンドラは、メッセージイベントが発生したときに呼び出されます。 データチャネルでメッセージが利用可能になると、イベントが送信されます。
  • RTCDataChannel.onbufferedamountlow -このイベントハンドラは、bufferedamoutlowイベントが発生したときに呼び出されます。 このイベントは、RTCDataChannel.bufferedAmountがRTCDataChannel.bufferedAmountLowThresholdプロパティを下回ったときに送信されます。
  • RTCDataChannel.onclose -このイベントハンドラは、closeイベントが発生したときに呼び出されます。 このイベントは、データ接続が閉じられたときに送信されます。
  • RTCDataChannel.onerror -このイベントハンドラは、エラーイベントが発生したときに呼び出されます。 このイベントは、エラーが発生したときに送信されます。

方法

  • * RTCDataChannel.close()*-データチャネルを閉じます。
  • * RTCDataChannel.send()*-パラメーターのデータをチャネル経由で送信します。 データは、blob、文字列、ArrayBufferまたはArrayBufferViewのいずれかです。