によって返される Session オブジェクトは、 OT.initSession() このメソッドを使用すると、 Vonage Video API の機能の多くを利用できます。

プロパティ

方法

addEventListener(type, listener, context)

パラメータ：

非推奨 — 使い方 on() または once() その代わりだ。

このメソッドは、特定のイベントのイベントリスナーとしてメソッドを登録します。

イベントに対してハンドラが登録されていない場合、そのイベントはローカルでは無視されます。 イベントリスナー関数が存在しない場合、そのイベントはローカルでは無視されます。

以下の場合、例外をスローします。 listener 名前が無効です。

参照： : - on() - once() - イベント

connect(token, completionHandler)

Vonage Video APIのセッションに接続します。

接続に成功すると、完了ハンドラ（メソッドの2番目のパラメータ）が、 エラーオブジェクトが渡されることなく呼び出されます。（接続中にエラーが発生した場合は、 エラーオブジェクトが渡されて完了ハンドラが呼び出されます。）Sessionオブジェクトの他のメソッドを呼び出す前に、 セッションへの接続が正常に完了していることを確認してください。

Session オブジェクトは connectionCreated クライアント（ 自身のクライアントを含む）がセッションに接続した際のイベント。

例

以下のコードは、セッションを初期化し、セッションが 接続された際のイベントリスナーを設定します：

 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.
                 // See https://tokbox.com/developer/guides/create-token/.

 var session = OT.initSession(apiKey, sessionID);
 session.connect(token, function(error) {
   if (error) {
     console.log(error.message);
   } else {
     // You have connected to the session. You could publish a stream now.
   }
 });

ディスパッチされたイベント：

exception (例外イベント) — エラーが発生した場合、 現地のOTクラスによって送信されます。

connectionCreated (ConnectionEvent) — セッションに接続しているすべてのクライアントに対して、Session オブジェクトによって送信されます。

sessionConnected (SessionConnectEvent) — 接続が確立された際に、Session オブジェクトによってローカルで呼び出されます。ただし、 の 2 番目のパラメータとして、完了ハンドラ関数を渡すこともできます。 connect() そして、この関数を、 sessionConnected イベントを開催する。

パラメータ：

参照： : - SessionConnectEvent

disableForceMute() →{Promise}

セッションのアクティブなミュート状態を解除します。このメソッドを呼び出した後、 セッションに公開される新しいストリームの音声は、ミュートされなくなります。

に電話をかけた後、 Session.forceMuteAll() メソッド（または別の クライアントのモデレーターが、すべてのストリームをミュートする呼び出しを行った場合）、モデレーションの呼び出し後に配信されるストリームは すべて、音声がミュートされた状態で配信されます。 disableForceMute() セッションの ミュート状態を解除する方法（これにより、新たに公開されるストリームが自動的にミュートされるのを防ぐ）。

このメソッドを呼び出すと、接続中の各クライアントのSessionオブジェクトが muteForced イベントで active フラグが false.

チェック capabilities.canForceMute Session オブジェクトのプロパティを確認して、 この関数を正常に呼び出せるかどうかを確認してください。これは、モデレーターの役割が割り当てられたトークンを使用して接続した クライアント専用です（ トークン作成 （ドキュメント）。

参照： : - Session.capabilities - Session.forceMuteAll() - muteForced イベント

リターンズ

操作が正常に完了した際に、値を持たない状態で解決されるプロミス。 エラーが発生した場合は、プロミスは拒否されます。 name Error オブジェクトのプロパティは、エラーの種類に応じて、以下のいずれかの 値に設定されます：

• 'OT_NOT_CONNECTED' — クライアントはセッションに接続されていません。
• 'OT_PERMISSION_DENIED' — ユーザーのロールには、 他のユーザーを強制的にミュートにするために必要な権限が含まれていません。 ユーザーのロールは、ユーザートークンを作成する際に定義します（ トークン作成の概要). トークン文字列を connect() Session オブジェクトのメソッド。
• 'OT_UNEXPECTED_SERVER_RESPONSE' — サーバー内部エラーが発生した場合。

disconnect() →{Promise.<void>}

Vonage Video API セッションを切断します。

を呼び出す。 disconnect() このメソッドは、セッションとの接続を終了させます。接続の 終了処理の過程で、ユーザーが配信していたストリームの 配信もすべて停止されます。

リモートクライアント上のセッションオブジェクトのディスパッチ streamDestroyed 配信していた 任意のストリームに対するイベント。Session オブジェクトは、 sessionDisconnected ローカルでイベントを処理します。リモートクライアント上のSessionオブジェクトは、 connectionDestroyed イベントを発生させ、他の接続先にセッションを離れたことを通知します。その セッション切断イベント そして ストリームイベント を定義するオブジェクト sessionDisconnect そして connectionDestroyed 各イベントにはそれぞれ reason プロパティ。その reason このプロパティにより、開発者は、 接続が自発的に終了されているかどうか、および基となる接続の自発的な終了に伴い、 ストリームが破棄されているかどうかを判断できます。

