Session オブジェクトは、セッションが切断された際に SessionDisconnectEvent オブジェクトをディスパッチします。
このイベントは、
disconnect() セッションオブジェクトのメソッド。
例
以下のコードは、セッションを初期化し、セッションが 切断された際のイベントリスナーを設定します。
コピー
var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
var sessionID = ""; // Replace with your own session ID.
// See https://tokbox.com/developer/guides/create-session/
var token = ""; // Replace with a generated token that has been assigned the moderator role.
// See https://tokbox.com/developer/guides/create-token/
var session = OT.initSession(apiKey, sessionID);
session.on("sessionDisconnected", function(event) {
alert("The session disconnected. " + event.reason);
});
session.connect(token);
プロパティ
| 名称 | タイプ | 説明 |
|---|---|---|
reason |
ストリング | セッションが切断された理由の説明。このプロパティには、以下の値が設定可能です： - "clientDisconnected" — クライアントが、 disconnect() Session オブジェクトのメソッドを使用するか、ブラウザを閉じることで。（参照： Session.disconnect().) - "forceDisconnected" — モデレーターが、 forceDisconnect() Session オブジェクトのメソッド。（参照： Session.forceDisconnect().) - "mediaIdle" — クライアントは、接続後4時間以内にストリームのパブリッシュまたはサブスクライブを行わなかったため、セッションから切断されました。 - "networkDisconnected" — ネットワーク接続が突然切断され（たとえば、クライアントのインターネット接続が切断された場合など）、Vonage Video API プラットフォームによってそのことが検出されました。を配信する前に、 sessionDisconnected この理由により、Session オブジェクトは reconnecting イベントが発生し、クライアントはVonage Video APIセッションへの再接続を試みます。再接続に失敗した場合、Sessionオブジェクトは sessionDisconnected ～とのイベント reason プロパティを "networkDisconnected". - "serverRotation" — 以下の理由により、クライアントはセッションから切断されました。 Video API サーバーのローテーション. |
方法
| 名称 | 説明 |
|---|---|
isDefaultPrevented() → {Boolean} |
デフォルトのイベント動作が、以下の呼び出しによって阻止されたかどうか preventDefault() (true)または(false). |
preventDefault() |
そのイベントに関連するデフォルトの動作が行われるのを防ぎます。 |
isDefaultPrevented() →{Boolean}
デフォルトのイベント動作が、以下の呼び出しによって阻止されたかどうか
preventDefault() (true)または(false).
参照 preventDefault().
リターンズ
preventDefault()
そのイベントに関連するデフォルトの動作が行われるのを防ぎます。
については sessionDisconnectEvent, デフォルトでは、すべての
Subscriber オブジェクトの登録が解除され、HTML DOM から削除されます。各
Subscriber オブジェクトは、 destroyed 要素が
HTML DOM から削除された際のイベントです。もし preventDefault()
のイベントリスナー内のメソッド sessionDisconnect イベントでは、
デフォルトの動作が抑制され、必要に応じて独自のコードを使用して
Subscriber オブジェクトをクリーンアップすることができます）。
イベントにデフォルトの動作があるかどうかを確認するには、
cancelable イベントオブジェクトのプロパティ。
に電話する。 preventDefault() そのイベント用のイベントリスナー関数内の
メソッド。