定義する connectionCreated そして connectionDestroyed イベントが
によってディスパッチされた セッション オブジェクトがある。
Session オブジェクトは connectionCreated クライアント(
自身のクライアントを含む)がセッションに接続した際のイベントです。また、 connectionCreated 初回接続時に、
セッション内のすべてのクライアントに対してイベントが発生します。(ローカルクライアントが接続すると、
Session オブジェクトも sessionConnected イベント(以下で定義される)
SessionConnectEvent (クラス)
セッションに接続している間、Session オブジェクトは
connectionDestroyed 別のクライアントがセッションから切断された際のイベント。
(切断すると、セッションオブジェクトも sessionDisconnected
イベント。これは、 セッション切断イベント (クラス)
例
以下のコードは、
を監視することで、セッションへの接続数の累計を算出します。 connections プロパティの sessionConnect,
connectionCreated そして connectionDestroyed のイベントがある:
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 connectionCount = 0;
var session = OT.initSession(apiKey, sessionID);
session.on("connectionCreated", function(event) {
connectionCount++;
displayConnectionCount();
});
session.on("connectionDestroyed", function(event) {
connectionCount--;
displayConnectionCount();
});
session.connect(token);
function displayConnectionCount() {
document.getElementById("connectionCountField").value = connectionCount.toString();
}
この例では、HTML DOM 内に入力テキストフィールドがあり、
その id に設定する。 "connectionCountField":
<input type="text" id="connectionCountField" value="0"></input>
プロパティ
| 名称 | タイプ | 説明 |
|---|---|---|
connection |
接続 | 作成または削除された接続に対応するConnectionオブジェクト。 |
connections |
配列 | 非推奨です。代わりに connection プロパティ。A connectionCreated または connectionDestroyed セッション内で接続が確立または切断されるたびに、このイベントがディスパッチされます。 |
reason |
ストリング | の場合 connectionDestroyed イベント、接続が切断された理由の説明。このプロパティには、以下の値が設定可能です: - "clientDisconnected" — クライアントが を呼び出してセッションから切断しました。 disconnect() Session オブジェクトのメソッドを使用するか、ブラウザを閉じることで。 (参照: Session.disconnect().) - "forceDisconnected" — モデレーターが、 forceDisconnect() Session オブジェクトのメソッド。(参照: Session.forceDisconnect().) - "mediaIdle" — クライアントは、接続から4時間以内にストリームのパブリッシュまたはサブスクライブを行わなかったため、セッションから切断されました - "networkDisconnected" — ネットワーク接続が突然切断され(たとえば、クライアントのインターネット接続が切断された場合など)、Vonage Video API プラットフォームによってそのことが検出されました。 - "serverRotation" — クライアントは、以下の理由によりセッションから切断されました。 Video API サーバーのローテーション. 状況によっては、この説明により、開発者はイベントへの対応策を微調整できる場合があります。 例えば、 connectionCreated イベントの場合、この文字列は未定義となります。 |
方法
| 名称 | 説明 |
|---|---|
isDefaultPrevented() → {Boolean} |
デフォルトのイベント動作が、以下の呼び出しによって阻止されたかどうか preventDefault() (true)または(false). |
preventDefault() |
そのイベントに関連するデフォルトの動作が行われるのを防ぎます。 |
isDefaultPrevented() →{Boolean}
デフォルトのイベント動作が、以下の呼び出しによって阻止されたかどうか
preventDefault() (true)または(false).
参照 preventDefault().
リターンズ
preventDefault()
そのイベントに関連するデフォルトの動作が行われるのを防ぎます。
イベントにデフォルトの動作があるかどうかを確認するには、 cancelable イベントオブジェクトの
プロパティ。
に電話する。 preventDefault() そのイベントのコールバック関数内のメソッド。
以下のイベントには、デフォルトの動作が設定されています:
sessionDisconnect— 参照 SessionDisconnectEvent.preventDefault().streamDestroyed— 参照 StreamEvent.preventDefault().accessDialogOpened— 詳しくは accessDialogOpened イベント.accessDenied— 詳しくは accessDenied イベント.