IPプロキシ

IPプロキシ機能を使用すると、OpenTokクライアントは、すべてのインターネットトラフィック（メディアストリームを除く）をプロキシサーバー経由でルーティングします。

メディア以外のトラフィックには、Video API サーバーへの通信や、ロギングインフラストラクチャへの通信が含まれます。

IPプロキシ機能は、以下の形で利用可能です。アドオン機能.

また設定可能なTURNサーバー独自のTURNサーバーを経由してメディアストリームをルーティングできる追加機能。

IPプロキシサーバーの設定

OpenTokクライアントSDKでOpenTokセッションを開始する際には、 URLまたはプロキシサーバーを設定します。

OpenTokは、すべてのインターネットトラフィック（メディアストリームを除く）の宛先URLを、お客様が指定したプロキシURLに連結します。このトラフィックには、Video APIの呼び出し、 WebSocket接続、およびOpenTok.jsによって生成されるログトラフィックが含まれます。

たとえば、OpenTok Client SDKは、定期的にデータを https://video-log-host.example.com/prod/logging/ClientEvent. プロキシURLを次のように設定すると "https://123.123.123.123:8080", クライアントはこのデータを https://123.123.123.123:8080/video-log-host.example.com/prod/logging/ClientEvent.

プロキシサーバーは、OpenTokクライアントのみが利用し、権限のないクライアントが利用できないようにセキュリティ対策を講じてください。例えば、プロキシサーバーをファイアウォール内に配置したり、その他の方法でリクエストの認証を行ったりすることができます。

この機能用の基本的なプロキシサーバーを設定するサンプルコードは以下の通りです： simple_reverse_proxy.

注：クライアントが、プロキシサーバーが配置されている地域とは異なる地理的地域からOpenTokセッションに接続する場合で、かつ設定可能なTURNサーバー機能, その際は、必ず場所のヒントを設定してください。 OpenTokセッションを作成する.

OpenTok.jsでは

に電話する。 OT.setProxyUrl() メソッドを使用してプロキシサーバーのURLを設定します：

OT.setProxyUrl('https://123.123.123.123:8080');

他のOpenTokメソッドを呼び出す前に、必ずこのメソッドを呼び出す必要があります。これにより、OpenTokのトラフィックに対してプロキシサーバーが確実に使用されるようになります。

注：このメソッドは、OpenTok 2.17.4 で非公開メソッドとして追加されました。以前のバージョンでは、 OT.initSession() メソッド。ただし、このオプションは現在非推奨となっており、代わりに OT.setProxyUrl() メソッドを使用する。

OpenTok Android SDK において

プロキシサーバーのURLを設定するには setProxyUrl() のメソッドを使用する。 Session.Builder オブジェクトをインスタンス化します：

mSession = new Session.Builder(context, API_KEY, SESSION_ID)
  .setProxyUrl("https://123.123.123.123:8080")
  .build();

OpenTok iOS SDK において

プロキシサーバーのURLを proxyURL プロパティの OTSessionSettings オブジェクトに渡します。 [OTSession initWithApiKey:sessionId:delegate:settings:] メソッドを使用する：

OTSessionSettings *settings = [[OTSessionSettings alloc] init];
settings.proxyURL = @"https://123.123.123.123:8080";

session = [[OTSession alloc] initWithApiKey:kApiKey
                                       sessionId:kSessionId
                                       delegate:self
                                       settings:settings];

OpenTok Windows SDK において

プロキシサーバーのURLを proxyUrl パラメーターの Session() コンストラクタを使用する：

Session = new Session.Builder(Context.Instance, API_KEY, SESSION_ID)
{
  ProxyUrl = "https://123.123.123.123:8080"
}.Build();

OpenTok Linux SDK において

プロキシサーバーのURLを設定するには otc_session_settings_set_proxy_url() 関数である：

otc_session_settings_set_proxy_url(session_settings, "https://123.123.123.123:8080");
otc_session *session = otc_session_new_with_settings(API_KEY,
                                                     SESSION_ID,
                                                     &session_callbacks,
                                                     session_settings);

最初のパラメータは otc_session_settings インスタンスに渡す。に渡します。 otc_session_new_with_settings() 関数を使用して otc_session インスタンス。2番目のパラメータはプロキシサーバーのURLです。

詳細については、 otc_session_settings 構造体は otc_session_new_with_settings() 関数を使い、セッションに接続する。 otc_session インスタンスのインスタンス化とセッション関連のコールバック.

OpenTok macOS SDK において

プロキシサーバーのURLを設定するには otc_session_settings_set_proxy_url() 関数である：

otc_session_settings_set_proxy_url(session_settings, "https://123.123.123.123:8080");
otc_session *session = otc_session_new_with_settings(API_KEY,
                                                     SESSION_ID,
                                                     &session_callbacks,
                                                     session_settings);

OpenTok API React Native SDK において

を設定する。 proxyUrl プロパティの options に渡す。 OTSession コンポーネントを使用している：

<OTSession
  apiKey="your-api-key"
  sessionId="your-session-id"
  token="your-session-token"
  options={{
    proxyUrl: 'https://123.123.123.123:8080',
    // ... other options
  }}
>
  <OTPublisher/>
  <OTSubscriber/>
</OTSession>