Proxy de IP

Com o recurso de proxy de IP, os clientes do OpenTok encaminham todo o tráfego da Internet (exceto fluxos de mídia) por meio do seu servidor proxy.

O tráfego não relacionado à mídia inclui a comunicação com os servidores da Video API e a infraestrutura de registro de logs.

O recurso de proxy de IP está disponível como um recurso adicional.

Há também um servidor TURN configurável recurso adicional que permite rotear fluxos de mídia por meio de seus próprios servidores TURN personalizados.

Configurando o servidor proxy IP

Você define a URL ou o servidor proxy ao iniciar uma sessão do OpenTok nos SDKs do cliente OpenTok.

O OpenTok concatena a URL de destino de todo o tráfego da Internet (exceto transmissões de mídia) à URL do proxy que você fornecer. Esse tráfego inclui chamadas da Video API, conexões WebSocket e o tráfego de log gerado pelo OpenTok.js.

Por exemplo, o Client SDK do OpenTok registra dados periodicamente em https://video-log-host.example.com/prod/logging/ClientEvent. Se você definir a URL do proxy como "https://123.123.123.123:8080", o cliente enviará esses dados para https://123.123.123.123:8080/video-log-host.example.com/prod/logging/ClientEvent.

Você deve proteger o servidor proxy para que ele seja utilizado apenas pelos clientes do OpenTok e não por clientes não autorizados. Por exemplo, você pode colocar o servidor proxy dentro de um firewall ou autenticar as solicitações de alguma outra forma.

Aqui está um exemplo de código que configura um servidor proxy básico para esse recurso: proxy_reverso_simples.

Observação: Se os clientes se conectarem a sessões do OpenTok em uma região geográfica diferente da do seu servidor proxy e você não estiver usando o recurso configurável do servidor TURN, não se esqueça de definir a sugestão de localização quando você criar sessões do OpenTok.

No OpenTok.js

Ligue para o OT.setProxyUrl() método para definir a URL do servidor proxy:

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

É necessário chamar esse método antes de chamar qualquer outro método do OpenTok. Isso garante que o servidor proxy seja utilizado para o tráfego do OpenTok.

Observação: Esse método foi adicionado como um método não documentado no OpenTok 2.17.4. Nas versões anteriores, era possível definir a URL do servidor proxy usando uma opção não documentada ao chamar o OT.initSession() método. No entanto, essa opção agora está obsoleta e foi substituída pelo OT.setProxyUrl() método.

No SDK do OpenTok para Android

Defina a URL do servidor proxy chamando a função setProxyUrl() método do Session.Builder objeto usado para instanciar um objeto Session:

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

No SDK do OpenTok para iOS

Defina a URL do servidor proxy configurando o proxyURL propriedade do OTSessionSettings objeto que você passa para o [OTSession initWithApiKey:sessionId:delegate:settings:] método:

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

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

No SDK do OpenTok para Windows

Defina a URL do servidor proxy configurando o proxyUrl parâmetro do Session() construtor:

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

No SDK do OpenTok para Linux

Defina a URL do servidor proxy chamando a função otc_session_settings_set_proxy_url() função:

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

O primeiro parâmetro é o otc_session_settings instância que você passará para o otc_session_new_with_settings() função para inicializar um otc_session instância. O segundo parâmetro é a URL do servidor proxy.

Para obter mais informações sobre o otc_session_settings struct, o otc_session_new_with_settings() função e como se conectar à sessão, consulte Criação de uma instância de `otc_session` e callbacks relacionados à sessão.

No SDK do OpenTok para macOS

Defina a URL do servidor proxy chamando a função otc_session_settings_set_proxy_url() função:

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

O primeiro parâmetro é o otc_session_settings instância que você passará para o otc_session_new_with_settings() função para inicializar um otc_session instância. O segundo parâmetro é a URL do servidor proxy.

Para obter mais informações sobre o otc_session_settings struct, o otc_session_new_with_settings() função e como se conectar à sessão, consulte Criação de uma instância de `otc_session` e callbacks relacionados à sessão.

No SDK do React Native da API do OpenTok

Defina o proxyUrl propriedade do options parâmetro que você passa para o OTSession componente:

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