java.lang.Object

java.util.Observable

com.opentok.android.Session

---

public class Session extends オブザーバブル

クライアントが参加している OpenTok セッションを表します。OpenTok Android SDK を使用する際の最初の 手順は、Session() コンストラクタを呼び出して Session インスタンスを初期化することです。

Sessionインスタンスを作成する際には、OpenTokのセッションID、 トークン、およびAPIキーを渡します。APIキーは、 サインアップ OpenTokアカウントを作成します。テスト 目的で、アカウントにログインしてテスト用セッションIDやトークンを生成することができます。 Vonage Video API アカウント. 以下の を使用してください OpenTokのサーバーサイドライブラリ 配送アプリ内で セッションIDやトークンを生成するために。

関連項目： : - セッション 作成 - トークンの 生成

ネストされたクラスの概要

ネストされたクラス

修飾子と型

クラス

説明

static interface

Session.ArchiveListener

セッションのアーカイブ録画の開始および終了を監視します。

static class

Session.Builder

static class

Session.Capabilities

によって返される値を定義します。 getCapabilities() メソッドを使用する。

protected static class

Session.ConfigurableSessionOptions

static interface

Session.ConnectionListener

他のクライアントがセッションに接続したり切断したりするのを監視します。

static interface

Session.MuteListener

モデレーターがセッション内で配信をミュートしたり、セッション内のミュート状態を解除したりした際に、 これを監視します。

static interface

Session.ReconnectionListener

クライアントが OpenTok セッションへの接続が切断された後、自動的に再接続を試みた際に、これを監視します。

static interface

Session.SessionListener

あるものにおける状態の変化を監視します Session オブジェクトがある。

static class

Session.SessionOptions

で高度なセッションオプションを定義するための基底クラス Session.Builder.sessionOptions(Session.SessionOptions sessionOptions) メソッドを使用する。

static interface

Session.SessionOptionsProvider

非推奨です。

static interface

Session.SignalListener

セッション内で信号が送信されたことを監視します。

static interface

Session.StreamCaptionsPropertiesListener

セッション内のストリームのキャプションプロパティが変更された際に監視します。

static interface

Session.StreamPropertiesListener

セッション内のストリームのプロパティが変更された際に監視します。

フィールド概要

フィールド

修飾子と型

フィールド

説明

protected String

apiKey

protected URL

apiUrl

protected Session.ArchiveListener

archiveListener

protected Session.ConnectionListener

connectionListener

protected android.content.Context

context

protected Session.MuteListener

muteListener

protected Session.ReconnectionListener

reconnectionListener

protected String

sessionId

protected Session.SessionListener

sessionListener

protected Session.SignalListener

signalListener

protected Session.StreamCaptionsPropertiesListener

streamCaptionsPropertiesListener

protected Session.StreamPropertiesListener

streamPropertiesListener

コンストラクタの概要

コンストラクタ

修飾子

コンストラクタ

説明

protected

Session(Session.Builder builder)

方法の概要

すべてのメソッド　インスタンスメソッド　具体的なメソッド

修飾子と型

方法

説明

void

connect(String token)

Sessionコンストラクタで指定されたOpenTokセッションに、 指定された認証トークンを使用して接続します。

void

disableForceMute()

セッションのアクティブなミュート状態を解除します。

void

disconnect()

このセッションから切断します。

protected void

finalize()

セッションオブジェクトへの参照がもうないことが ガベージコレクタによって判断された際に、このメソッドが呼び出されます。

void

forceDisconnect(Connection connection)

クライアントを強制的にセッションから切断します。

void

forceMuteAll(Iterable<Stream> excludedStreams)

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

void

forceMuteStream(Stream stream)

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

Session.Capabilities

getCapabilities()

セッションへの接続に使用されるトークンに割り当てられたロールに基づき、 クライアントがセッション内でストリームの公開および購読を行えるかどうかを示します。

Connection

getConnection()

次の値を返します。 Connection このクライアントによる 本セッションへの接続に対応するものです。

String

getSessionId()