セッションが現在接続されていない場合、このメソッドを呼び出すと警告がログに記録されます。 参照 OT.setLogLevel().

注： 1つのPublisherオブジェクトを再利用して、異なるセッション （または同じセッション）に対して順次パブリッシュを行う場合は、 streamDestroyed Publisher オブジェクトによってディスパッチされるイベント（パブリッシングが停止したとき）。イベントリスナー内で、 以下のメソッドを呼び出します。 preventDefault() イベントオブジェクトのメソッドを使用して、パブリッシャーの 動画がページから削除されるのを防ぎます。

ディスパッチされたイベント：

sessionDisconnected (セッション切断イベント) — 接続が切断された際に、ローカルで送信されます。

connectionDestroyed (ConnectionEvent) — 他のクライアントにも、以下の内容とともに送信されました。 streamDestroyed イベント（必要に応じて）。

streamDestroyed (ストリームイベント) — セッションの切断によりストリームが失われた場合、他のクライアントに配信されます。

リターンズ

sessionDisconnected イベントが発生した際に解決されるプロミス

forceDisconnect(connection, completionHandler) →{Promise.<void>}

セッションを終了するために、リモート接続を強制的に切断します。

について forceDisconnect() この方法は通常、進行中のセッションからユーザーを排除するための モデレーションツールとして使用されます。

接続が forceDisconnect(), sessionDisconnected, connectionDestroyed そして streamDestroyed イベントは、接続が を使用して自ら切断された場合と同様にディスパッチされます。 disconnect() メソッド。しかし、その reason プロパティの ConnectionEvent または ストリームイベント object は以下を指定します "forceDisconnected" その理由として 接続およびストリームが切断されたことを挙げます。

以下の方法を使用することもできますが、 forceDisconnect() 自身の接続を終了させる方法として、 以下の関数を呼び出すことで、 disconnect() この方法の方が簡単です。

OTオブジェクトは、 exception たとえユーザーのロールに、 他のユーザーを強制的に切断させるために必要な権限が含まれていない場合でも。 ユーザーのロールは、ユーザートークンを作成する際に定義します（ トークン作成の概要). 参照 例外イベント そして OT.on().

セッションが接続されていない場合、アプリケーションはエラーを発生させます。

ディスパッチされたイベント：

connectionDestroyed (ConnectionEvent) — 接続が切断されたクライアント以外のクライアントについて。

exception (例外イベント) — このユーザーの権限では、他のユーザーを強制的に切断させることはできません (event.code = 1530), または、指定されたストリームがセッションに配信されていない場合（event.code = 1535).

sessionDisconnected (セッション切断イベント) — 接続が切断されたクライアント上で。

streamDestroyed (ストリームイベント) — 接続が切断された結果、ストリームが停止した場合。

パラメータ：

リターンズ

接続が切断されたときに解決されるプロミス

forceMuteAll(excludedStreams) →{Promise}

そのセッションに参加しているすべての配信者（除外されたストリームを配信している配信者を除く）に対し、 音声をミュートするように強制します。

を呼び出すモデレーターによって公開されたストリーム。 forceMuteAll() このメソッドは、 セッション内の他のストリームと同様にミュートされます。ただし、モデレーターのストリームを 「除外ストリーム」配列に追加した場合はこの限りではありません。

もし excludedStreams パラメータが設定されると、セッション内のすべてのストリーム （モデレーターのストリームを含む）で音声の配信が停止します：

session.forceMuteAll();

また、以下の呼び出しの後に発行されるストリームは、すべて forceMuteAll() メソッド は、音声をミュートした状態で公開されます。セッションのミュート状態を解除するには、 disableForceMute() Session オブジェクトのメソッド。

session.disableForceMute();

を呼び出した後 Session.disableForceMute() この方法により、セッションに新たに配信されるストリームでは、 音声がミュートされることはなくなります。

このメソッドを呼び出すと、ストリームを配信しているクライアント内のPublisherオブジェクトが ディスパッチを実行します muteForced イベント。また、セッションに接続している各クライアント内の Sessionオブジェクトは、 muteForced イベント（～を含む） active イベントオブジェクトの true).

チェック capabilities.canForceMute Session オブジェクトのプロパティを確認して、 この関数を正常に呼び出せるかどうかを確認してください。これは、モデレーターの役割が割り当てられたトークンを使用して接続した クライアント専用です（ トークン作成 （ドキュメント）。

パラメータ：

参照： : - Session.capabilities - Session.forceMuteStream() - Session.disableForceMute() - セッションのmuteForcedイベント - パブリッシャーによる強制ミュートイベント - セッション内の ストリームの音声をミュートする

リターンズ

操作が正常に完了した際に、値を持たない状態で解決されるプロミス。 エラーが発生した場合は、プロミスは拒否されます。 name Error オブジェクトのプロパティは、エラーの種類に応じて、以下のいずれかの 値に設定されます：

