OpenTok.js リファレンス

OpenTok.js には、以下のクラスが含まれています：

クラス	説明
アーカイブイベント	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
AudioInputDeviceChangedEvent	詳細については、こちらのドキュメントをご覧ください。
AudioLevelUpdatedEvent	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
能力	セッションに接続し、Session オブジェクトが sessionConnected イベントをディスパッチするまでは、すべての Capabilities プロパティは未定義となります。
CaptionReceivedEvent	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
接続	Session オブジェクトには、Connection オブジェクトである connection プロパティがあります。これは、ローカルクライアントの接続を表します。（クライアントが Session オブジェクトの connect() メソッドの呼び出しに成功して初めて、そのクライアントに接続が確立されます。）
ConnectionEvent	Session オブジェクトは、クライアント（自身のクライアントを含む）が Session に接続すると、connectionCreated イベントをディスパッチします。また、最初に接続した際には、そのセッション内のすべてのクライアントに対して connectionCreated イベントをディスパッチします（ローカルクライアントが接続すると、Session オブジェクトは sessionConnect イベントもディスパッチします）。
CpuPerformanceChangedEvent	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
エラー	Error クラスでは、以下のメソッドのいずれかが返したプロミスがリジェクトされた際にスローされる Error も定義されています：
イベント	たとえば、Stream オブジェクトは、ストリームのプロパティが更新されると streamPropertyChanged イベントをディスパッチします。イベントのコールバックは、Stream オブジェクトの on() メソッドを使用して追加します。
EventDispatcher	非推奨 — 代わりに on() または once() を使用してください。
例外イベント	OT.on() メソッドを呼び出すことで、例外イベントに対するコールバックを設定することに注意してください。
MediaStoppedEvent	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
MediaStreamAvailableEvent	なお、音声はカスタム要素と「Publisher」または「Subscriber」ウィジェットの両方から再生されます。エコーを防ぐため、カスタム要素の音量はミュートに設定してください。
MuteForcedEvent	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
OT	Publisher オブジェクトを初期化し、それを返します。
出版社	以下のコードは、セッションをインスタンス化し、セッションへの接続時にオーディオ・ビデオストリームを配信します。
QualityScoreChangedEvent	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
セッション	非推奨 — 代わりに on() または once() を使用してください。
SessionConnectEvent	バージョン 2.2 では、Session.connect() メソッドの completionHandler は、セッションへの接続が成功したか失敗したかを示します。
セッション切断イベント	以下のコードは、セッションを初期化し、セッションが切断された際のイベントリスナーを設定します。
シグナルイベント	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
ストリーム	セッションにストリームが追加されると、Session オブジェクトは streamCreatedEvent を発火します。ストリームが破棄されると、Session オブジェクトは streamDestroyed イベントを発火します。これらのイベントを定義する StreamEvent オブジェクトには、Stream オブジェクトの配列である stream プロパティがあります。詳細については
ストリームイベント	以下のコードは、セッションに接続し、別のクライアントによってパブリッシュされたストリームが作成された際のイベントリスナーを設定します：
StreamPropertyChangedイベント	イベントにデフォルトの挙動があるかどうかを確認するには、イベントオブジェクトの `cancelable` プロパティを確認してください。
購読者	非推奨 — 代わりに on() または once() を使用してください。
VideoDimensionsChangedEvent	パブリッシャーでは、パブリッシャーのローカル要素が解像度の変更を検知した際に、このイベントが発生します。パブリッシャーがアクティブに配信を行っている場合、これにより stream.videoDimensions プロパティも更新されます。ローカルの動画要素のサイズ変更を引き起こす要因の例としては、キャプチャされた画面共有ウィンドウのサイズ変更などが挙げられます。
VideoElementCreatedEvent	insertDefaultUI オプションを false に設定している場合のみ、このイベントのリスナーを追加してください。insertDefaultUI オプションを false に設定していない場合は、HTML DOM 内の video 要素（または Internet Explorer では video を含む object 要素）を移動しないでください。そうすると、パブリッシャーまたはサブスクライバーが
ビデオ有効変更イベント	接続状態が改善され、再び動画の受信が可能になると、Subscriber オブジェクトは videoEnabled イベントをディスパッチし、Subscriber は動画の受信を再開します。