インスタンス化時に渡されたセッションIDを返します。

protected void

onArchiveStarted(String id, String name)

セッションのアーカイブの記録が開始されたときに呼び出されます。

protected void

onArchiveStopped(String id)

セッションのアーカイブの記録が停止したときに呼び出されます。

protected void

onConnected()

クライアントが OpenTok セッションに接続した際に呼び出されます。

protected void

onConnectionCreated(Connection connection)

以下の場合に呼び出されます もう一つ クライアントがセッションに接続します。

protected void

onConnectionDestroyed(Connection connection)

別のクライアントがセッションを離脱した際に呼び出されます。

protected void

onDisconnected()

クライアントが OpenTok セッションへの接続を解除したときに呼び出されます。

protected void

onError(OpentokError error)

セッションへの接続中に問題が発生した場合、またはセッションに接続された際に、 このメソッドが呼び出されます。

protected void

onMuteForced(MuteForcedInfo info)

モデレーターがセッション内の配信をミュートしたり、セッション内のミュート状態を解除したりした際に呼び出されます。

void

onPause()

アプリのアクティビティが一時停止したときに、このメソッドを呼び出してください。

protected void

onReconnected()

ローカルクライアントが、一時的にネットワーク接続が切断された後、 OpenTokセッションに再接続した際に呼び出されます。

protected void

onReconnecting()

ローカルクライアントが OpenTok セッションとの接続を失い、 再接続を試みているときに呼び出されます。

void

onResume()

アプリのアクティビティが再開されたら、このメソッドを呼び出してください。

protected void

onSignalReceived(String type, String data, Connection connection)

セッションでシグナルを受信した際に呼び出されます。

protected void

onStreamDropped(Stream stream)

以下の場合に呼び出されます もう一つ クライアントが、この OpenTok セッションへのストリームの配信を停止します。

protected void

onStreamHasAudioChanged(Stream stream, int hasAudio)

セッション内のストリームの音声状態が「音声あり」から 「音声なし」に変化した際に呼び出されます。

protected void

onStreamHasCaptionsChanged(Stream stream, int hasCaptions)

セッション内のストリームの字幕の有無が切り替わったときに呼び出されます。

protected void

onStreamHasVideoChanged(Stream stream, int hasVideo)

セッション内のストリームの状態が、動画ありから 動画なしに変わったときに呼び出されます。

protected void

onStreamReceived(Stream stream)

によって新しいストリームが公開されたときに呼び出されます。 もう一つ このOpenTokセッションのクライアント。

protected void

onStreamVideoDimensionsChanged(Stream stream, int width, int height)

セッション内のストリームの動画サイズが変更されたときに呼び出されます。

protected void

onStreamVideoTypeChanged(Stream stream, int videoType)

セッション内のストリームのビデオタイプが変更されたときに呼び出されます。

void

publish(PublisherKit publisher)

セッションへのパブリッシャーのストリーミングを開始します。

String

reportIssue()

アプリで問題が発生したことを報告してください。

void

sendSignal(String type, String data)

セッション内のすべてのクライアントに信号を送信します。

void

sendSignal(String type, String data, boolean retryAfterReconnect)

セッション内のすべてのクライアントに信号を送信します。

void

sendSignal(String type, String data, Connection connection)

セッション内の特定のクライアントにシグナルを送信します。

void

sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect)

セッション内の特定のクライアントにシグナルを送信します。このバージョンのメソッドには、 a retryAfterReconnect パラメータが必要だ。

void

setArchiveListener(Session.ArchiveListener listener)

を設定します Session.ArchiveListener このセッションでアーカイブ録画が 開始または停止した際に監視するオブジェクト。

void

setConnectionListener(Session.ConnectionListener listener)

を Session.ConnectionListener このセッションへの他のクライアントの 接続および切断を監視するためのオブジェクト。

void

setEncryptionSecret(String secret)

すべてのパブリッシャーおよびサブスクライバーが使用するエンドツーエンド暗号化の秘密鍵を設定します。

void

setMuteListener(Session.MuteListener listener)

