Proxy IP

Grâce à la fonctionnalité de proxy IP, les clients OpenTok acheminent tout le trafic Internet (à l'exception des flux multimédias) via votre serveur proxy.

Le trafic non multimédia comprend les communications avec les serveurs de la Video API et l'infrastructure de journalisation.

La fonctionnalité de proxy IP est disponible sous la forme de une fonction supplémentaire.

Il existe également un serveur TURN configurable fonctionnalité supplémentaire qui vous permet d'acheminer des flux multimédias via vos propres serveurs TURN personnalisés.

Configuration du serveur proxy IP

Vous configurez l'URL ou votre serveur proxy lorsque vous lancez une session OpenTok dans les SDK client OpenTok.

OpenTok ajoute l'URL de destination de tout le trafic Internet (à l'exception des flux multimédias ) à l'URL du proxy que vous fournissez. Ce trafic comprend les appels à la Video API, les connexions WebSocket et le trafic de journalisation généré par OpenTok.js.

Par exemple, le Client SDK OpenTok enregistre périodiquement des données dans https://video-log-host.example.com/prod/logging/ClientEvent. Si vous configurez l'URL du proxy sur "https://123.123.123.123:8080", le client enverra ces données vers https://123.123.123.123:8080/video-log-host.example.com/prod/logging/ClientEvent.

Vous devez sécuriser le serveur proxy afin qu'il ne soit utilisé que par les clients OpenTok et non par des clients non autorisés. Vous pouvez, par exemple, placer le serveur proxy derrière un pare-feu ou authentifier les requêtes d'une autre manière.

Voici un exemple de code permettant de configurer un serveur proxy de base pour cette fonctionnalité : proxy_inversé_simple.

Remarque : Si des clients se connectent à des sessions OpenTok depuis une région géographique différente de celle de votre serveur proxy et que vous n'utilisez pas le fonctionnalité configurable du serveur TURN, pensez à définir l'indication de lieu lorsque vous Créer des sessions OpenTok.

Dans OpenTok.js

Appeler le OT.setProxyUrl() pour définir l'URL du serveur proxy :

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

Vous devez appeler cette méthode avant d'appeler toute autre méthode OpenTok. Cela garantit que le serveur proxy est utilisé pour le trafic OpenTok.

Remarque : Cette méthode a été ajoutée en tant que méthode non documentée dans OpenTok 2.17.4. Dans les versions précédentes, vous deviez définir l'URL du serveur proxy à l'aide d'une option non documentée lors de l'appel de la méthode OT.initSession() méthode. Cependant, cette option est désormais obsolète et a été remplacée par la OT.setProxyUrl() méthode.

Dans le SDK Android d'OpenTok

Définir l'URL du serveur proxy en appelant la fonction setProxyUrl() de la méthode Session.Builder que vous utilisez pour instancier un objet Session :

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

Dans le SDK OpenTok pour iOS

Définissez l'URL du serveur proxy en définissant le paramètre proxyURL de la propriété OTSessionSettings que vous passez dans l'objet [OTSession initWithApiKey:sessionId:delegate:settings:] méthode :

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

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

Dans le SDK OpenTok pour Windows

Définissez l'URL du serveur proxy en définissant le paramètre proxyUrl du paramètre Session() constructeur :

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

Dans le SDK OpenTok pour Linux

Définir l'URL du serveur proxy en appelant la fonction otc_session_settings_set_proxy_url() fonction :

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);

Le premier paramètre est le otc_session_settings que vous passerez dans l'instance l'instance otc_session_new_with_settings() pour initialiser un otc_session instance. Le deuxième paramètre correspond à l'URL du serveur proxy.

Pour plus d'informations sur le otc_session_settings la structure otc_session_new_with_settings() et la connexion à la session, voir Instanciation d'une instance otc_session et rappels liés à la session.

Dans le SDK OpenTok pour macOS

Définir l'URL du serveur proxy en appelant la fonction otc_session_settings_set_proxy_url() fonction :

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);

Dans le SDK React Native de l'API OpenTok

Régler le proxyUrl de la propriété options vous passez dans le OTSession de la composante :

<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>