• 'OT_NOT_CONNECTED' — クライアントはセッションに接続されていません。
• 'INVALID_PARAMETER' — 渡されたパラメータのうち1つ以上が無効な場合。
• 'OT_PERMISSION_DENIED' — ユーザーのロールには、 他のユーザーを強制的にミュートにするために必要な権限が含まれていません。 ユーザーのロールは、ユーザートークンを作成する際に定義します（ トークン作成の概要). トークン文字列を connect() Session オブジェクトのメソッド。
• 'OT_UNEXPECTED_SERVER_RESPONSE' — サーバー内部エラーが発生した場合。

forceMuteStream(stream) →{Promise}

指定されたストリームの配信者に、音声のミュートを強制します。

このメソッドを呼び出すと、ストリームをパブリッシュしているクライアント側の Publisher オブジェクトが をディスパッチします。 muteForced イベントを開催する。

チェック capabilities.canForceMute Session オブジェクトのプロパティを確認して、 この関数を正常に呼び出せるかどうかを確認してください。これは、モデレーターの役割が割り当てられたトークンを使用して接続した クライアント専用です（ トークン作成 （ドキュメント）。

パラメータ：

参照： : - Session.capabilities - Session.forceMuteAll() - パブリッシャーによる強制ミュートイベント - セッション内の ストリームの音声をミュートする

リターンズ

操作が正常に完了した際に、値を持たない状態で解決されるプロミス。 エラーが発生した場合は、プロミスは拒否されます。 name Error オブジェクトのプロパティは、エラーの種類に応じて、以下のいずれかの 値に設定されます：

• 'OT_NOT_CONNECTED' — クライアントはセッションに接続されていません。
• 'OT_INVALID_PARAMETER' — 渡されたパラメータのうち1つ以上が無効な場合。
• 'OT_PERMISSION_DENIED' — ユーザーのロールには、 他のユーザーを強制的にミュートにするために必要な権限が含まれていません。 ユーザーのロールは、ユーザートークンを作成する際に定義します（ トークン作成の概要). トークン文字列を connect() Session オブジェクトのメソッド。
• 'OT_NOT_FOUND' — このセッションでは、そのストリームが見つかりませんでした。
• 'OT_UNEXPECTED_SERVER_RESPONSE' — サーバー内部エラーが発生した場合。

forceUnpublish(stream, completionHandler) →{Promise.<void>}

指定されたストリームの配信元に対し、そのストリームの配信を停止するよう強制します。

このメソッドを呼び出すと、Session オブジェクトは streamDestroyed ストリームを購読しているすべてのクライアント（ストリームを 公開しているクライアントを含む）で発生するイベント。この reason StreamEvent オブジェクトの property は 次のように設定されています "forceUnpublished".

OTオブジェクトは、 exception たとえユーザーのロールに、 他のユーザーの公開取り消しを強制するために必要な権限が含まれていない場合でも。 ユーザーのロールは、ユーザートークンを作成する際に定義します（ トークン作成の概要). トークン文字列を connect() Session オブジェクトのメソッド。参照： 例外イベント そして OT.on().

ディスパッチされたイベント：

exception (例外イベント) — このユーザーの権限では、他のユーザーに公開取り下げを強制することはできません。

streamDestroyed (ストリームイベント) — ストリームの公開が解除されました。Sessionオブジェクトは、このストリームを購読しているすべてのクライアント およびパブリッシャーのクライアントに対して、この通知を送信します。

パラメータ：

リターンズ

「非公開化」が行われた際に解決する約束

getPublisherForStream(stream) → {出版社}

指定されたストリームのローカルな Publisher オブジェクトを返します。

パラメータ：

参照： : - forceUnpublish() - 購読者 - ストリームイベント

リターンズ

指定されたストリームに対する Publisher オブジェクト。以下を返します。 null 指定されたストリームに対して、 ローカルの Publisher オブジェクトが存在しない場合。

getSubscribersForStream(stream) →{Array}

指定されたストリームに対するローカルなSubscriberオブジェクトの配列を返します。

パラメータ：

参照： : - unsubscribe() - 購読者 - ストリームイベント

リターンズ

の配列。 購読者 指定されたストリームのオブジェクト。

off(type, handler, context) →{Object}

1つまたは複数のイベントハンドラを削除します。

イベント名を1つとハンドラメソッドを1つ渡すと、その イベントのハンドラが削除されます：

obj.off("eventName", eventHandler);

複数のイベント名とハンドラメソッドを渡した場合、それらのイベントについては ハンドラが削除されます：

obj.off("eventName1 eventName2", eventHandler);

イベント名（1つまたは複数）を指定して いいえ ハンドラメソッドでは、それらのイベントに対して すべてのハンドラが削除されます：

obj.off("event1Name event2Name");

引数を指定しない場合は、 すべて そのオブジェクトによってディスパッチされたすべてのイベントについて、 イベントハンドラが削除されます：