を Session.MuteListener このセッションで「ミュート強制」が 送信された際に監視対象とするオブジェクト。

void

setReconnectionListener(Session.ReconnectionListener listener)

を Session.ReconnectionListener クライアントが OpenTok セッションへの再接続を試みているとき、 または再接続に成功したときに通知を受けるオブジェクト。

void

setSessionListener(Session.SessionListener listener)

を Session.SessionListener この Session オブジェクトの状態変化を監視するためのオブジェクト。

void

setSignalListener(Session.SignalListener listener)

を Session.SignalListener このセッションで信号が 送信された際に監視するオブジェクト。

void

setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener listener)

を Session.StreamCaptionsPropertiesListener ストリームのキャプションプロパティの プロパティを監視するオブジェクト。

void

setStreamPropertiesListener(Session.StreamPropertiesListener listener)

を Session.StreamPropertiesListener このセッション内のストリームのプロパティが 変更された際に、それを監視するオブジェクト。

void

subscribe(SubscriberKit subscriber)

指定された サブスクライバーに対するオーディオ・ビデオ・ストリームデータの受信およびレンダリングを開始します。

void

unpublish(PublisherKit publisher)

パブリッシャーをセッションから切断します。

void

unsubscribe(SubscriberKit subscriber)

セッション内の指定されたサブスクライバーへのサブスクリプション（ストリームの受信）を 停止します。

java.util クラスから継承されたメソッド。オブザーバブル

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

java.lang クラスから継承されたメソッド。目的

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

sessionListener

protected セッション・リスナー sessionListener

connectionListener

protected Session.ConnectionListener connectionListener

streamPropertiesListener

protected Session.StreamPropertiesListener streamPropertiesListener

streamCaptionsPropertiesListener

protected Session.StreamCaptionsPropertiesListener streamCaptionsPropertiesListener

signalListener

protected Session.SignalListener signalListener

archiveListener

protected Session.ArchiveListener archiveListener

reconnectionListener

protected Session.ReconnectionListener reconnectionListener

muteListener

protected Session.MuteListener muteListener

文脈

protected android.content.Context context

apiKey

protected ストリング apiKey

セッションID

protected ストリング sessionId

apiUrl

protected URL apiUrl

コンストラクタの詳細

セッション

protected Session(Session.Builder builder) throws 例外

投球： : Exception

メソッドの詳細

getConnection

public 接続 getConnection()

次の値を返します。 Connection このクライアントによる 本セッションへの接続に対応するものです。

ストリームが作成されると、 Session.SessionListener.onStreamReceived(Session session, Stream stream) メソッドが呼び出されます。によって返されるConnectionオブジェクトを比較してください。 Stream.getConnection() によって返されたConnectionオブジェクトを使用したメソッド Sesssion.getConnection() 新しいストリームが クライアントによって公開されているかどうかを確認するためです。

戻り値： : このインスタンスの OpenTok セッション ID。

関連項目： : - Session.SessionListener.onConnected(Session session) - Session.SessionListener.onStreamReceived(Session session, Stream stream) - Stream.getConnection()

getSessionId

public ストリング getSessionId()

インスタンス化時に渡されたセッションIDを返します。

戻り値： : このインスタンスの OpenTok セッション ID。

setSessionListener

public void setSessionListener(セッション・リスナー リスナー)

を Session.SessionListener この Session オブジェクトの状態変化を監視するためのオブジェクト。

パラメータ： : listener - その Session.SessionListener インスタンスだ。

setConnectionListener

public void setConnectionListener(Session.ConnectionListener リスナー)

を Session.ConnectionListener このセッションへの他のクライアントの 接続および切断を監視するためのオブジェクト。

パラメータ： : listener - その Session.ConnectionListener インスタンスだ。

setStreamPropertiesListener

public void setStreamPropertiesListener(Session.StreamPropertiesListener リスナー)

を Session.StreamPropertiesListener このセッション内のストリームのプロパティが 変更されたことを監視するオブジェクト。これには、 ストリームに音声があるかどうか、動画があるかどうか、および動画の解像度を示すプロパティが含まれます。

