#include <session.h>
Descrição detalhada
Funções de retorno de chamada da sessão.
Essa estrutura é um conjunto de ponteiros de função para funções de retorno de chamada relacionadas a eventos de uma sessão do OpenTok.
Todas as chamadas de retorno não serão executadas na thread do aplicativo ou na thread principal, mas em uma thread interna. O aplicativo deve retornar a chamada de retorno o mais rápido possível para evitar o bloqueio da thread interna.
Dados passados para uma função de retorno de chamada (exceto session e user_data) serão liberados após a chamada da função de retorno. Faça uma cópia dos dados caso precise mantê-los.
Documentação de campo
on_archive_started
| void(* on_archive_started) (otc_session *sessão, void *dados_do_usuário, const char *archive_id, const char *name) |
É chamado quando um arquivo da sessão começa a ser gravado. Consulte o Guia do desenvolvedor sobre arquivamento.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | archive_id | O ID do arquivo. | | name | O nome do arquivo (caso tenha sido fornecido no momento da criação do arquivo). |
on_archive_stopped
| void(* on_archive_stopped) (otc_session *sessão, void *dados_do_usuário, const char *archive_id) |
É chamado quando a gravação do arquivo da sessão é interrompida.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o user_data definido para a sessão. | | archive_id | O ID do arquivo. |
on_connected
| void(* on_connected) (otc_session *sessão, void *dados_do_usuário) |
É chamado quando o otc_session_connect A função conecta o cliente com sucesso a uma sessão do OpenTok.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o user_data definido para a sessão. |
on_connection_created
| void(* on_connection_created) (otc_session *sessão, void *dados_do_usuário, const otc_connection *conexão) |
É chamado quando uma nova conexão (de outro cliente) é criada.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para os dados de usuário (user_data) definidos para a sessão. |
| connection | O otc_connection estrutura correspondente ao cliente que está se conectando à sessão. |
on_connection_dropped
| void(* on_connection_dropped) (otc_session *sessão, void *dados_do_usuário, const otc_connection *conexão) |
É chamado quando a conexão de outro cliente com a sessão é interrompida.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para os dados de usuário (user_data) definidos para a sessão. |
| connection | O otc_connection estrutura correspondente ao cliente que se desconecta da sessão. |
on_disconnected
| void(* on_disconnected) (otc_session *sessão, void *dados_do_usuário) |
É chamado quando o cliente não está mais conectado à sessão do OpenTok.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o user_data definido para a sessão. |
on_error
| void(* on_error) (otc_session *sessão, void *dados_do_usuário, const char *error_string, enum otc_session_error_code erro) |
É chamado quando a sessão falha.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para o user_data definido para a sessão. |
| error_string | A string de erro. |
| error | O código de erro (do tipo otc_session_error_code). |
on_mute_forced
| void(* on_mute_forced) (otc_session *sessão, void *dados_do_usuário, otc_on_mute_forced_info *mute_info) |
É chamado quando um moderador silencia transmissões na sessão ou desativa o estado de silenciamento na sessão.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para o user_data definido para a sessão. |
| mute_info | Verifique o active propriedade desta estrutura. Ela está definida como OTC_TRUE quando um moderador silencia o áudio na sessão. Está configurado para OTC_FALSE quando um moderador desativa o modo de áudio silenciado na sessão. |
on_reconnected
| void(* on_reconnected) (otc_session *sessão, void *dados_do_usuário) |
É chamado quando o cliente local se reconecta à sessão do OpenTok após uma perda temporária da conexão de rede.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o user_data definido para a sessão. |
on_reconnection_started
| void(* on_reconnection_started) (otc_session *sessão, void *dados_do_usuário) |
É chamado quando o cliente local perde a conexão com a sessão do OpenTok e está tentando se reconectar.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o user_data definido para a sessão. |
on_signal_received
| void(* on_signal_received) (otc_session *sessão, void *dados_do_usuário, const char *type, const char *signal, const otc_connection *conexão) |
É chamado quando um sinal é recebido na sessão. Consulte o Visão geral da sinalização documentação.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para os dados de usuário (user_data) definidos para a sessão. |
| type | A string de tipo do sinal (caso tenha sido fornecida no momento do envio do sinal). |
| signal | A string de dados do sinal (caso tenha sido fornecida no momento do envio do sinal). |
| connection | A otc_connection representando o cliente que enviou o sinal. |
on_stream_dropped
| void(* on_stream_dropped) (otc_session *sessão, void *dados_do_usuário, const otc_stream *transmissão) |
É chamado quando o stream de outro cliente é desconectado desta sessão do OpenTok.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para o user_data definido para a sessão. |
| stream | O otc_stream estrutura que representa o fluxo. |
on_stream_has_audio_changed
| void(* on_stream_has_audio_changed) (otc_session *sessão, void *dados_do_usuário, const otc_stream *transmissão, otc_bool has_audio) |
É chamado quando uma transmissão ativa ou desativa o áudio.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para o user_data definido para a sessão. |
| stream | O otc_stream estrutura que representa o novo fluxo. |
| has_audio | Se o fluxo agora possui áudio (OTC_TRUE) ou não (OTC_FALSE). |
on_stream_has_captions_changed
| void(* on_stream_has_captions_changed) (otc_session *sessão, void *dados_do_usuário, const otc_stream *transmissão, otc_bool has_captions) |
É chamado quando uma transmissão ativa ou desativa as legendas.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o `user_data` definido para a sessão. | | stream | Um ponteiro para a estrutura `otc_stream` que representa o stream. | | has_captions | Indica se o stream possui legendas (OTC_TRUE) ou não (OTC_FALSE). |
on_stream_has_video_changed
| void(* on_stream_has_video_changed) (otc_session *sessão, void *dados_do_usuário, const otc_stream *transmissão, otc_bool has_video) |
É chamado quando uma transmissão ativa ou desativa o vídeo.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o `user_data` definido para a sessão. | | stream | Se o stream contém vídeo (OTC_TRUE) ou não (OTC_FALSE). |
on_stream_received
| void(* on_stream_received) (otc_session *sessão, void *dados_do_usuário, const otc_stream *transmissão) |
É chamado quando há um novo stream nesta sessão do OpenTok. Chame o otc_session_subscribe função para se inscrever no stream.
Parâmetros
: | | |
| --- | --- |
| session | Um ponteiro para a estrutura otc_session. |
| user_data | Um ponteiro para o user_data definido para a sessão. |
| stream | O otc_stream estrutura que representa o novo fluxo. |
on_stream_video_dimensions_changed
| void(* on_stream_video_dimensions_changed) (otc_session *sessão, void *dados_do_usuário, const otc_stream *stream, int largura, int altura) |
É chamado quando as dimensões do vídeo de um stream na sessão são alteradas.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o user_data definido para a sessão. | | width | A nova largura do stream, em pixels. | | height | A nova altura do fluxo, em pixels. |
on_stream_video_type_changed
| void(* on_stream_video_type_changed) (otc_session *sessão, void *dados_do_usuário, const otc_stream *stream, enum otc_stream_video_type tipo) |
É chamado quando o tipo de vídeo de um stream na sessão é alterado.
Parâmetros : | | | | --- | --- | | session | Um ponteiro para a estrutura otc_session. | | user_data | Um ponteiro para o user_data definido para a sessão. | | type | O novo tipo de fluxo. |
reservado
| void* reservado |
Um ponteiro nulo para uma área de memória que contém recursos reservados utilizados para a implementação interna.
dados_do_usuário
| void* user_data |
Um ponteiro para os dados que você definiu relacionados à sessão.