obj.off();

このメソッドは、別の構文もサポートしています。この構文では、最初のパラメータは イベント名とハンドラ関数のハッシュマップであるオブジェクトとなり、2番目のパラメータ（オプション）は 各ハンドラにおけるこのオブジェクトのコンテキストとなります：

obj.off(
   {
      eventName1: event1Handler,
      eventName2: event2Handler
   });

パラメータ：

参照： : - on() - once() - イベント

リターンズ

イベントを発生させたオブジェクト。

on(type, handler, context) → {EventDispatcher}

1つ以上のイベントに対するイベントハンドラ関数を追加します。

次のコードは、1つのイベントに対するイベントハンドラを追加します：

obj.on("eventName", function (event) {
    // This is the event handler.
});

複数のイベント名とハンドラメソッドを渡すと、それらのイベントそれぞれに対して ハンドラが登録されます：

obj.on("eventName1 eventName2",
       function (event) {
           // This is the event handler.
       });

3つ目を渡すこともできます context （オプションの）パラメータを使用して、 の値を定義します。 this ハンドラメソッド内で：

obj.on("eventName",
       function (event) {
           // This is the event handler.
       },
       obj);

このメソッドは、別の構文もサポートしています。この構文では、最初のパラメータはイベント名とハンドラ関数のハッシュマップであるオブジェクトとなり、2番目のパラメータ（オプション）は、各ハンドラにおけるこのオブジェクトのコンテキストとなります：

obj.on(
   {
      eventName1: function (event) {
              // This is the handler for eventName1.
          },
      eventName2:  function (event) {
              // This is the handler for eventName2.
          }
   },
   obj);

イベントに対するハンドラを追加しない場合、そのイベントはローカルでは無視されます。

パラメータ：

参照： : - off() - once() - イベント

リターンズ

EventDispatcher オブジェクト。

once(type, handler, context) →{Object}

1つ以上のイベントに対するイベントハンドラ関数を追加します。ハンドラが呼び出されると、 指定されたハンドラメソッドは、このイベントのハンドラとして削除されます。（ on() イベントハンドラを追加する方法として、そのハンドラは 違う （呼び出された際に削除されます。）その once() このメソッドは、 を呼び出すことと同じです。 on() メソッドと呼び出し off() ハンドラが最初に呼び出されたとき。

次のコードは、1つのイベントに対して1回限りのイベントハンドラを追加します：

obj.once("eventName", function (event) {
   // This is the event handler.
});

複数のイベント名とハンドラメソッドを渡すと、それらのイベントそれぞれに対して ハンドラが登録されます：

obj.once("eventName1 eventName2"
         function (event) {
             // This is the event handler.
         });

3つ目を渡すこともできます context （オプションの）パラメータを使用して、 の値を定義します this ハンドラメソッド内で：

obj.once("eventName",
         function (event) {
             // This is the event handler.
         },
         obj);

このメソッドは、別の構文もサポートしています。この構文では、最初のパラメータは イベント名とハンドラ関数のハッシュマップであるオブジェクトとなり、2番目のパラメータ（オプション）は 各ハンドラにおけるこのオブジェクトのコンテキストとなります：

obj.once(
   {
      eventName1: function (event) {
                 // This is the event handler for eventName1.
          },
      eventName2:  function (event) {
                 // This is the event handler for eventName1.
          }
   },
   obj);

パラメータ：

参照： : - on() - off() - イベント

リターンズ

イベントを発生させたオブジェクト。

publish(publisher, completionHandler)

について publish() このメソッドは、セッションへの音声・動画ストリームの配信を開始します。 音声・動画ストリームは、ローカルのマイクとウェブカメラからキャプチャされます。配信が正常に 完了すると、接続中のすべてのクライアント上の Session オブジェクトが streamCreated イベントを開催する。

このメソッドの唯一のパラメータとして、Publisher オブジェクトを渡します。 Publisher オブジェクトは、 OT.initPublisher() メソッド。呼び出す前に Session.publish().

このメソッドには別の形式があります： publish(targetElement: String | HTMLElement, properties: Object, completionHandler: Function): Publisher — このフォームでは、次のように入力してください 違う 関数に Publisher オブジェクトを渡すのではなく、代わりに targetElement （対象のHTML要素、またはパブリッシャーにおける対象のHTML要素のID）、オプションの properties Publisher のオプションを定義するオブジェクト（参照： OT.initPublisher())、およびオプションの完了ハンドラ関数。 このメソッドは新しい Publisher オブジェクトを返し、そのオブジェクトがセッションへの オーディオ・ビデオストリームの送信を開始します。このドキュメントの残りの部分では、単一の Publisher オブジェクトをパラメータとして受け取る形式について説明します。