パラメータ： : listener - その Session.StreamPropertiesListener インスタンスだ。

setStreamCaptionsPropertiesListener

public void setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener リスナー)

を Session.StreamCaptionsPropertiesListener ストリームのキャプションプロパティの プロパティを監視するオブジェクト。

パラメータ： : listener - その Session.StreamCaptionsPropertiesListener インスタンスだ。

setSignalListener

public void setSignalListener(Session.SignalListener リスナー)

を Session.SignalListener このセッションで信号が 送信された際に監視するオブジェクト。

パラメータ： : listener - その Session.SignalListener インスタンスだ。

setArchiveListener

public void setArchiveListener(Session.ArchiveListener リスナー)

を設定します Session.ArchiveListener このセッションでアーカイブ録画が 開始または停止した際に監視するオブジェクト。

パラメータ： : listener - その Session.ArchiveListener インスタンスだ。

setReconnectionListener

public void setReconnectionListener(Session.ReconnectionListener リスナー)

を Session.ReconnectionListener クライアントが OpenTok セッションへの再接続を試みているとき、 または再接続に成功したときに通知を受けるオブジェクト。

パラメータ： : listener - その Session.ReconnectionListener インスタンスだ。

setMuteListener

public void setMuteListener(Session.MuteListener リスナー)

を Session.MuteListener このセッションで「ミュート強制」が 送信された際に監視対象とするオブジェクト。

パラメータ： : listener - その Session.MuteListener インスタンスだ。

コネクト

public void connect(ストリング トークン)

Sessionコンストラクタで指定されたOpenTokセッションに、 指定された認証トークンを使用して接続します。

セッションが接続されると、 Session.SessionListener.onConnected(Session session) メソッドが 呼び出されます。

セッションの接続に失敗した場合、 Session.SessionListener.onError(Session session, OpentokError error) メソッドが呼び出されます。

パラメータ： : token - ユーザーを表すトークン。詳しくは トークン 作成の概要.

切断

public void disconnect()

このセッションから切断します。すべてのサブスクライバーおよびパブリッシャーのインスタンスが 切断されます。ベストプラクティスとして、このメソッドを呼び出す前に、 次のメソッドを呼び出してください。 unpublish(PublisherKit) すべてのパブリッシャーに対するメソッド そして、 PublisherKit.onStreamDestroyed(Stream) コールバック。これにより、パブリッシャーが確実に完全に削除されます。特に、 ネットワーク接続の問題により、再接続機能のために削除が行えない場合、 再接続の可能性に備えてパブリッシャーのストリームが維持され続けることがあるためです。

セッションが切断されると、 Session.SessionListener.onDisconnected(Session session) メソッドが 呼び出されます。

onPause

public void onPause()

アプリのアクティビティが一時停止したときに、このメソッドを呼び出してください。これにより、そのセッションにパブリッシュしているすべてのパブリッシャーの ビデオレンダラーとキャプチャ機能が一時停止します。また、すべてのサブスクライバーの ビデオレンダラーも一時停止します。

このメソッドを呼び出すと、OpenTokのパブリッシャーが使用していたカメラが解放されるようになりました。 パブリッシャーは、 onResume() メソッドを使用する。

onResume

public void onResume()

アプリのアクティビティが再開されたら、このメソッドを呼び出してください。これにより、セッション内のすべてのパブリッシャーの ビデオレンダラーとキャプチャ機能が再開されます。また、すべてのサブスクライバーの ビデオレンダラーも再開されます。

（OpenTokパブリッシャーが使用する）カメラのうち、あなたが を呼び出した時点でリリースされていたものは、 onPause() このメソッドを呼び出すと、 Session.onResume().

出版

