Assinante do OpenTok. Mais...

#include "audio_data.h" #include "base.h" #include "config.h" #include "error.h" #include "media_utils.h" #include "stream.h" #include "video_frame.h"
Definições de tipos
typedef struct otc_assinante otc_assinante
Funções
otc_assinante * otc_subscriber_new (const otc_stream *stream, const struct otc_subscriber_callbacks *callbacks)
otc_status otc_subscriber_delete (otc_assinante *assinante)
otc_stream * otc_subscriber_get_stream (const otc_assinante *assinante)
otc_status otc_subscriber_set_subscribe_to_video (otc_assinante *assinante, otc_bool (subscribe_to_video)
otc_status otc_subscriber_set_subscribe_to_audio (otc_assinante *assinante, otc_bool subscribe_to_audio)
otc_status otc_subscriber_set_subscribe_to_captions (otc_assinante *assinante, otc_bool subscribe_to_captions)
otc_status otc_subscriber_set_captions_translation_language (otc_assinante *assinante, const char *idioma)
otc_bool otc_subscriber_get_subscribe_to_video (const otc_assinante *assinante)
otc_bool otc_subscriber_get_subscribe_to_audio (const otc_assinante *assinante)
otc_bool otc_subscriber_get_subscribe_to_captions (const otc_assinante *assinante)
otc_session * otc_subscriber_get_session (const otc_assinante *assinante)
otc_status otc_subscriber_set_preferred_resolution (otc_assinante *assinante, uint32_t largura_preferida, uint32_t altura_preferida)
otc_status otc_subscriber_get_preferred_resolution (const otc_assinante *subscriber, uint32_t *preferred_width, uint32_t *preferred_height)
otc_status otc_subscriber_set_audio_volume (otc_assinante *assinante, volume duplo)
otc_status otc_subscriber_get_audio_volume (const otc_assinante *assinante, o dobro do *volume)
otc_status otc_subscriber_set_preferred_framerate (otc_assinante *assinante, float taxa_de_quadros_preferida)
otc_status otc_subscriber_get_preferred_framerate (const otc_assinante *assinante, float *taxa_de_quadros_preferida)
const char * otc_subscriber_get_subscriber_id (const otc_assinante *assinante)
void * otc_subscriber_get_user_data (const otc_assinante *assinante)
otc_status otc_subscriber_get_rtc_stats_report (const otc_assinante *assinante)
otc_status otc_subscriber_set_rtc_stats_report_cb (otc_assinante *assinante, struct otc_subscriber_rtc_stats_report_cb cb)
const char * otc_subscriber_get_captions_translation_language (const otc_assinante *assinante)

Descrição detalhada

Assinante do OpenTok.

Este arquivo inclui a definição de tipo para um assinante do OpenTok, juntamente com várias declarações de função.

Documentação sobre `typedef`

otc_assinante
typedef struct otc_assinante otc_assinante

Definição do tipo de assinante do OpenTok.

Um tipo que representa o consumidor de áudio e vídeo de um fluxo na sessão do OpenTok.

Documentação sobre tipos de enumeração

otc_subscriber_error_code

Lista de códigos de erro para assinantes do OpenTok. Essa lista apresenta vários códigos de erro associados a um assinante.

Recenseador
OTC_SUBSCRIBER_INTERNAL_ERROR Erro interno ao se inscrever.
OTC_SUBSCRIBER_SESSION_DISCONNECTED Tentativa de assinar um stream em uma sessão da qual você já se desconectou.
OTC_SUBSCRIBER_SERVER_CANNOT_FIND_STREAM O assinante falhou porque o fluxo não está disponível. Isso pode ocorrer se o assinante for criado ao mesmo tempo em que o fluxo é removido da sessão.
OTC_SUBSCRIBER_STREAM_LIMIT_EXCEEDED O cliente tentou se inscrever em uma transmissão em uma sessão que já havia excedido o limite de transmissões simultâneas.
OTC_SUBSCRIBER_TIMED_OUT Ocorreu um tempo limite durante a tentativa de assinatura.
OTC_SUBSCRIBER_WEBRTC_ERROR Falha no WebRTC do assinante.
OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED A conexão entre pares ainda não foi criada nem estabelecida.
OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR Erro interno ao descriptografar um pacote
OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH Incompatibilidade secreta durante a descriptografia de um pacote
OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC Codec de mídia não compatível para descriptografia

Documentação da função

otc_subscriber_delete()
otc_status otc_subscriber_delete ( otc_assinante * assinante )

Libera uma instância de assinante, incluindo todos os recursos de hardware e da interface do usuário vinculados a ela. Sem callbacks em otc_subscriber_callbacks será chamado como resultado da chamada a este método (ou posteriormente).

Parâmetros : | | | | --- | --- | | assinante | O assinante a ser excluído. |

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

otc_subscriber_get_audio_volume()
otc_status otc_subscriber_get_audio_volume ( const otc_assinante * assinante,
duplo * volume
)

Retorna o volume de áudio, entre 0 e 100, do assinante.

O valor padrão é 100.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. | | volume | O volume do assinante. |

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

Veja também : otc_error_code

otc_subscriber_get_captions_translation_language()
const char * otc_subscriber_get_captions_translation_language ( const otc_assinante * assinante )

Obtém o idioma de tradução das legendas configurado para um determinado assinante.

Este é um recurso em versão beta privada.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. |

Retorna : O idioma configurado para tradução. Pode ser nulo caso não esteja definido.

otc_subscriber_get_preferred_framerate()
otc_status otc_subscriber_get_preferred_framerate ( const otc_assinante * assinante,
float * taxa de quadros preferida
)

Retorna a taxa de quadros preferencial para o stream do assinante.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante. | | preferred_framerate | A taxa de quadros preferencial associada ao assinante. |

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

Veja também : otc_error_code

otc_subscriber_get_preferred_resolution()
otc_status otc_subscriber_get_preferred_resolution ( const otc_assinante * assinante,
uint32_t * largura_preferida,
uint32_t * altura_preferida
)

Retorna a resolução preferencial para o stream do assinante.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante. | | preferred_width | A largura preferencial do assinante. | | preferred_height | A altura preferencial do assinante. |

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

Veja também : otc_error_code

otc_subscriber_get_rtc_stats_report()
otc_status otc_subscriber_get_rtc_stats_report ( const otc_assinante * assinante )

Obtém o relatório de estatísticas do RTC para o assinante. Esta é uma operação assíncrona. Crie um otc_subscriber_rtc_stats_report_cb struct e passá-la para o otc_subscriber_set_rtc_stats_report_cb função antes de chamar esta função. Quando as estatísticas estiverem disponíveis, a otc_subscriber_set_rtc_stats_report_cb a função de retorno de chamada é chamada.

Veja também otc_subscriber_callbacks.on_audio_stats, otc_subscriber_callbacks.on_video_stats, e otc_publisher_get_rtc_stats_report.

Parâmetros : | | | | --- | --- | | assinante | O assinante. |

otc_subscriber_get_session()
otc_session * otc_subscriber_get_session ( const otc_assinante * assinante )

Retorna o otc_session associada a esta instância.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. |

Devoluções : O otc_session associado a esta instância. Esse valor pode ser nulo caso ocorra um erro.

otc_subscriber_get_stream()
otc_stream * otc_subscriber_get_stream ( const otc_assinante * assinante )

Retorna o fluxo associado ao assinante.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante da qual se deseja obter o fluxo. |

Retorna : O fluxo associado ao assinante. Esse valor pode ser nulo caso ocorra um erro.

otc_subscriber_get_subscribe_to_audio()
otc_bool otc_subscriber_get_subscribe_to_audio ( const otc_assinante * assinante )

Retorna se o assinante está inscrito no áudio do stream ou não.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. |

Retorna : Se o assinante está inscrito no áudio do stream ou não.

otc_subscriber_get_subscribe_to_captions()
otc_bool otc_subscriber_get_subscribe_to_captions ( const otc_assinante * assinante )

Retorna se o assinante está inscrito nas legendas do stream ou não.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. |

Retorna : Se o assinante está inscrito nas legendas da transmissão ou não. O valor padrão é o valor das legendas definido pelo editor da transmissão otc_publisher_get_publish_captions

otc_subscriber_get_subscribe_to_video()
otc_bool otc_subscriber_get_subscribe_to_video ( const otc_assinante * assinante )

Retorna se o assinante está inscrito no vídeo do stream ou não.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. |

Retorna : Se o assinante está inscrito no canal de vídeo ou não.

otc_subscriber_get_subscriber_id()
const char * otc_subscriber_get_subscriber_id ( const otc_assinante * assinante )

Obtém um identificador exclusivo para um determinado assinante.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. |

Retorna : Um identificador exclusivo para o assinante. Esse valor pode ser nulo caso ocorra um erro.

otc_subscriber_get_user_data()
void * otc_subscriber_get_user_data ( const otc_assinante * assinante )

Obtém os dados do usuário correspondentes a um determinado assinante.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. |

Retorna : Um ponteiro para os dados do usuário na memória.

otc_subscriber_new()
otc_assinante * otc_subscriber_new ( const otc_stream * fluxo,
const struct otc_subscriber_callbacks * callbacks
)

Cria um novo assinante para um determinado fluxo.

Parâmetros : | | | | --- | --- | | stream | O objeto Stream correspondente ao fluxo ao qual você se inscreverá. | | callbacks | Estrutura com ponteiros para as funções de retorno de chamada do assinante. |

Retorna : A nova instância de Subscriber. Pode ser nulo caso ocorra um erro.

otc_subscriber_set_audio_volume()
otc_status otc_subscriber_set_audio_volume ( otc_assinante * assinante,
duplo volume
)

Define o volume do áudio do assinante, entre 0 e 100. Se o valor não estiver dentro desse intervalo, ele será ajustado para ficar dentro dele.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante. | | volume | O volume do assinante. |

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

Veja também : otc_error_code

otc_subscriber_set_captions_translation_language()
otc_status otc_subscriber_set_captions_translation_language ( otc_assinante * assinante,
const char * língua
)

Define o idioma preferencial de tradução das legendas para um determinado assinante.

Este é um recurso em versão beta privada.

Parâmetros : | | | | --- | --- | | assinante | A instância do assinante que será afetada. | | idioma | Um código de idioma compatível ou “null” para desativar a tradução. |

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

otc_subscriber_set_preferred_framerate()
otc_status otc_subscriber_set_preferred_framerate ( otc_assinante * assinante,
float taxa de quadros preferida
)

Define a taxa de quadros preferencial para o stream do assinante.

O valor padrão é 100.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante que será afetada. | | preferred_framerate | A taxa de quadros preferencial do assinante. |

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

Veja também : otc_error_code

otc_subscriber_set_preferred_resolution()
otc_status otc_subscriber_set_preferred_resolution ( otc_assinante * assinante,
uint32_t largura_preferida,
uint32_t altura_preferida
)

Define a resolução preferencial para o stream do assinante.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante que será afetada. | | preferred_width | A largura preferencial do assinante. | | preferred_height | A altura preferencial do assinante. |

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

Veja também : otc_error_code

otc_subscriber_set_rtc_stats_report_cb()
otc_status otc_subscriber_set_rtc_stats_report_cb ( otc_assinante * assinante,
struct otc_subscriber_rtc_stats_report_cb cb
)

Define a função de retorno de chamada do relatório de estatísticas do RTC para o assinante. Consulte otc_subscriber_get_rtc_stats_report.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante. | | cb | O otc_subscriber_rtc_stats_report_cb estrutura que inclui a função de retorno de chamada para o relatório de estatísticas do RTC. |

otc_subscriber_set_subscribe_to_audio()
otc_status otc_subscriber_set_subscribe_to_audio ( otc_assinante * assinante,
otc_bool inscrever-se no podcast
)

Assina o áudio do stream.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante que será afetada. | | subscribe_to_audio | Se deve ou não assinar o áudio. |

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

otc_subscriber_set_subscribe_to_captions()
otc_status otc_subscriber_set_subscribe_to_captions ( otc_assinante * assinante,
otc_bool inscrever-se para receber legendas
)

Assina as legendas da transmissão.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante que será afetada. | | subscribe_to_captions | Se deve ou não assinar as legendas. |

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

otc_subscriber_set_subscribe_to_video()
otc_status otc_subscriber_set_subscribe_to_video ( otc_assinante * assinante,
otc_bool inscrever-se no canal
)

Inscreve-se no canal de vídeos.

Parâmetros : | | | | --- | --- | | subscriber | A instância do assinante que será afetada. | | subscribe_to_video | Se deve ou não assinar o vídeo. |

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