公開されたストリームのローカル表示は、DOM内の指定された要素をストリーミング動画表示に置き換えることで、 Webページ上に作成されます。 動画ストリームは 自動的に水平方向にミラーリングされるため、ユーザーはストリーム内の自分自身や動きを 自然な形で確認できます。表示領域の幅と高さが 動画信号のアスペクト比 4:3 と一致しない場合、動画ストリームは表示領域に合わせて トリミングされます。

このメソッドを呼び出した際に新しい Publisher オブジェクトが作成され、Vonage Video API ライブラリが カメラまたはマイクへのアクセス権を持っていない場合、Web ページはユーザーに対し、カメラおよびマイクへの アクセス権を許可するよう促します。

OTオブジェクトは、 exception たとえユーザーのロールに 公開に必要な権限が含まれていない場合でも。たとえば、ユーザーのロールが「購読者」に設定されている場合、 そのユーザーは公開を行うことができません。ユーザーのロールは、ユーザートークンを作成する際に定義します （参照： トークン作成の概要). トークン文字列を connect() Session オブジェクトのメソッド。参照： 例外イベント そして OT.on().

セッションが接続されていない場合、アプリケーションはエラーを発生させます。

ディスパッチされたイベント：

exception (例外イベント) — OTオブジェクトによって 送信されます。これは、ユーザーのロールに公開権限がない場合に発生することがあります（ code イベントオブジェクトのプロパティが 1500 に設定されている場合）だけでなく、 接続に失敗した場合にも発生する可能性があります（ code イベントオブジェクトのプロパティが 1013 に設定されている）。 WebRTC はピアツーピアプロトコルであるため、接続に失敗する場合があります。 失敗の最も一般的な原因は、プロトコルが通過できないファイアウォールです。

streamCreated (ストリームイベント) — ストリームが公開されました。Sessionオブジェクトは、このストリームを購読しているすべてのクライアント およびパブリッシャーのクライアントに対して、このイベントを配信します。

例

次の例は、セッションが接続されると動画を公開するものです：

var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
var sessionId = ""; // Replace with your own session ID.
                    // /developer/guides/create-session/.
var token = ""; // Replace with a generated token that has been assigned the publish role.
                // See https://tokbox.com/developer/guides/create-token/.
var session = OT.initSession(apiKey, sessionID);
session.connect(token, function(error) {
  if (error) {
    console.log(error.message);
  } else {
    var publisherOptions = {width: 400, height:300, name:"Bob's stream"};
    // This assumes that there is a DOM element with the ID 'publisher':
    publisher = OT.initPublisher('publisher', publisherOptions);
    session.publish(publisher);
  }
});

パラメータ：

リターンズ

このストリームの Publisher オブジェクト。

removeEventListener(type, listener, context)

パラメータ：

非推奨 — 使い方 off() その代わりだ。

特定のイベントに対するイベントリスナーを解除します。

以下の場合、例外をスローします。 listener 名前が無効です。

参照： : - off() - イベント

setEncryptionSecret(secret) →{Promise}

エンドツーエンド暗号化が有効になっているセッションの暗号化シークレットを設定します。暗号化が有効になっていないセッションでこのメソッドが呼び出された場合、 この関数は正常に処理され、エラーは発生しません。ユーザーは、設定済みの暗号化キーを いつでも変更できます。エンドツーエンド暗号化については、 開発者ガイド.

パラメータ：

参照： : - OT.initSession - 加入者向けイベント

リターンズ

操作が正常に完了した際に、値を持たない状態で解決されるプロミス。 エラーが発生した場合は、プロミスは拒否されます。 name Error オブジェクトのプロパティは、エラーの種類に応じて、以下のいずれかの 値に設定されます：

• 'OT_INVALID_ENCRYPTION_SECRET'; パスワードが無効です。

エラーがディスパッチされない場合、密かな不一致が発生する可能性があります。詳しくは 加入者向けイベント をご覧ください。

setIceConfig(newIceConfig)

セッション内のすべての接続に対してICE設定を指定します。これにより、以前に 設定されていたICE設定はすべて上書きされます。

この機能は、 設定可能 TURNサーバーアドオン.

パラメータ：

参照： : - OT.initSession()

signal(signal, completionHandler) →{Promise.<void>}

セッション内の各クライアント、または指定したクライアントにシグナルを送信します。指定する to プロパティの signal 特定のクライアントにのみシグナルを送信するように制限するパラメータ。 このパラメータを指定しない場合、そのセッションに接続している すべてのクライアントにシグナルが送信されます。

次の例では、指定されたデータペイロード（「hello」）を含む「foo」型のシグナルを、 そのセッションに接続しているすべてのクライアントに送信します：

try {
  await session.signal({
    type: "foo",
    data: "hello"
  });
  console.log("signal sent");
} catch (error) {
  console.log("signal error: " + error.message);
}

受信クライアントを指定せずにこのメソッドを呼び出す（ to の属性 signal パラメータ）を設定すると、複数のシグナルが送信されます（セッション内の各 クライアントに1つずつ）。シグナリングの料金については、 Vonage Video API の料金体系 ページを参照されたい。

