com.opentok.android.Session.Builder
包含クラス: : セッション
public static class Session.Builder extends 目的
ネストされたクラスの概要
ネストされたクラス
修飾子と型
クラス
説明
static class
Session.Builder.IceServer
で利用されるカスタム TURN サーバーを定義します。
setCustomIceServers(List, IncludeServers)
メソッドを使用する。
static enum
Session.Builder.IncludeServers
カスタムTURNサーバーのみを使用するか、 Vonage Video APIのTURNサーバーに加えてそれらのサーバーも使用するかに関する設定を定義します。
static enum
Session.Builder.TransportPolicy
メディア接続の確立に、すべてのICEトランスポートタイプ(host、srflx、TURNなど)を使用するか、 TURNのみを使用するかに関する設定を定義します。
コンストラクタの概要
コンストラクタ
コンストラクタ
説明
Builder(android.content.Context context, String apiKey, String sessionId)
このビルダーを使用して、Sessionインスタンスを作成します。
方法の概要
すべてのメソッド インスタンスメソッド 具体的なメソッド 非推奨のメソッド
修飾子と型
方法
説明
Session
build()
新しいものを返します Session …に基づくインスタンス Session.Builder
設定。
Session.Builder
connectionEventsSuppressed(Boolean enabled)
接続イベント(例:
Session.ConnectionListener.onConnectionCreated(Session session, Connection connection)) が発送されるのを防ぐ。
Session.Builder
sessionOptions(Session.SessionOptions sessionOptions)
セッションの詳細設定を行います。
Session.Builder
setApiUrl(URL apiUrl)
非推奨です。
Session.Builder
setCustomIceServers(List<Session.Builder.IceServer> serverList, Session.Builder.IncludeServers config)
このセッションでクライアントが使用するカスタム TURN サーバーのリストを設定します。
Session.Builder
setIceRouting(Session.Builder.TransportPolicy routing)
このセッションでクライアントが使用する TURN サーバーのトランスポートポリシーを設定します。
Session.Builder
setIpWhitelist(boolean enabled)
これを次のように設定してください true プロジェクトで「許可されたIPアドレス一覧」機能が有効になっている場合。
Session.Builder
setProxyUrl(String proxyUrl)
ここにIPプロキシサーバーのURLを設定してください。
Session.Builder
setSessionMigration(boolean enable)
セッション移行機能を有効にし、サーバーのローテーション中もクライアントが接続を維持できるようにします。
Session.Builder
setSinglePeerConnection(boolean enable)
シングル・ピア・コネクション(SPC)は、すべての加入者接続を単一のピア 接続にカプセル化する機能です。
java.lang クラスから継承されたメソッド。目的
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
コンストラクタの詳細
ビルダー
public Builder(android.content.Context context, ストリング apiKey, ストリング sessionId)
このビルダーを使用して、Sessionインスタンスを作成します。
パラメータ:
: context - このプロセスに関連付けられているAndroidアプリケーションコンテキスト。
: apiKey - OpenTok API キー。詳細については、
Vonage Video API アカウントページ.
重要だ: (OpenTokプロジェクトではなく)
VonageアプリケーションでVideo APIを使用する場合は、
このパラメータにアプリケーションID(OpenTok APIキーではありません)を
指定してください。
: sessionId - このインスタンスが接続すべき OpenTok セッション ID。
テスト目的では、ご自身のアカウントにログインしてテストセッションを生成できます。
Vonage Video API アカウント. 以下の
OpenTok
サーバーサイドSDK 配送アプリでセッションIDを生成するには。
関連項目:
: - Session.setSessionListener(com.opentok.android.Session.SessionListener)
メソッドの詳細
connectionEventsSuppressed
public Session.Builder connectionEventsSuppressed(ブーリアン 有効)
接続イベント(例:
Session.ConnectionListener.onConnectionCreated(Session session, Connection connection)) が発送されるのを防ぐ。
デフォルト値は false.
sessionOptions
public Session.Builder sessionOptions(Session.SessionOptions sessionOptions)
セッションの詳細設定を行います。
関連項目:
: - Session.SessionOptions
setCustomIceServers
public Session.Builder setCustomIceServers(一覧<Session.Builder.IceServer> serverList, Session.Builder.IncludeServers (設定)
このセッションでクライアントが使用するカスタム TURN サーバーのリストを設定します。 詳しくは、 設定可能なTURNサーバー 開発者ガイド
setIceRouting
public Session.Builder setIceRouting(Session.Builder.TransportPolicy ルーティング)
このセッションでクライアントが使用する TURN サーバーのトランスポートポリシーを設定します。 詳しくは、 設定可能なTURNサーバー 開発者ガイド
setApiUrl
@非推奨 public Session.Builder setApiUrl(URL apiUrl)
非推奨です。
サーバーのURLを設定します。 このパラメータはテスト用です。
setIpWhitelist
public Session.Builder setIpWhitelist(boolean enabled)
これを次のように設定してください true プロジェクトで「許可されたIPアドレスリスト」機能が有効になっている場合。
(この機能は、
アドオン機能.)
デフォルト値は false.
setProxyUrl
public Session.Builder setProxyUrl(ストリング proxyUrl)
ここにIPプロキシサーバーのURLを設定してください。これは アドオン機能として利用可能です。OpenTokの 価格ページ そして、その IPプロキシ開発者ガイド.
setSinglePeerConnection
public Session.Builder setSinglePeerConnection(boolean enable)
シングル・ピア・コネクション(SPC)は、すべての加入者接続を単一のピア 接続にカプセル化する機能です。SPCを有効にするメリットとしては、OSリソースの消費削減、レート制御の改善、 およびモバイルネイティブデバイスにおける大規模なセッションへの対応などが挙げられます。
SPCはデフォルトで無効になっています。無効にしている場合、セッションではMPC(Multiple Peer Connection)が使用され、 各エンドポイント間で個別のピア接続が確立されます。
setSessionMigration
public Session.Builder setSessionMigration(boolean enable)
セッション移行機能を有効にし、サーバーのローテーション中もクライアントが接続を維持できるようにします。
デフォルト値は false (セッションの移行は有効になっていません)。詳細については、以下を参照してください。
サーバーのローテーションとセッションの移行.
ビルド
public セッション build()
新しいものを返します Session …に基づくインスタンス Session.Builder
設定。