public void publish(PublisherKit （出版社）

セッションへのパブリッシャーのストリーミングを開始します。

パラメータ： : publisher - セッションにストリーミングしたいパブリッシャー。

アンパブリッシュ

public void unpublish(PublisherKit （出版社）

パブリッシャーをセッションから切断します。

パラメータ： : publisher - 発行者が公開を取り消す。

サブスクライブ

public void subscribe(SubscriberKit （加入者）

指定された サブスクライバーに対するオーディオ・ビデオ・ストリームデータの受信およびレンダリングを開始します。

パラメータ： : subscriber - 受信対象のストリームに紐付けられた加入者。

アンサブスクライブ

public void unsubscribe(SubscriberKit （加入者）

セッション内の指定されたサブスクライバーへのサブスクリプション（ストリームの受信）を 停止します。

パラメータ： : subscriber - 購読を解除したい購読者。

sendSignal

public void sendSignal(ストリング タイプ、 ストリング データ)

セッション内のすべてのクライアントに信号を送信します。

パラメータ： : type - 信号の型。この型は、 Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) メソッド。 : data - 送信するデータ。データのサイズ上限は8kBです。

関連項目： : - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void sendSignal(ストリング タイプ、 ストリング data, boolean retryAfterReconnect)

セッション内のすべてのクライアントにシグナルを送信します。このバージョンのメソッドには、 a retryAfterReconnect パラメータが必要だ。

パラメータ： : type - 信号の型。この型は、 Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) メソッド。 : data - 送信するデータ。データのサイズ上限は8kBです。 : retryAfterReconnect - セッションへの再接続時に、接続が切断されていた間に開始されたシグナルを 送信するかどうか。ネットワーク接続の切断によりクライアントが OpenTok セッションとの 接続を失った場合、クライアントはセッションへの再接続を試み、その際、 Session.ReconnectionListener.onReconnecting(Session session) メソッドが 呼び出されます。デフォルトでは、接続が切断されている間に発生したシグナルは、 クライアントが OpenTok セッションに再接続した際（再接続された場合）に送信されます。 これを防ぐには、 retryAfterReconnect パラメータを false. （デフォルト値は true.)

関連項目： : - sendSignal(String type, String data) - Session.ReconnectionListener.onReconnecting(Session session) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void sendSignal(ストリング タイプ、 ストリング データ、 接続 接続)

セッション内の特定のクライアントにシグナルを送信します。

パラメータ： : type - 信号の型。この型は、 Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) メソッド。 : data - 送信するデータ。データのサイズ上限は8kBです。 : connection - Connection オブジェクト。Connection オブジェクトは、 クライアントとセッションとの接続を表します。これは、 メッセージが送信されるクライアントです。（参照： Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) そして Connection.

関連項目： : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

sendSignal

public void sendSignal(ストリング タイプ、 ストリング データ、 接続 connection, boolean retryAfterReconnect)

セッション内の特定のクライアントにシグナルを送信します。このバージョンのメソッドには、 a retryAfterReconnect パラメータが必要だ。

パラメータ： : type - 信号の型。この型は、 Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) メソッド。 : data - 送信するデータ。データのサイズ上限は8kBです。 : connection - Connection オブジェクト。Connection オブジェクトは、 クライアントとセッションとの接続を表します。これは、 メッセージが送信されるクライアントです。（参照： Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) そして Connection. : retryAfterReconnect - セッションへの再接続時に、接続が切断されていた間に開始されたシグナルを 送信するかどうか。ネットワーク接続の切断によりクライアントが OpenTok セッションとの 接続を失った場合、クライアントはセッションへの再接続を試み、その際、 Session.ReconnectionListener.onReconnecting(Session session) メソッドが 呼び出されます。デフォルトでは、接続が切断されている間に発生したシグナルは、 クライアントが OpenTok セッションに再接続した際（再接続された場合）に送信されます。これを 防ぐには、 retryAfterReconnect パラメータ ～ false. （デフォルト値は true.)

関連項目： : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

getCapabilities

public Session.Capabilities getCapabilities()

セッションへの接続に使用されるトークンに割り当てられたロールに基づき、 クライアントがセッション内でストリームの公開および購読を行えるかどうかを示します。このメソッドは以下を返します。 null セッションに接続し、かつ Session.SessionListener.onConnected(Session session) メソッドが呼び出されました。

問題を報告する