次の例では、データペイロード（「hello」）を含む「foo」型のシグナルを、 そのセッションに接続している特定のクライアントに送信します：

try {
  await session.signal({
    type: "foo",
    to: recipientConnection, // a Connection object
    data: "hello"
  });
  console.log("signal sent");
} catch (error) {
  console.log("signal error: " + error.message);
}

のイベントハンドラを追加します signal セッション内で送信されるすべてのシグナルを監視するためのイベント。 このイベントのイベントハンドラを追加します。 signal:type 指定されたタイプのシグナルのみを リッスンするイベント（ type, において signal:type, （監視対象のシグナルの種類を指定して）。Session オブジェクトは、これらのイベントをディスパッチします。（参照： イベント.)

パラメータ：

参照： : - 信号 そして signal:type イベント

リターンズ

シグナルが送信された時点で解決するプロミス

subscribe(stream, targetElement, properties, completionHandler) → {購読者}

そのセッションで利用可能なストリームを購読します。利用可能なストリームの配列は、 から取得できます。 streams プロパティの sessionConnected そして streamCreated イベント（参照： SessionConnectEvent そして ストリームイベント).

購読したストリームは、DOM内の指定された要素を ストリーミング動画の表示に置き換えることで、ローカルWebページ上に表示されます。表示領域の幅と高さが 動画信号のアスペクト比4:3と一致しない場合、動画ストリームは表示領域に合わせて トリミングされます。 ストリームにビデオコンポーネントが含まれていない場合、ビデオストリームの代わりに、 オーディオインジケーターが表示された空白の画面が表示されます。

セッションが接続されていない場合、または targetElement HTML DOM には存在しません。

例

以下のコードは、他のクライアントのストリームを購読するものです：

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.
                // See https://tokbox.com/developer/guides/create-token/.

var session = OT.initSession(apiKey, sessionID);
session.on("streamCreated", function(event) {
  subscriber = session.subscribe(event.stream, targetElement);
});
session.connect(token);

パラメータ：

リターンズ

このストリームのSubscriberオブジェクト。ストリーム制御機能は、 Subscriberオブジェクトを通じて利用可能です。

unpublish(publisher)

指定されたパブリッシャーのオーディオ・ビデオストリームの セッションへの配信を停止します。デフォルトでは、オーディオ・ビデオストリームのローカル表現が Webページから削除されます。終了が正常に行われると、接続されているすべての Webページ上のSessionオブジェクトが a streamDestroyed イベントを開催する。

パブリッシャーがDOMから削除されるのを防ぐには、 streamDestroyed Publisher オブジェクトによってディスパッチされたイベントを呼び出し、 preventDefault() イベントオブジェクトのメソッド。

注： 1つのPublisherオブジェクトを再利用して、異なるセッション （または同じセッション）に対して順次パブリッシュを行う場合は、 streamDestroyed Publisher オブジェクトによってディスパッチされるイベント（パブリッシングが停止したとき）。イベントリスナー内で、 以下のメソッドを呼び出します。 preventDefault() イベントオブジェクトのメソッドを使用して、パブリッシャーの 動画がページから削除されるのを防ぎます。

ディスパッチされたイベント：

streamDestroyed (ストリームイベント) — パブリッシャーに関連付けられたストリームが破棄されました。このイベントは、 パブリッシャーのブラウザ上でパブリッシャーによって送信されました。また、 パブリッシャーのストリームを購読している他のすべての接続において、セッションオブジェクトによって送信されました。

例

次の例では、ストリームをセッションに配信し、 Web ページに「切断」リンクを追加します。このリンクをクリックすると、ストリームの配信が停止します。

<script>
  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.
                  // See https://tokbox.com/developer/guides/create-token/.
  var publisher;
  var session = OT.initSession(apiKey, sessionID);
  session.connect(token, function(error) {
    if (error) {
      console.log(error.message);
    } else {
      // This assumes that there is a DOM element with the ID 'publisher':
      publisher = OT.initPublisher('publisher');
      session.publish(publisher);
    }
  });

  function unpublish() {
    session.unpublish(publisher);
  }
</script>

<body>

    <div id="publisherContainer/>
    <br/>

    [Stop Publishing](javascript:unpublish())

</body>

パラメータ：

参照： : - publish() - streamDestroyed イベント

購読解除（購読者）

セッション内のストリームの購読を停止します。オーディオ・ビデオストリームの表示が ローカルのウェブページから削除されます。

例

以下のコードは、他のクライアントのストリームを購読します。また、各ストリームについて、 このコードは「購読解除」リンクも追加します。

var apiKey = ""; // Replace with your API key. See 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.
                // See https://tokbox.com/developer/guides/create-token/.
var streams = [];

var session = OT.initSession(apiKey, sessionID);
session.on("streamCreated", function(event) {
    var stream = event.stream;
    displayStream(stream);
});
session.connect(token);

