コールバック¶
Sora JavaScript SDK には WebRTC API のイベントや Sora 固有の機能のイベントをハンドリングするためのコールバックを用意しています。
ここではそのコールバックの利用方法について説明します。
track¶
自分以外 の音声や映像のメディアストリームが追加、 または削除されたタイミングで発火するコールバックです。
import Sora from "sora-js-sdk";
const conn = Sora.connection('ws://192.0.2.100:5000/signaling', true);
const client = conn.sendrecv("sora", null, {"multistream": true});
// track で上がってくるのは RTCEventTrack
client.on("track", (event: RTCEventTrack) => {
// ここにトラックイベントの処理を書く
});
// メディアストリームを取得
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
// Sora に繫ぐ
client.connect(mediaStream);
参考¶
removetrack¶
自分以外 の音声や映像のメディアストリームが削除されたタイミングで発火するコールバックです。
このコールバックは MediaStream の onremovetrack をラップしています。
import Sora from "sora-js-sdk";
const conn = Sora.connection('ws://192.0.2.100:5000/signaling', true);
const client = conn.sendrecv("sora", null, {"multistream": true});
// removetrack で上がってくるのは MediaStreamTrackEvent
client.on("removetrack", (event: MediaStreamTrackEvent) => {
// ここにトラック削除イベントの処理を書く
});
// メディアストリームを取得
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
// Sora に繫ぐ
client.connect(mediaStream);
参考¶
disconnect¶
Sora からクライアントが切断したタイミングで発火するコールバックです。
disconnect メソッドが呼ばれた場合
PeerConnecion の state が正常な状態では無くなった場合に強制終了する場合
上記以外で何かしらの異常があった場合
push¶
Sora のシグナリングで利用している通信経路経由でプッシュ通知が送られてきたタイミングで発火するコールバックです
WebSocket 経由でのシグナリングのプッシュ通知
DataChannel 経由でのシグナリングのプッシュ通知
import Sora from "sora-js-sdk";
const conn = Sora.connection('ws://192.0.2.100:5000/signaling', true);
const client = conn.sendrecv("sora", null, {"multistream": true});
client.on("push", (message: SignalingPushMessage, transportType: TransportType) => {
// ここにシグナリング経由のプッシュ通知の処理を書く
});
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
client.connect(mediaStream);
参考¶
addstream¶
危険
このコールバックは廃止予定のコールバックです
PeerConnection の ontrack でトラックが追加されたタイミングで発火するコールバックです。
このコールバックは以前 PeerConnection に存在していた onaddstream コールバックの後方互換用ですが、 将来的に廃止予定ですので、利用は避けてください。
参考¶
removestream¶
危険
このコールバックは廃止予定のコールバックです
PeerConnection の ontrack でトラックが削除されたタイミングで発火するコールバックです。
このコールバックは以前 PeerConnection に存在していた onremovestream コールバックの後方互換用ですが、 将来的に廃止予定ですので、利用は避けてください。 もし利用する場合は removetrack を利用してください。
参考¶
notify¶
Sora のシグナリングで利用している通信経路経由での通知が送られてきた場合に発火するコールバックです。
参考¶
timeout¶
Sora との接続でシグナリングは成功したが、WebRTC 接続が成功せずタイムアウトしたタイミングで発火するコールバックです。
シグナリングの開始には WebSocket over TLS を利用するため、ほとんどの環境で接続が成功します。 ただし、その後の WebRTC の接続が失敗する場合があります。
その場合は Sora 側から WebSocket を切断するのですが、 ネットワークの問題などでクライアントがそれに気付けない状況への対策となります。
message¶
メッセージング機能を利用した際に、メッセージを受信したタイミングで発火するコールバックです。
参考¶
datachannel¶
DataChannel 経由シグナリングを利用した際に、利用可能な各データチャネルが利用に可能になったタイミングで発火するコールバックです。
メッセージング機能などを利用している場合はこちらのコールバックを利用して、メッセージングが送れるようになったかどうかを判断してください。
参考¶
signaling¶
注釈
この機能はログ出力用のコールバックです
Sora とのシグナリングメッセージを送受信した際に発火するコールバックです。
WebSocket と DataChannel 経由でのシグナリングメッセージが取得可能です。
log¶
注意
この機能はデバッグ用のトレースログ出力用のコールバックです
SDK のトレースログを出力した際に発火するコールバックです。
このコールバックは debug が false でも発火します。
timeline¶
注意
この機能はデバッグ用のタイムラインログ出力用のコールバックです
クライアントの主要なイベントが発生した際に発火するコールバックです。
主に、クライアントの挙動を時系列に確認するために利用するためのデバッグ向けコールバックになっています。