public ストリング reportIssue()

アプリで問題が発生したことを報告してください。問題IDは、 インスペクター あるいは、 TokBoxのサポートチームと問題について話し合う際など。

戻り値： : その課題に関連付けられたID。

forceDisconnect

public void forceDisconnect(@NonNull 接続 接続)

クライアントをセッションから強制的に切断します。 以下の方法を使用することもできますが、 forceDisconnect(Connection) 接続を終了させるには、disconnect メソッドを呼び出す方が簡単です。 クライアントのロールに、他のユーザーを強制的に切断するために必要な権限が含まれていない場合、 エラーが返されます。クライアントのロールは、 ユーザートークンを作成する際に定義します。このメソッドを使用して 接続が終了されると、 Session.SessionListener.onDisconnected(Session), onConnectionDestroyed(Connection) そして PublisherKit.onStreamDestroyed(Stream) コールバックは、 接続が disconnect().

パラメータ： : connection - 切断するための接続。

forceMuteStream

public void forceMuteStream(@NonNull ストリーム (ストリーム)

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

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

パラメータ： : stream - 強制ミュート要求の対象となるストリームを表すオブジェクト。これには、ミュート対象となるストリームが含まれます。

関連項目： : - getCapabilities() - forceMuteAll(Iterable) - PublisherKit.onMuteForced() - セッション内の ストリームの音声をミュートする

forceMuteAll

public void forceMuteAll(@Nullable 反復可能<ストリーム> excludedStreams)

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

また、以下の呼び出しの後に発行されるストリームは、すべて forceMuteAll() メソッド は、音声をミュートした状態で公開されます。セッションのミュート状態を解除するには、 disableForceMute() メソッド。この disableForceMute() この方法により、セッションに新たに配信されるストリームの音声がミュートされることはなくなります。

このメソッドを呼び出すと、 Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) セッションに接続された各クライアントで呼び出されるメソッドで、 getActive() のメソッド info オブジェクトの返却 true.

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

パラメータ： : excludedStreams - 強制ミュート要求から除外されるストリームを表すオブジェクト。 これには、ミュート対象とすべきでないストリームも含まれます。

関連項目： : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - disableForceMute() - forceMuteStream(Stream stream) - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - PublisherKit.onMuteForced() - セッション内の ストリームの音声をミュートする

disableForceMute

public void disableForceMute()

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

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

このメソッドを呼び出すと、 Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) 呼び出すメソッド、および getActive() のメソッドを使用する。 info オブジェクト 返却 false.

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

関連項目： : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - forceMuteAll(Iterable) - セッション内の ストリームの音声をミュートする

setEncryptionSecret

public void setEncryptionSecret(ストリング (秘密)

すべてのパブリッシャーおよびサブスクライバーが使用するエンドツーエンド暗号化の秘密鍵を設定します。

参照 エンドツーエンド 暗号化開発者ガイド.

パラメータ： : secret - 暗号化シークレットの値。

onArchiveStarted

protected void onArchiveStarted(ストリング id, ストリング 名前)

セッションのアーカイブの録画が開始されたときに呼び出されます。このメソッドの呼び出しに応じて、 セッションが録画中であることを示すユーザーインターフェース上の通知（「パブリッシャー」ビュー内のアイコンなど）を 追加するとよいでしょう。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onArchiveStarted() Session.ArchiveListener インターフェースのメソッド。

パラメータ： : id - アーカイブの固有ID。 : name - アーカイブの名前（アーカイブ作成時に指定されていた場合）。

onArchiveStopped

protected void onArchiveStopped(ストリング id)

セッションのアーカイブの記録が停止したときに呼び出されます。このメソッドの呼び出しに応じて、 セッションの記録が停止したことを示すユーザーインターフェース上の通知（たとえば、パブリッシャー ビュー内のアイコンなど）を削除するとよいでしょう。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onArchiveStopped() Session.ArchiveListener インターフェースのメソッド。

パラメータ： : id - アーカイブの一意のID。

onStreamHasAudioChanged

protected void onStreamHasAudioChanged(ストリーム stream, int hasAudio)

セッション内のストリームの音声状態が「音声あり」から 「音声なし」に変化した際に呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onStreamHasAudioChanged() Session.StreamPropertiesListener インターフェースのメソッド。

パラメータ： : stream - ストリーム。 : hasAudio - ストリームに音声があるかどうか（true) かどうか（ false).

