Sessão do OpenTok. Mais...

#include "capabilities.h" #include "config.h" #include "publisher.h" #include "subscriber.h" #include "stream.h"
Macros
#define COMPRIMENTO MÍNIMO DO SEGREDO DE CRIPTOGRAFIA   8
#define COMPRIMENTO_MÁXIMO_DO_SEGREDO_DE_CRIPTOGRAFIA   256
Definições de tipos
typedef struct otc_session otc_session
typedef struct otc_session_settings otc_session_settings
Enumerações
enum otc_session_error_code {   OTC_SESSION_AUTHORIZATION_FAILURE , OTC_SESSION_BLOCKED_COUNTRY , OTC_SESSION_CONNECTION_DROPPED , OTC_SESSION_CONNECTION_FAILED ,   OTC_SESSION_CONNECTION_LIMIT_EXCEEDED , OTC_SESSION_CONNECTION_REFUSED , OTC_SESSION_CONNECTION_TIMED_OUT , OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM = 1535 ,   OTC_SESSION_ILLEGAL_STATE , OTC_SESSION_INTERNAL_ERROR , OTC_SESSION_INVALID_SESSION , OTC_SESSION_INVALID_SIGNAL_TYPE ,   OTC_SESSION_NOT_CONNECTED , OTC_SESSION_NO_MESSAGING_SERVER , OTC_SESSION_NULL_OR_INVALID_PARAMETER , OTC_SESSION_PUBLISHER_NOT_FOUND ,   OTC_SESSION_SIGNAL_DATA_TOO_LONG , OTC_SESSION_SIGNAL_TYPE_TOO_LONG , OTC_SESSION_UNABLE_TO_SEND_SIGNAL , OTC_SESSION_STATE_FAILED = 1020,   OTC_SESSION_SUBSCRIBER_NOT_FOUND , OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE , OTC_SESSION_ENCRYPTION_SECRET_MISSING , OTC_SESSION_INVALID_ENCRYPTION_SECRET }
Funções
otc_session * otc_session_new (const char *apikey, const char *session_id, const struct otc_session_callbacks *callbacks)
otc_session_settings * otc_session_settings_new (nulo)
otc_status otc_session_settings_set_connection_events_suppressed (otc_session_settings *configurações, otc_bool suprimir)
otc_status otc_session_settings_set_custom_ice_config (otc_session_settings *configurações, struct constante otc_custom_ice_config *custom_ice_config)
otc_status otc_session_settings_set_proxy_url (otc_session_settings *configurações, const char *proxy_url)
otc_status otc_session_settings_set_ip_whitelist (otc_session_settings *configurações, otc_bool (lista de endereços IP autorizados)
otc_status otc_session_settings_set_single_peer_connection (otc_session_settings *configurações, otc_bool ativar)
Ativa ou desativa a Conexão de Par Único (SPC) para uma sessão. Mais...
otc_status otc_session_settings_set_session_migration (otc_session_settings *configurações, otc_bool ativar)
Ativa ou desativa a migração de sessão para uma sessão. Mais...
otc_status otc_session_settings_delete (otc_session_settings *configurações)
otc_session * otc_session_new_with_settings (const char *apikey, const char *session_id, const struct otc_session_callbacks *callbacks, otc_session_settings *configurações)
otc_status otc_session_delete (otc_session *sessão)
otc_status otc_session_connect (otc_session *sessão, const char *token)
otc_status otc_session_disconnect (otc_session *sessão)
otc_status otc_session_publish (otc_session *sessão, otc_publisher *editora)
otc_status otc_session_unpublish (otc_session *sessão, otc_publisher *editora)
otc_status otc_session_subscribe (otc_session *sessão, otc_assinante *assinante)
otc_status otc_session_unsubscribe (otc_session *sessão, otc_assinante *assinante)
otc_status otc_session_send_signal (otc_session *session, const char *type, const char *signal)
otc_status otc_session_force_mute_all (otc_session *session, const char **excluded_streams_ids, const int excluded_streams_len)
otc_status otc_session_disable_force_mute (otc_session *sessão)
otc_status otc_session_force_mute_stream (const otc_session *sessão, const char *id_do_stream_a_ser_silenciado)
otc_status otc_session_force_disconnect (const otc_session *sessão, const otc_connection *conexão)
otc_status otc_session_send_signal_to_connection (otc_session *sessão, const char *tipo, const char *sinal, const otc_connection *conexão)
otc_status otc_session_send_signal_with_options (otc_session *sessão, const char *tipo, const char *sinal, struct otc_signal_options (opções_de_sinal)
otc_status otc_session_send_signal_to_connection_with_options (otc_session *sessão, const char *tipo, const char *sinal, const otc_connection *conexão, estrutura otc_signal_options (opções_de_sinal)
otc_status otc_session_report_issue (struct otc_session *session, const char *descrição_do_problema, char **id_do_problema)
char * otc_session_get_id (const otc_session *sessão)
otc_connection * otc_session_get_connection (const otc_session *sessão)
struct otc_session_capabilities otc_session_get_capabilities (const otc_session *sessão)
void * otc_session_get_user_data (const otc_session *sessão)
otc_status otc_session_set_encryption_secret (otc_session *sessão, const char *segredo)
Define o segredo de criptografia de ponta a ponta que será utilizado por todos os emissores e assinantes na sessão. Mais...

Descrição detalhada

Sessão do OpenTok.

Este arquivo inclui a definição do tipo de uma sessão do OpenTok, além de várias declarações de funções úteis ao se trabalhar com uma sessão.

Documentação sobre `typedef`

otc_session
typedef struct otc_session otc_session

Definição do tipo de sessão do OpenTok.

otc_session_settings

Definição do tipo de configurações de sessão do OpenTok.

Documentação sobre tipos de enumeração

otc_session_error_code

Lista de códigos de erro para sessões do OpenTok.

Esta enumeração representa vários códigos de erro associados a uma sessão.

Recenseador
OTC_SESSION_AUTHORIZATION_FAILURE Foi fornecida uma chave ou um token de API inválido.
OTC_SESSION_BLOCKED_COUNTRY Não foi possível conectar-se à sessão. Violação dos termos de serviço: conformidade com normas de exportação.
OTC_SESSION_CONNECTION_DROPPED A conexão com o servidor de mensagens do OpenTok foi interrompida.
OTC_SESSION_CONNECTION_FAILED Falha ao conectar-se à sessão.
OTC_SESSION_CONNECTION_LIMIT_EXCEEDED O cliente tentou se conectar a uma sessão que ultrapassou o limite de conexões simultâneas.
OTC_SESSION_CONNECTION_REFUSED Não foi possível abrir um soquete para o servidor de mensagens. Verifique se as portas de saída 443 e 8080 estão acessíveis.
OTC_SESSION_CONNECTION_TIMED_OUT O tempo de espera da conexão expirou durante a tentativa de conexão com a sessão
OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM Fluxo inválido.
OTC_SESSION_ILLEGAL_STATE Um método foi chamado em um momento inválido ou inadequado para esta sessão. Por exemplo, tentar conectar-se a uma sessão que já está conectada resultará neste erro.
OTC_SESSION_INTERNAL_ERROR Falha no envio de threads, falta de memória, erro de análise, etc.
OTC_SESSION_INVALID_SESSION Foi fornecido um ID de sessão inválido.
OTC_SESSION_INVALID_SIGNAL_TYPE Você tentou enviar um sinal com um tipo inválido.
OTC_SESSION_NOT_CONNECTED A sessão não está conectada, e a ação solicitada requer uma conexão de sessão ativa.
OTC_SESSION_NO_MESSAGING_SERVER Não há nenhum servidor de mensagens disponível para esta sessão.
OTC_SESSION_NULL_OR_INVALID_PARAMETER Um parâmetro passado é nulo ou inválido.
OTC_SESSION_PUBLISHER_NOT_FOUND O editor é desconhecido nesta sessão. Isso geralmente ocorre quando se tenta cancelar a publicação de um editor que não está associado à sessão.
OTC_SESSION_SIGNAL_DATA_TOO_LONG Você tentou enviar um sinal com uma sequência de dados cujo comprimento excede o máximo permitido (8 KB).
OTC_SESSION_SIGNAL_TYPE_TOO_LONG Você tentou enviar um sinal com uma string cujo comprimento excede o comprimento máximo permitido.
OTC_SESSION_UNABLE_TO_SEND_SIGNAL Não foi possível enviar o sinal com sucesso, talvez devido à falta de permissões (por exemplo, um token exclusivo para editores).
OTC_SESSION_STATE_FAILED O tempo de espera da conexão expirou durante a tentativa de obter o status da sessão.
OTC_SESSION_SUBSCRIBER_NOT_FOUND O assinante é desconhecido nesta sessão. Isso geralmente ocorre quando se tenta cancelar a assinatura de um assinante que não está associado à sessão.
OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE Resposta inesperada.
OTC_SESSION_ENCRYPTION_SECRET_MISSING Tentou participar de uma sessão com criptografia de ponta a ponta sem um segredo de criptografia.
OTC_SESSION_INVALID_ENCRYPTION_SECRET Tentou participar de uma sessão com criptografia de ponta a ponta sem um segredo de criptografia.

Documentação da função

otc_session_connect()
otc_status otc_session_connect ( otc_session * sessão,
const char * token
)

Conecta o cliente a uma sessão do OpenTok.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok à qual se conectará. | | token | O token do cliente para se conectar à sessão. Consulte Visão geral da criação de tokens. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_delete()
otc_status otc_session_delete ( otc_session * sessão )

Libera os recursos associados à sessão.

Parâmetros : | | | | --- | --- | | sessão | O otc_session instância. |

otc_session_disable_force_mute()
otc_status otc_session_disable_force_mute ( otc_session * sessão )

Desativa o estado de mudo ativo da sessão. Após chamar esse método, os novos streams publicados na sessão não terão mais o áudio silenciado.

Depois de chamar a otc_session_force_mute_all() função (ou quando um moderador em outro cliente inicia uma chamada para silenciar todas as transmissões), quaisquer transmissões publicadas após a chamada de moderação são publicadas com o áudio silenciado. Chame a otc_session_disable_force_mute função para desativar o silenciamento de uma sessão (para que as novas transmissões publicadas não sejam automaticamente silenciadas).

A chamada a essa função faz com que o otc_session_callback.on_mute_forced() função de retorno a ser chamada em cada cliente conectado à sessão, com o active propriedade do otc_on_mute_forced_info estrutura passada para a função definida como OTC_FALSE.

Ligue para o otc_session_get_capabilities função para verificar se o cliente consegue chamar essa função com sucesso. Isso é reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o Visão geral da criação de tokens.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_disconnect()
otc_status otc_session_disconnect ( otc_session * sessão )

Desconecta o cliente desta sessão. Todos os assinantes e editores do cliente também serão desconectados da sessão. Como prática recomendada, antes de chamar esta função, chame a função otc_session_unpublish função para todos os editores e aguardar o otc_publisher_callbacks#on_stream_destroyed callback. Isso garante a remoção completa dos editores, especialmente se problemas de conectividade de rede impedirem a remoção devido ao recurso de reconexão, que pode manter os fluxos dos editores ativos para uma possível reconexão.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok da qual se deseja se desconectar. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_force_disconnect()
otc_status otc_session_force_disconnect ( const otc_session * sessão,
const otc_connection * conexão
)

Obliga um cliente a se desconectar da sessão.

Embora você possa usar essa função para encerrar sua própria conexão, chamar otc_session_disconnect é mais simples. É retornado um erro se a função do cliente não incluir as permissões necessárias para forçar outros usuários a se desconectarem. Você define a função do cliente ao criar o token do usuário. Quando uma conexão é encerrada por meio dessa função, otc_session_callbacks#on_connection_dropped e otc_publisher_callbacks#on_stream_destroyed as chamadas de retorno são despachadas da mesma forma que seriam se a conexão tivesse sido encerrada automaticamente usando otc_session_disconnect.

Parâmetros : | | | | --- | --- | | sessão | A otc_session à qual a conexão pertence | | conexão | A conexão a ser desconectada |

Retorna : Um erro, caso ocorra algum erro; caso contrário, retorna OTC_SUCCESS

otc_session_force_mute_all()
otc_status otc_session_force_mute_all ( otc_session * sessão,
const char ** excluded_streams_ids,
const int excluded_streams_len
)

Obliga todos os transmissores da sessão (exceto aqueles que estão transmitindo streams excluídos) a silenciar o áudio.

Além disso, quaisquer streams publicados após a chamada à função otc_session_force_mute_all As sessões são publicadas com o áudio silenciado. Você pode desativar o silenciamento de uma sessão chamando a função otc_session_disable_force_mute função. Depois de chamar a otc_session_disable_force_mute A partir dessa função, as novas transmissões publicadas na sessão não terão mais o áudio silenciado.

A chamada a essa função faz com que o otc_session_callback.on_mute_forced() função de retorno a ser chamada em cada cliente conectado à sessão, com o active propriedade do otc_on_mute_forced_info estrutura passada para a função definida como OTC_TRUE. Além disso, o otc_publisher_callbacks.on_publisher_mute_forced() A função de retorno de chamada é chamada em cada cliente que publica um fluxo silenciado.

Ligue para o otc_session_get_capabilities função para verificar se o cliente consegue chamar essa função com sucesso. Isso é reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o (consulte o Visão geral da criação de tokens.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | excluded_streams_ids | Um ponteiro para uma matriz de strings de IDs de streams que devem ser silenciados. Defina-o como nullptr para silenciar todos os streams da sessão (incluindo aqueles publicados pelo cliente local). | | excluded_streams_len | O comprimento da matriz de fluxos excluídos. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_force_mute_stream()
otc_status otc_session_force_mute_stream ( const otc_session * sessão,
const char * stream_id_to_mute
)

Obliga o emissor de um stream especificado a silenciar seu áudio.

A chamada a essa função faz com que o otc_publisher_callbacks.on_publisher_mute_forced() função de retorno a ser chamada no cliente que está publicando o fluxo silenciado.

Ligue para o otc_session_get_capabilities função para verificar se o cliente consegue chamar essa função com sucesso. Isso é reservado para clientes que se conectaram com um token ao qual foi atribuída a função de moderador (consulte o (consulte o Visão geral da criação de tokens.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | stream_id_to_mute | A string do ID da transmissão a ser silenciada. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_get_capabilities()
struct otc_session_capabilities otc_session_get_capabilities ( const otc_session * sessão )

Obtém as capacidades do cliente conectado à sessão. Todas otc_session_capabilities os membros permanecem indefinidos até que otc_session_callbacks.on_connected foi chamado.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. |

Devoluções : O otc_session_capabilities instância.

otc_session_get_connection()
otc_connection * otc_session_get_connection ( const otc_session * sessão )

Obtém o objeto de conexão associado a esta sessão.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. |

Devoluções : O otc_connection instância.

otc_session_get_id()
char * otc_session_get_id ( const otc_session * sessão )

Obtém o ID exclusivo desta sessão.

otc_session_get_user_data()
void * otc_session_get_user_data ( const otc_session * sessão )

Obtém os dados do usuário associados à sessão. Consulte otc_session_callbacks.user_data.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. |

Retorna : Um ponteiro para os dados do usuário.

otc_session_new()
otc_session * otc_session_new ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * callbacks
)

Cria um novo otc_session instância da estrutura. Passe isso para o otc_session_connect função para se conectar à sessão do OpenTok.

Veja também otc_session_new_with_settings para inicializar uma estrutura `otc_session` com opções avançadas.

Parâmetros : | | | | --- | --- | | apikey | A chave de API do projeto OpenTok. Consulte Acesse a página do seu account da Video API da Vonage. |

Importante: Se você estiver usando a Video API com um aplicativo da Vonage (em vez de um projeto do OpenTok), insira o ID do aplicativo (e não uma chave da API do OpenTok) nesse parâmetro.

Parâmetros : | | | | --- | --- | | session_id | O ID da sessão. | | callbacks | O otc_session_callbacks estrutura que contém funções de retorno de chamada para eventos relacionados à sessão. |

Retorna : A estrutura `otc_session`, que representa a sessão do OpenTok.

otc_session_new_with_settings()
otc_session * otc_session_new_with_settings ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * callbacks,
otc_session_settings * configurações
)

Cria uma nova sessão do OpenTok com configurações avançadas. Entre elas estão as configurações para suprimir eventos de conexão, servidores TURN personalizados, o recurso de proxy de IP e o recurso de lista de permissões de IP.

Parâmetros : | | | | --- | --- | | apikey | A chave de API do projeto OpenTok. Consulte Acesse a página do seu account da Video API da Vonage. | | session_id | O ID da sessão. | | callbacks | O otc_session_callbacks estrutura que contém funções de retorno de chamada para eventos relacionados à sessão. | | configurações | O otc_session_settings struct Com configurações avançadas para a sessão. |

Devoluções : O struct, que representa a sessão do OpenTok.

Veja também : otc_session_new.

otc_session_publish()
otc_status otc_session_publish ( otc_session * sessão,
otc_publisher * editora
)

Inicia a transmissão de um publisher para a sessão.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok na qual se deseja publicar. | | publisher | O otc_publisher estrutura que representa o editor. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_report_issue()
otc_status otc_session_report_issue ( struct otc_session * sessão,
const char * descrição_do_problema,
char ** issue_id
)

Relate que seu aplicativo apresentou um problema. Você pode usar o ID do problema com o Inspetor ferramenta ou ao discutir um problema com a equipe de suporte da Video API da Vonage.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | issue_description | Uma string de descrição. | | issue_id | Um ponteiro para uma string que será definida como o identificador exclusivo do problema relatado. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_send_signal()
otc_status otc_session_send_signal ( otc_session * sessão,
const char * tipo,
const char * sinal
)

Envia um sinal a todos os clientes conectados à sessão. Consulte otc_session_send_signal_with_options, otc_session_send_signal_to_connection, e otc_session_send_signal_to_connection_with_options. Veja também o Visão geral da sinalização.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | tipo | O valor opcional do tipo (cadeia de caracteres) do sinal. | | sinal | O valor opcional dos dados (cadeia de caracteres) do sinal. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_send_signal_to_connection()
otc_status otc_session_send_signal_to_connection ( otc_session * sessão,
const char * tipo,
const char * sinal,
const otc_connection * conexão
)

Envia um sinal a um cliente específico conectado à sessão. Consulte otc_session_send_signal_to_connection_with_options, otc_session_send_signal, e otc_session_send_signal_with_options. Veja também o Visão geral da sinalização.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | tipo | O valor opcional do tipo (cadeia de caracteres) do sinal. | | sinal | O valor opcional dos dados (cadeia de caracteres) do sinal. | | conexão | O otc_connection estrutura correspondente ao cliente que receberá o sinal. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_send_signal_to_connection_with_options()
otc_status otc_session_send_signal_to_connection_with_options ( otc_session * sessão,
const char * tipo,
const char * sinal,
const otc_connection * conexão,
struct otc_signal_options opções_de_sinal
)

Envia um sinal a um cliente específico, com as opções especificadas. Consulte otc_session_send_signal, otc_session_send_signal_to_connection, e otc_session_send_signal_with_options. Veja também o Visão geral da sinalização.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | tipo | O valor opcional do tipo (cadeia de caracteres) do sinal. | | sinal | O valor opcional dos dados (cadeia de caracteres) do sinal. | | conexão | O otc_connection estrutura correspondente ao cliente que receberá o sinal. | | signal_options | O otc_signal_options estrutura com opções para o sinal. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_send_signal_with_options()
otc_status otc_session_send_signal_with_options ( otc_session * sessão,
const char * tipo,
const char * sinal,
struct otc_signal_options opções_de_sinal
)

Envia um sinal a todos os clientes conectados à sessão, com as opções especificadas. Consulte otc_session_send_signal, otc_session_send_signal_to_connection, e otc_session_send_signal_to_connection_with_options. Veja também o Visão geral da sinalização.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | type | O valor opcional do tipo (cadeia de caracteres) do sinal. | | signal | O valor opcional dos dados (cadeia de caracteres) do sinal. | | signal_options | O otc_signal_options estrutura com opções para o sinal. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_set_encryption_secret()
otc_status otc_session_set_encryption_secret ( otc_session * sessão,
const char * segredo
)

Define o segredo de criptografia de ponta a ponta que será utilizado por todos os emissores e assinantes na sessão.

Veja o Guia do desenvolvedor sobre criptografia de ponta a ponta.

Parâmetros : | | | | | --- | --- | --- | | | sessão | O otc_session estrutura que representa a sessão do OpenTok. | | [in] | secret | Valor do segredo de criptografia. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_settings_delete()
otc_status otc_session_settings_delete ( otc_session_settings * configurações )

Exclui um otc_session_settings instância.

otc_session_settings_new()
otc_session_settings * otc_session_settings_new ( nulo )

Cria um novo otc_session_settings instância, usada para definir configurações avançadas da sessão. Chame as seguintes funções para configurar essas opções antes de chamar a otc_session_new_with_settings função para criar uma sessão com essas configurações:

  • otc_session_settings_set_connection_events_suppressed — Suprimir eventos de conexão.
  • otc_session_settings_set_custom_ice_config &mdash Use servidores TURN personalizados.
  • otc_session_settings_set_proxy_url — Configure o recurso de proxy IP.
  • otc_session_settings_set_ip_whitelist — Ative o recurso de lista de endereços IP autorizados.
  • otc_session_settings_set_single_peer_connection — Ative o recurso “Conexão com um único par”.
  • otc_session_settings_set_session_migration — Ative o recurso de migração de sessão.

otc_session_settings_set_connection_events_suppressed()
otc_status otc_session_settings_set_connection_events_suppressed ( otc_session_settings * configurações,
otc_bool suprimir
)

Impedir eventos de conexão, para dar suporte a grandes sessões de vídeo interativas. Isso evita otc_session_callbacks.on_connection_created e otc_session_callbacks.on_connection_dropped impedem que as funções de retorno de chamada sejam chamadas quando outros clientes se conectam ou se desconectam da sessão. (Além disso, o servidor OpenTok não envia esses eventos ao cliente.) Para obter mais informações, consulte Supressão de eventos de conexão nos guias para desenvolvedores da OpenTok.

otc_session_settings_set_custom_ice_config()
otc_status otc_session_settings_set_custom_ice_config ( otc_session_settings * configurações,
const struct otc_custom_ice_config * custom_ice_config
)

Permite a configuração personalizada do servidor ICE. Isso faz parte do recurso TURN configurável.

otc_session_settings_set_ip_whitelist()
otc_status otc_session_settings_set_ip_whitelist ( otc_session_settings * configurações,
otc_bool lista_branca_de_IPs
)

Passe o parâmetro OTC_TRUE para que o cliente utilize a lista de endereços IP autorizados. Esse recurso está disponível como um recurso opcional.

otc_session_settings_set_proxy_url()
otc_status otc_session_settings_set_proxy_url ( otc_session_settings * configurações,
const char * proxy_url
)

Define a URL do proxy IP. Consulte o Guia do desenvolvedor do IP Proxy.

otc_session_settings_set_session_migration()
otc_status otc_session_settings_set_session_migration ( otc_session_settings * configurações,
otc_bool ativar
)

Ativa ou desativa a migração de sessão para uma sessão.

Ativa o recurso de migração de sessão, permitindo que o cliente permaneça conectado durante a rotação de servidores. O valor padrão é false (a migração de sessão não está habilitada). Para obter mais informações, consulte Rotação de servidores e migração de sessões.

Parâmetros : | | | | --- | --- | | settings | Ponteiro para o objeto de configurações da sessão. | | enable | Indicador booleano para ativar (OTC_TRUE) ou desativar (OTC_FALSE) a migração de sessão. |

Retorna : otc_status Retorna o status da operação.

otc_session_settings_set_single_peer_connection()
otc_status otc_session_settings_set_single_peer_connection ( otc_session_settings * configurações,
otc_bool ativar
)

Ativa ou desativa a Conexão de Par Único (SPC) para uma sessão.

A Conexão Única com Par (SPC) é um recurso que encapsula todas as conexões dos assinantes em uma única conexão com par. Os benefícios de ativar a SPC incluem menor consumo de recursos do sistema operacional, melhor controle de taxa e, no caso de dispositivos móveis nativos, suporte a sessões maiores.

O SPC está desativado por padrão. Quando desativado, a sessão utilizará a Conexão de Pares Múltiplos (MPC), na qual é estabelecida uma conexão de par separada entre cada terminal.

Parâmetros : | | | | --- | --- | | settings | Ponteiro para o objeto de configurações da sessão. | | enable | Indicador booleano para ativar (OTC_TRUE) ou desativar (OTC_FALSE) o SPC. |

Retorna : otc_status Retorna o status da operação.

otc_session_subscribe()
otc_status otc_session_subscribe ( otc_session * sessão,
otc_assinante * assinante
)

Inicia a assinatura (o recebimento de um fluxo) do fluxo de áudio e vídeo de um assinante nesta sessão.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok contendo o fluxo do assinante. | | assinante | O otc_subscriber estrutura que representa o assinante. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_unpublish()
otc_status otc_session_unpublish ( otc_session * sessão,
otc_publisher * editora
)

Encerra um publisher de uma sessão (fazendo com que seu fluxo seja interrompido).

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok da qual se deseja cancelar a publicação. | | publisher | O otc_publisher estrutura que representa o editor. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.

otc_session_unsubscribe()
otc_status otc_session_unsubscribe ( otc_session * sessão,
otc_assinante * assinante
)

Interrompe a assinatura (o recebimento de um stream) de um assinante especificado na sessão.

Parâmetros : | | | | --- | --- | | sessão | O otc_session estrutura que representa a sessão do OpenTok contendo o fluxo do assinante. | | assinante | O otc_subscriber estrutura que representa o assinante. |

Retornos : Valor de retorno que indica se houve erro ou sucesso.