function displayStream(stream) {
    var div = document.createElement('div');
    div.setAttribute('id', 'stream' + stream.streamId);

    var subscriber = session.subscribe(stream, div);
    subscribers.push(subscriber);

    var aLink = document.createElement('a');
    aLink.setAttribute('href', 'javascript: unsubscribe("' + subscriber.id + '")');
    aLink.innerHTML = "Unsubscribe";

    var streamsContainer = document.getElementById('streamsContainer');
    streamsContainer.appendChild(div);
    streamsContainer.appendChild(aLink);

    streams = event.streams;
}

function unsubscribe(subscriberId) {
    console.log("unsubscribe called");
    for (var i = 0; i < subscribers.length; i++) {
        var subscriber = subscribers[i];
        if (subscriber.id == subscriberId) {
            session.unsubscribe(subscriber);
        }
    }
}

パラメータ：

参照： : - subscribe()

イベント

アーカイブの開始

セッションのアーカイブ録画が開始されたときに送信されます。

参照： : - アーカイブイベント - アーカイブの概要

アーカイブ停止

セッションのアーカイブ録画が停止したときに送信されます。

参照： : - アーカイブイベント - アーカイブの概要

接続が作成されました

新しいクライアント（自身を含む）がセッションに接続した際にディスパッチされ、また、 セッション内の各クライアントが最初に接続した際にもディスパッチされます。（Session オブジェクトも a sessionConnected （ローカルクライアントが接続した際のイベント。）

参照： : - ConnectionEvent - OT.initSession()

接続が切断されました

ご自身のクライアント以外のクライアントが、セッションから切断されました。

参照： : - ConnectionEvent

cpuPerformanceChanged

CPUのパフォーマンス状態が変更されました。これは、 「nominal」、「fair」、「serious」、または「critical」のいずれかに設定できます。

参照： : - CpuPerformanceChangedEvent

muteForced

モデレーターが、そのセッションにストリームを配信しているクライアントに対し、音声をミュートするよう強制しました（その active この MuteForcedEvent オブジェクトのプロパティは、 true)、あるいは モデレーターがセッション内の音声ミュート状態を無効にした場合（その active この MuteForcedEvent オブジェクトのプロパティは、 false).

参照： : - MuteForcedEvent - Session.forceMuteAll() - Session.disableForceMute() - セッション内の ストリームの音声をミュートする

sessionConnected

クライアントがVonage Video APIセッションに接続しました。このイベントは、 への呼び出しが成功したことを受けて、非同期的にディスパッチされます。 connect() Session オブジェクトのメソッド。 connect() メソッドでは、 を呼び出してセッションを初期化します。 OT.initSession() メソッド。コード例や詳細については、 以下を参照してください。 Session.connect().

参照： : - SessionConnectEvent - Session.connect() - OT.initSession()

セッションが切断されました

クライアントがセッションから切断されました。このイベントは、 への呼び出しが成功したことを受けて、非同期的にディスパッチされる場合があります。 disconnect() Session オブジェクトのメソッド。 また、ネットワーク接続が切断された場合など、意図せずセッション接続が失われた際にも、 このイベントがディスパッチされることがあります。

デフォルトの動作では、すべてのSubscriberオブジェクトの登録が解除され、 HTML DOMから削除されます。各Subscriberオブジェクトは、 destroyed 要素がHTML DOMから 削除されたときに発生するイベントです。もし preventDefault() イベントのリスナー内の メソッド sessionDisconnect イベントが発生すると、デフォルトの動作は抑制され、 必要に応じて、独自のコードを使用してSubscriberオブジェクトをクリーンアップすることができます。

について reason イベントオブジェクトのこのプロパティは、クライアントが 切断された理由を示します。

参照： : - Session.disconnect() - Session.forceDisconnect() - セッション切断イベント

sessionReconnected

ローカルクライアントは、一時的に接続が切断された後、Vonage Video API セッションに再接続しました。 接続が切断されると、Session オブジェクトは sessionReconnecting イベント、その前の sessionReconnected イベント。クライアントがセッションに再接続できない場合、Session オブジェクトは sessionDisconnected このイベントの代わりに、別のイベント。

クライアントが再接続すると、既存のパブリッシャーおよびサブスクライバーは自動的に再接続され、 Session オブジェクトがこのイベントをディスパッチします。

クライアントが切断されていた間に他のクライアントから送信されたシグナルは、 再接続時に受信されます。デフォルトでは、切断中にローカルクライアントによって （ Session.signal() メソッド）は、クライアントがVonage Video APIセッションに再接続した際に送信されます。これを防ぐには、 retryAfterReconnect プロパティを false での signal オブジェクトに渡します。 Session.signal() メソッドを使用する。

参照： : - イベント - sessionReconnecting イベント - sessionDisconnected イベント

セッションの再接続中