onStreamHasCaptionsChanged

protected void onStreamHasCaptionsChanged(ストリーム stream, int hasCaptions)

セッション内のストリームの字幕の有無が切り替わったときに呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onStreamHasCaptionsChanged() Session.StreamPropertiesListener インターフェースのメソッド。

パラメータ： : stream - ストリーム。 : hasCaptions - ストリームに字幕があるかどうか（true) かどうか（ false).

onStreamHasVideoChanged

protected void onStreamHasVideoChanged(ストリーム stream, int hasVideo)

セッション内のストリームの状態が、動画ありから 動画なしに変わったときに呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onStreamHasVideoChanged() Session.StreamPropertiesListener インターフェースのメソッド。

パラメータ： : stream - ストリーム。 : hasVideo - ストリームに動画が含まれているかどうか（true) かどうか（ false).

onStreamVideoDimensionsChanged

protected void onStreamVideoDimensionsChanged(ストリーム stream, int width, int height)

セッション内のストリームの動画サイズが変更されたときに呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onStreamVideoDimensionsChanged() Session.StreamPropertiesListener インターフェースのメソッド。

パラメータ： : stream - ストリーム。 : width - ストリームの新しい幅（ピクセル単位）。 : height - ストリームの新しい高さ（ピクセル単位）。

onStreamVideoTypeChanged

protected void onStreamVideoTypeChanged(ストリーム stream, int videoType)

セッション内のストリームのビデオタイプが変更されたときに呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onStreamVideoTypeChanged() Session.StreamPropertiesListener インターフェースのメソッド。

パラメータ： : stream - ストリーム。 : videoType - ストリームの新しい動画タイプ。

onConnectionCreated

protected void onConnectionCreated(接続 接続)

以下の場合に呼び出されます もう一つ クライアントがセッションに接続します。 Connection オブジェクトは、クライアントとセッションとの接続を表します。 なお、このメソッドは以下の場合に呼び出されます。 その他 クライアントが セッションに接続します。あなたの 自身の クライアントが接続すると、その Session.SessionListener.onConnected(Session session) メソッド が呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onConnectionCreated() Session.ConnectionListener インターフェースのメソッド。

パラメータ： : connection - セッション内の新しい接続。

onConnectionDestroyed

protected void onConnectionDestroyed(接続 接続)

別のクライアントがセッションから離脱したときに呼び出されます。Connection オブジェクトは、 そのクライアントによるセッションへの以前の接続を表します。あなたの 自身の クライアントが切断されると、その Session.SessionListener.onDisconnected(Session session) メソッドが呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onConnectionDestroyed() Session.ConnectionListener インターフェースのメソッド。

パラメータ： : connection - セッションから切断した接続。

onSignalReceived

protected void onSignalReceived(ストリング タイプ、 ストリング データ、 接続 接続)

セッションでシグナルを受信した際に呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onSignalReceived() Session.SignalListener インターフェースのメソッド。

パラメータ： : type - 信号の型文字列。 : data - 信号データ。 : connection - メッセージを送信したクライアントを識別する接続。この値は、 null.

再接続時

protected void onReconnecting()

ローカルクライアントが OpenTok セッションとの接続を失い、再接続を試みている際に 呼び出されます。これは、ネットワーク接続が切断されたことが原因で発生します。クライアントが セッションに再接続できた場合、 Session.ReconnectionListener.onReconnected(Session session) メソッドが呼び出されます。 それ以外の場合、クライアントが再接続できない場合は、 Session.SessionListener.onDisconnected(Session session) メソッドが呼び出される。

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

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onReconnecting() Session.ReconnectionListener インターフェースのメソッド。

関連項目： : - onReconnected()

onReconnected

protected void onReconnected()

ローカルクライアントが、一時的にネットワーク接続が切断された後、OpenTokセッションに再接続した際に呼び出されます。接続が切断された場合、 Session.ReconnectionListener.onReconnecting(Session session) メソッドが呼び出されると、 その前に Session.ReconnectionListener.onReconnected(Session session) メソッド。クライアントがセッションに再接続できない場合、 Session.SessionListener.onDisconnected(Session session) メソッドが呼び出される。

クライアントが再接続し、このメソッドが呼び出されると、既存のパブリッシャーおよびサブスクライバーは自動的に再接続されます。

デフォルトでは、ローカルクライアントが sendSignal(String type, String data) このメソッドは、クライアントが 再接続した際に送信されます。接続が切断されていた間に発生したシグナルが送信されないようにするには、 次の sendSignal(String type, String data, boolean retryAfterReconnect) 信号を送信する方法、および retryAfterReconnect パラメータを false. （クライアントが切断されていた間に他のクライアントから送信されたすべての信号は、 再接続時に受信されます。）

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onReconnected() Session.ReconnectionListener インターフェースのメソッド。

関連項目： : - onReconnecting()

onConnected

protected void onConnected()

クライアントが OpenTok セッションに接続した際に呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onConnected() Session.SessionListener インターフェースのメソッド。

onDisconnected

protected void onDisconnected()

クライアントが OpenTok セッションへの接続を解除したときに呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onDisconnected() Session.SessionListener インターフェースのメソッド。

onStreamReceived

protected void onStreamReceived(ストリーム (ストリーム)

によって新しいストリームが公開されたときに呼び出されます。 もう一つ このOpenTokセッションのクライアント。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onStreamReceived() Session.SessionListener インターフェースのメソッド。

パラメータ： : stream - 新しいストリームを表す Stream オブジェクト。これを使用して Subscriber を作成することができます。

onStreamDropped

protected void onStreamDropped(ストリーム (ストリーム)

以下の場合に呼び出されます もう一つ クライアントが、この OpenTok セッションへのストリームの配信を停止します。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onStreamDropped() Session.SessionListener インターフェースのメソッド。

パラメータ： : stream - 切断されたストリームを表す Stream オブジェクト。これは、 サブスクライバーを識別するために使用できます。

onError

protected void onError(OpentokError (エラー)

セッションへの接続中に問題が発生した場合、または接続後に問題が発生した場合に呼び出されます。 このメソッドが呼び出された後は、そのセッションは 無効となり、利用できないものとみなすべきです。再接続を試みたり、 Session オブジェクトの他のメソッドを呼び出したりしないでください。

このメソッドは、セッションへの接続に失敗した場合に呼び出されます。 また、接続に成功した後、エラーによってセッションへの接続が切断された場合にも呼び出されます。 この場合、このメソッドは の直前に呼び出されます。 Session.SessionListener.onDisconnected(Session session) メソッドが呼び出される。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onError() Session.SessionListener インターフェースのメソッド。

パラメータ： : error - エラーの原因を説明するメッセージ。

onMuteForced

protected void onMuteForced(MuteForcedInfo (情報)

モデレーターがセッション内の配信をミュートしたり、セッション内のミュート状態を解除したりした際に呼び出されます。

Session クラスを継承する場合は、このメソッドをオーバーライドすることで、 onMuteForced() Session.MuteListener インターフェースのメソッド。

パラメータ： : info - に電話してください getActive このオブジェクトのメソッドを使用して、 モデレーターがセッション内のストリームをミュートしているかどうかを判定します（true) または セッションのミュート状態を解除した（false).

関連項目： : - forceMuteAll(Iterable) - disableForceMute() - onMuteForced(MuteForcedInfo) - PublisherKit.onMuteForced() - セッション内の ストリームの音声をミュートする

確定する

protected void finalize() throws 投げられる

セッションオブジェクトへの参照がもうないことが ガベージコレクタによって判断された際に、このメソッドが呼び出されます。

上書き： : finalize 授業中 Object

投球： : Throwable