ローカルクライアントがVonage Video APIセッションとの接続を失い、再接続を試みています。 これはネットワーク接続の切断によるものです。クライアントがセッションに再接続できた場合、 Sessionオブジェクトは sessionReconnected イベント。それ以外の場合、クライアントが 再接続できないと、Session オブジェクトは sessionDisconnected イベントを開催する。

この事象に対応するため、ユーザーインターフェース上で通知を表示し、 アプリがセッションへの再接続を試みていること、および音声・映像ストリームが 一時的に切断されていることをユーザーに知らせることをお勧めします。

参照： : - イベント - sessionReconnected イベント - sessionDisconnected イベント

信号

セッションから信号を受信しました。その シグナルイベント このクラスは、このイベントオブジェクトを定義しています。これには、以下のプロパティが含まれます：

• data — (文字列) シグナルとともに送信されるデータ文字列（ ある場合）。
• from — (接続) 接続 シグナルを送信したクライアントに対応する接続。
• type — (文字列) シグナルに割り当てられた型（ある場合 ）。

イベントハンドラを追加することで、そのセッションで送信されるすべてのシグナルを受信するように登録できます。 その signal イベント。たとえば、次のコードは、セッション内で送信されるすべてのシグナルを処理するためのイベントハンドラを 追加します：

session.on("signal", function(event) {
  console.log("Signal sent from connection: " + event.from.id);
  console.log("Signal data: " + event.data);
});

指定したタイプのシグナルを登録するには、その signal:type イベント（置き換え） type （フィルタリングの対象となる 実際の型文字列を指定して）。

参照： : - Session.signal() - シグナルイベント - signal:type イベント

streamCreated

このセッション上で、別のクライアントによって公開された新しいストリームが作成されました。自身のクライアントによって公開されたストリームの場合、Publisher オブジェクトは streamCreated イベント。コード例や詳細については、以下を参照してください。 ストリームイベント.

参照： : - ストリームイベント - Session.publish()

streamDestroyed

別のクライアントからのストリームが、セッションへの配信を停止しました。

デフォルトの動作では、そのストリームを購読しているすべてのSubscriberオブジェクトの 購読が解除され、HTML DOMから削除されます。各Subscriberオブジェクトは、 destroyed 要素がHTML DOMから削除されたときに発生するイベントです。もし preventDefault() のイベントリスナー内のメソッド streamDestroyed イベントが発生すると、デフォルトの動作が抑制され、そのストリームの Subscriber オブジェクトを、その destroy() メソッド。参照： Session.getSubscribersForStream().

自身のクライアントによって公開されたストリームの場合、Publisher オブジェクトは streamDestroyed イベントを開催する。

コード例や詳細については、以下を参照してください。 ストリームイベント.

参照： : - ストリームイベント

streamPropertyChanged

ストリームのプロパティが変更された際にディスパッチされるイベントを定義します。これは、 以下の状況で発生する可能性があります：

• ストリームによる音声、字幕、または動画の配信が開始または停止されました（参照： Publisher.publishAudio(), Publisher.publishCaptions() そして Publisher.publishVideo()). 注： チャンネル登録者の動画は、配信者が無効化または有効化した以外の理由によって、 無効化または有効化される場合があります。Subscriber オブジェクトは videoDisabled そして videoEnabled あらゆる 状況において、サブスクライバーのストリームが無効化または有効化される原因となるイベント。
• について videoDimensions Stream オブジェクトのプロパティが 変更されました（参照： Stream.videoDimensions).
• について videoType Stream オブジェクトのプロパティが変更されました。 これは、モバイルデバイスによって公開されたストリームで発生する可能性があります。（参照： Stream.videoType.)

参照： : - StreamPropertyChangedイベント - Publisher.publishAudio() - Publisher.publishCaptions() - Publisher.publishVideo() - Stream.hasAudio - Stream.hasCaptions - Stream.hasVideo - Stream.videoDimensions - 登録者向け動画「無効化」イベント - 「Subscriber videoEnabled」イベント

signal:type

セッションから、指定されたタイプの信号を受信しました。その シグナルイベント このクラスは、このイベントオブジェクトを定義しています。 このオブジェクトには、以下のプロパティが含まれています：

• data — (文字列) シグナルとともに送信されるデータ文字列。
• from — (接続) 接続 シグナルを送信したクライアントに対応する接続。
• type — (文字列) シグナルに割り当てられた型（ある場合）。

指定したタイプのシグナルを登録するには、その signal:type イベント（置き換え） type （フィルタリング対象となる 実際の型文字列）。たとえば、次のコードは、 型「foo」のシグナルに対するイベントハンドラを追加します：

session.on("signal:foo", function(event) {
  console.log("foo signal sent from connection " + event.from.id);
  console.log("Signal data: " + event.data);
});

登録すると、以下の情報を受け取ることができます すべて セッション内で送信されたシグナルに対し、 イベントハンドラを追加することで、 signal イベントを開催する。

参照： : - Session.signal() - シグナルイベント - 信号 イベント