OpenTok Publisher. Mais...
#include "base.h"
#include "config.h"
#include "stream.h"
#include "video_frame.h"
#include "camera_capture_resolution.h"
#include "media_transformer.h"
#include "video_capturer.h"
#include "media_utils.h"
| Estruturas de Dados | |
| struct | otc_publisher_video_layer_stats |
| struct | otc_publisher_audio_stats |
| struct | otc_publisher_video_stats |
| struct | otc_publisher_media_link_stats |
| struct | otc_publisher_callbacks |
| struct | otc_publisher_rtc_stats |
| struct | otc_publisher_rtc_stats_report_cb |
| Macros | |
| #define | OTC_MAX_VIDEO_LAYERS 3 |
| Definições de tipos | |
| typedef struct otc_publisher | otc_publisher |
| typedef struct otc_configurações_do_editor | otc_configurações_do_editor |
Descrição detalhada
OpenTok Publisher.
Este arquivo inclui a definição do tipo para um publisher do OpenTok, juntamente com várias declarações de função.
Documentação sobre `typedef`
otc_publisher
| typedef struct otc_publisher otc_publisher |
Definição do tipo de editor do OpenTok.
Um tipo que representa um emissor de um fluxo de áudio e vídeo para uma sessão do OpenTok.
otc_configurações_do_editor
| typedef struct otc_configurações_do_editor otc_configurações_do_editor |
Definição do tipo de configurações do editor do OpenTok.
Documentação sobre tipos de enumeração
otc_degradação_preferência
Descreve a política que o mecanismo de vídeo tentará seguir ao adaptar a taxa de quadros e a resolução a largura de banda e CPU limitadas. Trata-se de uma política de “melhor esforço”. Não há garantias quanto à taxa de quadros, e alguns quadros ainda podem ser pulados por outros motivos.
Para mais detalhes, consulte Preferência de degradação.
| Recenseador | |
|---|---|
| OTC_DEGRADATION_PREFERENCE_NOT_SET | Valor padrão. O mecanismo de vídeo determinará a preferência ideal de redução de qualidade. |
| OTC_DEGRADATION_PREFERENCE_MAINTAIN_FRAMERATE_AND_RESOLUTION | O mecanismo de vídeo não reduzirá a resolução e tentará manter a taxa de quadros estável. Em algumas versões do padrão, essa opção é denominada “DESATIVADA”, o que significa que nenhuma redução de qualidade será aplicada quando houver recursos limitados. |
| OTC_DEGRADATION_PREFERENCE_MAINTAIN_FRAMERATE | O motor de vídeo tentará manter a taxa de quadros estável, mas poderá reduzir a resolução, se necessário. |
| OTC_DEGRADATION_PREFERENCE_MAINTAIN_RESOLUTION | O motor de vídeo não reduzirá a resolução, mas poderá reduzir a taxa de quadros, se necessário. |
| OTC_DEGRADATION_PREFERENCE_BALANCED | O motor de vídeo tentará encontrar um equilíbrio entre a redução da resolução e da taxa de quadros, quando necessário. |
otc_publisher_error_code
Lista de códigos de erro para editores do OpenTok.
Essa enumeração representa vários códigos de erro associados a um editor.
| Recenseador | |
|---|---|
| OTC_PUBLISHER_INTERNAL_ERROR | Erro interno. |
| OTC_PUBLISHER_SESSION_DISCONNECTED | Erro ao tentar ativar as legendas em uma sessão à qual você não está conectado. |
| OTC_PUBLISHER_TIMED_OUT | Ocorreu um tempo limite durante a tentativa de publicação. |
| OTC_PUBLISHER_UNABLE_TO_PUBLISH | Erro ao tentar publicar. |
| OTC_PUBLISHER_WEBRTC_ERROR | Erro do WebRTC. |
| OTC_PUBLISHER_ENCRYPTION_INTERNAL_ERROR | Erro interno durante a criptografia de um pacote |
| OTC_PUBLISHER_ENCRYPTION_UNSUPPORTED_CODEC | Codec de mídia não compatível para criptografia |
otc_publisher_video_type
Enumeração dos tipos de vídeo do editor.
Esta enumeração representa os diferentes tipos de vídeo compatíveis.
| Recenseador | |
|---|---|
| OTC_PUBLISHER_VIDEO_TYPE_CAMERA | Transmissão de vídeo da câmera. |
| OTC_PUBLISHER_VIDEO_TYPE_SCREEN | Captura de tela do fluxo de vídeo. |
otc_video_bitrate_preset
Estratégias predefinidas para controlar a taxa de bits de vídeo na transmissão de um editor.
Essas predefinições permitem que os desenvolvedores apliquem estratégias de largura de banda sem precisar especificar manualmente as taxas de bits. As predefinições são mutuamente exclusivas em relação à configuração manual da taxa de bits.
Para mais detalhes, consulte Taxa de bits máxima do editor.
| Recenseador | |
|---|---|
| OTC_VIDEO_BITRATE_PRESET_DEFAULT | Configuração padrão. Não são aplicadas restrições adicionais. Este é o modo padrão. |
| OTC_VIDEO_BITRATE_PRESET_BW_SAVER | Predefinição de economia de largura de banda. Aplica restrições moderadas para reduzir o uso de largura de banda, mantendo uma qualidade de vídeo razoável. |
| OTC_VIDEO_BITRATE_PRESET_EXTRA_BW_SAVER | Predefinição “Economizador de largura de banda extra”. Aplica restrições rigorosas para minimizar o uso de largura de banda. |
| OTC_VIDEO_BITRATE_PRESET_CUSTOM | Taxa de bits personalizada. Representa uma taxa de bits configurada manualmente usando otc_publisher_set_max_video_bitrate(). Esse valor é retornado pelo getter da predefinição apenas para fins de rastreamento interno e não pode ser passado para o setter da predefinição. |
Documentação da função
otc_publisher_delete()
| otc_status otc_publisher_delete | ( | otc_publisher * | editora | ) |
Libera uma instância de publisher, incluindo todos os recursos de hardware vinculados a ela.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher a ser excluída. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_get_degradation_preference()
| enum otc_degradação_preferência otc_publisher_get_degradation_preference | ( | const otc_publisher * | editora | ) |
Obtém a política preferencial que o mecanismo de vídeo seguirá ao ajustar a taxa de quadros e a resolução de acordo com condições de largura de banda e CPU limitadas. Consulte otc_degradation_preference para obter uma descrição dos valores possíveis.
Parâmetros : | | | | | --- | --- | --- | | [in] | publisher | A instância do publisher. |
Retorna : A preferência de degradação atual.
otc_publisher_get_max_video_bitrate()
| int otc_publisher_get_max_video_bitrate | ( | const otc_publisher * | editora | ) |
Obtém a taxa de bits máxima definida para a transmissão de vídeo deste editor.
Retorna a taxa de bits máxima de vídeo configurada no momento, em bits por segundo (bps). Se nenhuma taxa de bits manual tiver sido definida por meio de otc_publisher_set_max_video_bitrate(), ou, se uma predefinição estiver ativa (incluindo a padrão), esta função retorna 0.
Observação: Um valor de retorno igual a 0 indica que nenhum limite explícito de taxa de bits foi aplicado e que o stream está utilizando, em vez disso, um comportamento baseado em predefinições.
Parâmetros : | | | | | --- | --- | --- | | [in] | publisher | A instância do publisher. |
Retorna : A taxa de bits máxima atual do vídeo em bits por segundo, ou 0 se não tiver sido definida manualmente.
otc_publisher_get_name()
| const char * otc_publisher_get_name | ( | const struct otc_publisher * | editora | ) |
Obtém o nome de um editor específico.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retorna : O nome.
otc_publisher_get_publish_audio()
| otc_bool otc_publisher_get_publish_audio | ( | const otc_publisher * | editora | ) |
Retorna se o Publisher está transmitindo áudio ou não.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retornos : Se a editora está publicando áudio ou não.
otc_publisher_get_publish_captions()
| otc_bool otc_publisher_get_publish_captions | ( | const otc_publisher * | editora | ) |
Retorna se o Publisher possui legendas ativas.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retornos : Se o editor tem legendas ativadas ou não.
otc_publisher_get_publish_video()
| otc_bool otc_publisher_get_publish_video | ( | const otc_publisher * | editora | ) |
Retorna se o editor está publicando um vídeo ou não.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retornos : Se o editor está publicando vídeos ou não.
otc_publisher_get_publisher_id()
| const char * otc_publisher_get_publisher_id | ( | const otc_publisher * | editora | ) |
Obtém um identificador exclusivo para um editor.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retorna : Um identificador exclusivo para o editor. Se houver um erro, esse valor será nulo.
otc_publisher_get_rtc_stats_report()
| otc_status otc_publisher_get_rtc_stats_report | ( | const otc_publisher * | editora | ) |
Obtém o relatório de estatísticas do RTC para o editor. Esta é uma operação assíncrona. Crie um otc_publisher_rtc_stats_report_cb struct e passá-la para o otc_publisher_set_rtc_stats_report_cb função antes de chamar esta função. Quando as estatísticas estiverem disponíveis, a otc_publisher_set_rtc_stats_report_cb a função de retorno de chamada é chamada.
Veja também otc_publisher_callbacks.on_audio_stats, otc_publisher_callbacks.on_video_stats, e otc_subscriber_get_rtc_stats_report.
Parâmetros : | | | | --- | --- | | editor | O editor. |
otc_publisher_get_session()
| otc_session * otc_publisher_get_session | ( | const otc_publisher * | editora | ) |
Retorna o otc_session associada a essa instância de editora.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Devoluções
: O otc_session associado a esta instância. Se houver um erro, esse valor será nulo.
otc_publisher_get_stream()
| otc_stream * otc_publisher_get_stream | ( | otc_publisher * | editora | ) |
Retorna o fluxo associado ao editor. Não há callbacks em otc_publisher_callbacks será chamado como resultado da chamada a este método (ou posteriormente).
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher da qual se deseja obter o fluxo. |
Retorna : O fluxo associado ao editor. Se ocorrer um erro, esse valor será nulo.
otc_publisher_get_target_scalability_mode()
| const char * otc_publisher_get_target_scalability_mode | ( | otc_publisher * | editora | ) |
Obtém o modo de escalabilidade de destino que foi definido explicitamente por meio de otc_publisher_set_target_scalability_mode. Retorna o último valor passado ao setter ou NULL, caso o setter nunca tenha sido chamado. Isso reflete a intenção do usuário, e não o modo efetivamente aplicado (que pode diferir devido a um fallback dependente do codec).
Este é um recurso em fase beta.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retorna : O modo de escalabilidade de destino definido pelo chamador ou NULL, caso não tenha sido explicitamente definido.
otc_publisher_get_user_data()
| void * otc_publisher_get_user_data | ( | const struct otc_publisher * | editora | ) |
Obtém os dados do usuário para um determinado editor.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retorna : Um ponteiro para os dados do usuário na memória.
otc_publisher_get_video_bitrate_preset()
| enum otc_video_bitrate_preset otc_publisher_get_video_bitrate_preset | ( | const otc_publisher * | editora | ) |
Obtém a predefinição de taxa de bits de vídeo atualmente ativa para a transmissão deste editor.
Se uma taxa de bits personalizada tiver sido definida anteriormente usando otc_publisher_set_max_video_bitrate(), esse método retorna OTC_VIDEO_BITRATE_PRESET_CUSTOM.
Parâmetros : | | | | | --- | --- | --- | | [in] | publisher | A instância do publisher. |
Retornos : A predefinição de taxa de bits ativa.
otc_publisher_get_video_type()
| enum otc_publisher_video_type otc_publisher_get_video_type | ( | const struct otc_publisher * | editora | ) |
Obtém o tipo de vídeo do editor. Consulte o otc_publisher_set_video_type função.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. |
Retornos : O tipo de vídeo do editor.
otc_publisher_new()
| otc_publisher * otc_publisher_new | ( | const char * | nome, |
| const struct otc_video_capturer_callbacks * | capturador, | ||
| const struct otc_publisher_callbacks * | callbacks | ||
| ) |
Cria uma nova instância de `otc_publisher`.
Parâmetros : | | | | --- | --- | | nome | O nome do editor. Outros clientes podem obter os nomes dos fluxos na sessão. | | capturer | Use este parâmetro se desejar fornecer um capturador de vídeo personalizado. Se estiver definido como nulo, o editor usa um capturador de vídeo padrão que utiliza a câmera do sistema. | | callbacks | Um ponteiro para a estrutura com os ponteiros das funções de retorno de chamada do editor. |
Retorna : Uma nova instância de `otc_publisher`. Se ocorrer um erro, o valor retornado será `null`.
otc_publisher_new_with_settings()
| otc_publisher * otc_publisher_new_with_settings | ( | const struct otc_publisher_callbacks * | callbacks, |
| otc_configurações_do_editor * | configurações | ||
| ) |
Cria uma nova instância de `otc_publisher`.
Parâmetros : | | | | --- | --- | | callbacks | Um ponteiro para a estrutura que contém os ponteiros para as funções de retorno de chamada do editor. | | settings | A estrutura de configurações que contém as configurações desejadas para o editor. |
Retorna : Uma nova instância de `otc_publisher`. Se ocorrer um erro, o valor retornado será `null`.
otc_publisher_set_audio_transformers()
| otc_status otc_publisher_set_audio_transformers | ( | otc_publisher * | editora, |
| otc_audio_transformer ** | transformadores, | ||
| uint8_t | tamanho | ||
| ) |
Define um array de transformadores de áudio para o fluxo de áudio deste publisher. Se for nulo, os transformadores são reinicializados.
A matriz pode ser composta por transformadores de áudio do Vonage fornecidos pela biblioteca ml e/ou por transformadores personalizados. Os transformadores contêm um ponteiro para a função de retorno de chamada que é invocada a cada quadro de áudio.
Observação: Essa função se aplica apenas ao SDK do macOS da Video API do Vonage. Ela não funciona no SDK do Linux da Video API do Vonage.
Parâmetros : | | | | | --- | --- | --- | | [in] | publisher | A instância do publisher. | | [in] | transformadores | Matriz de ponteiros opacos para otc_audio_transformer, na ordem em que serão aplicados ao fluxo. | | [in] | tamanho | tamanho da matriz. |
Retorna : um erro caso ocorra algum problema; caso contrário, retorna OTC_SUCCESS.
otc_publisher_set_degradation_preference()
| otc_status otc_publisher_set_degradation_preference | ( | otc_publisher * | editora, |
| enum otc_degradação_preferência | preferência_de_degradação | ||
| ) |
Define a política preferencial que o mecanismo de vídeo seguirá ao ajustar a taxa de quadros e a resolução de acordo com condições de largura de banda e CPU limitadas. Consulte otc_degradation_preference para obter uma descrição dos valores possíveis.
Parâmetros : | | | | | --- | --- | --- | | [in] | publisher | A instância do publisher. | | [in] | degradation_preference | A preferência de degradação. |
Retorna : OTC_SUCCESS ou um erro.
otc_publisher_set_max_audio_bitrate()
| otc_status otc_publisher_set_max_audio_bitrate | ( | otc_publisher * | editora, |
| uint32_t | taxa de bits | ||
| ) |
Define a taxa de bits máxima de áudio para o editor.
Parâmetros : | | | | --- | --- | | publisher | O publisher a ser afetado. | | bitrate | A taxa de bits desejada em kbps. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_set_max_video_bitrate()
| otc_status otc_publisher_set_max_video_bitrate | ( | otc_publisher * | editora, |
| int | taxa de bits_bps | ||
| ) |
Obtém a taxa de bits máxima definida para a transmissão de vídeo deste editor.
Retorna a taxa de bits máxima atual do vídeo em bits por segundo (bps). Se nenhuma taxa de bits tiver sido definida explicitamente por meio de otc_publisher_set_max_video_bitrate(), ou se uma predefinição de taxa de bits estiver ativa (incluindo a predefinição padrão), esta função retorna 0.
Observação: Um valor de retorno igual a 0 indica que não há nenhum limite de taxa de bits definido manualmente em vigor e que o stream está operando com uma configuração predefinida.
Parâmetros : | | | | | --- | --- | --- | | [in] | publisher | A instância do publisher. |
Retorna : A taxa de bits máxima atual do vídeo em bits por segundo, ou 0 se não estiver definida ou se for utilizada uma predefinição.
otc_publisher_set_publish_audio()
| otc_status otc_publisher_set_publish_audio | ( | otc_publisher * | editora, |
| otc_bool | publicar_áudio | ||
| ) |
Se deve ou não publicar o áudio. Por padrão, as transmissões publicam tanto o áudio quanto o vídeo.
Parâmetros : | | | | --- | --- | | publisher | O editor a ser afetado. | | publish_audio | Se deve ou não publicar áudio. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_set_publish_captions()
| otc_status otc_publisher_set_publish_captions | ( | otc_publisher * | editora, |
| otc_bool | publicar legendas | ||
| ) |
Se as legendas devem estar ativadas ou não. Por padrão, essa opção está desativada.
Parâmetros : | | | | --- | --- | | publisher | O editor a ser afetado. | | publish_captions | Se as legendas devem ser ativadas ou não. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_set_publish_video()
| otc_status otc_publisher_set_publish_video | ( | otc_publisher * | editora, |
| otc_bool | publicar_vídeo | ||
| ) |
Se deve ou não publicar vídeo. Por padrão, as transmissões publicam tanto áudio quanto vídeo.
Parâmetros : | | | | --- | --- | | publisher | O editor a ser afetado. | | publish_video | Se o vídeo deve ou não ser publicado. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_set_rtc_stats_report_cb()
| otc_status otc_publisher_set_rtc_stats_report_cb | ( | otc_publisher * | editora, |
| const struct otc_publisher_rtc_stats_report_cb | cb | ||
| ) |
Define o callback do relatório de estatísticas do RTC como o editor.
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. | | cb | O otc_publisher_rtc_stats_report_cb estrutura que inclui a função de retorno de chamada para o relatório de estatísticas do RTC. |
Veja também : otc_publisher_get_rtc_stats_report.
otc_publisher_set_target_scalability_mode()
| otc_status otc_publisher_set_target_scalability_mode | ( | otc_publisher * | editora, |
| const char * | modo_de_escalabilidade | ||
| ) |
Define o modo de escalabilidade alvo (SVC – Codificação de Vídeo Escalável) para este editor. O modo de escalabilidade controla o número de camadas espaciais (resolução) e temporais (taxa de quadros) que o WebRTC codifica. O modo é aplicado apenas à conexão entre pares roteada (emissor ↔ SFU), independentemente de qual trecho esteja ativo no momento.
Esse método pode ser chamado a qualquer momento — não é necessário que a negociação do trecho roteado tenha sido concluída. O modo será aplicado assim que o trecho roteado for estabelecido.
Se um codec que não seja SVC (VP8, H.264) for negociado no trecho roteado, é utilizado o modo aplicável mais próximo: as camadas espaciais são forçadas a 1, preservando a dimensão temporal (por exemplo, L2T2 → L1T2 quando o VP8 é negociado).
Este é um recurso em fase beta.
Erros:
- Retorna OTC_ERROR se o modo solicitado não for um modo de escalabilidade válido (ou seja, não for um dos seguintes: L1T1, L1T2, L1T3, L2T1, L2T2, L2T3, L3T1, L3T2, L3T3).
Parâmetros : | | | | --- | --- | | publisher | A instância do publisher. | | scalability_mode | O modo de escalabilidade desejado. |
Retorna : OTC_SUCCESS se a operação for bem-sucedida; caso contrário, um código de erro.
otc_publisher_set_video_bitrate_preset()
| otc_status otc_publisher_set_video_bitrate_preset | ( | otc_publisher * | editora, |
| enum otc_video_bitrate_preset | predefinição | ||
| ) |
Define uma predefinição de taxa de bits de vídeo para a transmissão de vídeo deste editor.
Aplica uma estratégia predefinida de taxa de bits de vídeo para controlar o comportamento do codificador. Essas predefinições têm como objetivo equilibrar a qualidade do vídeo com o uso da largura de banda, dependendo das necessidades da aplicação.
Observação: A predefinição OTC_VIDEO_BITRATE_PRESET_CUSTOM não pode ser definida diretamente. Ao chamar otc_publisher_set_max_video_bitrate() substituirá a predefinição e fará com que o getter da predefinição retorne OTC_VIDEO_BITRATE_PRESET_CUSTOM.
Parâmetros
: | | | |
| --- | --- | --- |
| [in] | publisher | A instância do publisher. |
| [in] | preset | Um valor de otc_video_bitrate_preset para se inscrever. |
Retorna : um erro caso ocorra algum problema; caso contrário, retorna OTC_SUCCESS.
otc_publisher_set_video_transformers()
| otc_status otc_publisher_set_video_transformers | ( | otc_publisher * | editora, |
| otc_video_transformer ** | transformadores, | ||
| uint8_t | tamanho | ||
| ) |
Define um array de transformadores de vídeo para o fluxo de vídeo deste editor. Se for nulo, os transformadores são reinicializados.
A matriz pode ser composta por transformadores de vídeo do Vonage fornecidos pela biblioteca ml e/ou por transformadores personalizados. Os transformadores contêm um ponteiro para uma função de retorno de chamada que é invocada a cada quadro de vídeo.
Observação: Essa função se aplica apenas ao SDK do macOS da Video API do Vonage. Ela não funciona no SDK do Linux da Video API do Vonage.
Parâmetros : | | | | | --- | --- | --- | | [in] | publisher | A instância do publisher. | | [in] | transformadores | Matriz de ponteiros opacos para otc_video_transformer, na ordem em que serão aplicados ao fluxo. | | [in] | tamanho | tamanho da matriz. |
Retorna : um erro caso ocorra algum problema; caso contrário, retorna OTC_SUCCESS.
otc_publisher_set_video_type()
| otc_status otc_publisher_set_video_type | ( | struct otc_publisher * | editora, |
| enum otc_publisher_video_type | tipo_de_vídeo | ||
| ) |
Define o tipo de vídeo do editor. Por padrão, os vídeos têm o tipo de vídeo definido como OTC_PUBLISHER_VIDEO_TYPE_CAMERA (indicando que a fonte do vídeo é uma câmera). Defina esse valor como OTC_PUBLISHER_VIDEO_TYPE_SCREEN para indicar que a fonte do vídeo é o compartilhamento de tela. Outros clientes podem detectar o tipo de vídeo das transmissões na sessão (para determinar o tipo de fonte do vídeo).
Parâmetros : | | | | --- | --- | | publisher | O editor a ser afetado. | | video_type | O tipo de vídeo do editor. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_delete()
| otc_status otc_publisher_settings_delete | ( | otc_configurações_do_editor * | configurações | ) |
Exclui uma instância de otc_publisher_settings.
Parâmetros : | | | | --- | --- | | configurações | A instância otc_publisher_settings a ser excluída. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_new()
| otc_configurações_do_editor * otc_publisher_settings_new | ( | ) |
Cria uma nova instância de `otc_publisher_settings`.
Retorna : Uma nova instância de otc_publisher_settings
otc_publisher_settings_set_allow_audio_capture_while_muted()
| otc_status otc_publisher_settings_set_allow_audio_capture_while_muted | ( | otc_configurações_do_editor * | configurações, |
| const otc_bool | ativado | ||
| ) |
Quando otc_publisher_settings_set_allow_audio_capture_while_muted está definido como false, o microfone será desligado automaticamente quando todos os participantes tiverem silenciado seu áudio. O microfone será ligado automaticamente novamente quando pelo menos um participante desativar o silenciamento do áudio. Se configurado para true, o microfone permanecerá sempre ligado, mesmo quando todos os emissores tiverem silenciado seu áudio. Esteja ciente de que, quando o microfone estiver desligado, callbacks como `audio_level` ou `audio_data` não serão mais chamados para os emissores. O valor padrão é true. Veja otc_session_new_with_settings.
Parâmetros : | | | | --- | --- | | settings | Ponteiro para o objeto de configurações da sessão. | | enable | Indicador booleano para desativar (OTC_FALSE, o valor padrão) ou ativar (OTC_TRUE) este sinalizador. |
Retorna : otc_status Retorna o status da operação.
otc_publisher_settings_set_audio_track()
| otc_status otc_publisher_settings_set_audio_track | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Permite que uma trilha de áudio para um editor seja criada com otc_publisher_new_with_settings.
Parâmetros
: | | |
| --- | --- |
| settings | A instância otc_publisher_settings a ser afetada. |
| enabled | Ativa/desativa a criação de uma trilha de áudio para um editor otc_publisher_new_with_settings. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_auto_gain_control()
| otc_status otc_publisher_settings_set_auto_gain_control | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Permite que um controlador de ganho automático de áudio para um editor seja criado com otc_publisher_new_with_settings.
Isso não funciona no SDK para Linux da Video API da Vonage.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | enabled | Se o controle automático de ganho deve ser ativado (true, valor padrão) ou desativado (false). |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_default_camera_capture_resolution()
| otc_status otc_publisher_settings_set_default_camera_capture_resolution | ( | otc_configurações_do_editor * | configurações, |
| const enum otc_camera_capture_resolution | resolução_da_câmera | ||
| ) |
Define a resolução de captura da câmera para os capturadores de vídeo padrão.
Os capturadores de vídeo personalizados não devem respeitar a resolução de captura definida por otc_publisher_settings_set_default_camera_capture_resolution, isso se aplica apenas aos capturadores de vídeo padrão.
Parâmetros : | | | | --- | --- | | camera_capture_resolution | A resolução de captura da câmera para os captadores de vídeo padrão. | | settings | A instância de otc_publisher_settings a ser afetada. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_disable_audio_processing()
| otc_status otc_publisher_settings_set_disable_audio_processing | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | desativado | ||
| ) |
Quando otc_publisher_settings_set_disable_audio_processing está definido como true, as configurações individuais para cancelamento de eco acústico, controle automático de ganho e supressão de ruído serão ignoradas e o áudio não será processado de forma alguma. O valor padrão é false. Veja otc_publisher_new_with_settings.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | enabled | Se o suporte ao processamento de áudio deve ser ativado (true) ou desativado (false, valor padrão). |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_echo_cancellation()
| otc_status otc_publisher_settings_set_echo_cancellation | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Habilita o cancelamento de eco acústico para que um emissor seja construído com otc_publisher_new_with_settings.
Observação: Essa função se aplica apenas ao SDK do macOS da Video API do Vonage. Ela não funciona no SDK do Linux da Video API do Vonage.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | enabled | Se deve habilitar (true, valor padrão) ou desabilitar (false) o suporte ao cancelamento de eco acústico. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_name()
| otc_status otc_publisher_settings_set_name | ( | otc_configurações_do_editor * | configurações, |
| const char * | nome | ||
| ) |
Define o nome desejado para a construção de um editor otc_publisher_new_with_settings.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | name | O nome do editor. Outros clientes podem obter os nomes dos fluxos na sessão. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_noise_suppression()
| otc_status otc_publisher_settings_set_noise_suppression | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Permite a supressão de ruído para que um editor seja construído com otc_publisher_new_with_settings.
Observação: Essa função se aplica apenas ao SDK do macOS da Video API do Vonage. Ela não funciona no SDK do Linux da Video API do Vonage.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | enabled | Se a supressão de ruído deve ser ativada (true, valor padrão) ou desativada (false). |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_opus_dtx()
| otc_status otc_publisher_settings_set_opus_dtx | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Permite Opus DTX para que um editor seja criado com otc_publisher_new_with_settings. Ativar o Opus DTX pode reduzir o uso de largura de banda em transmissões que apresentam longos períodos de silêncio.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | enabled | Se deve habilitar (true) ou desabilitar (false, o padrão) o suporte ao Opus DTX. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_preferred_video_codecs()
| otc_status otc_publisher_settings_set_preferred_video_codecs | ( | otc_configurações_do_editor * | configurações, |
| const otc_video_codec_type * | codecs, | ||
| size_t | num_codecs | ||
| ) |
Define os codecs de vídeo preferenciais a serem usados na transmissão deste editor.
Essa função permite especificar uma lista explícita e ordenada de codecs de vídeo a serem priorizados durante a negociação. Os codecs indicados serão colocados em primeiro lugar na oferta SDP (na ordem especificada), mas outros codecs compatíveis ainda poderão ser incluídos com prioridade menor.
Isso não limita a negociação apenas a esses codecs.
Passar uma lista vazia resultará em um erro OT_INVALID_PARAMETER. Se essa função não for chamada, o SDK recorrerá ao comportamento padrão definido nas configurações do projeto do Dashboard.
Parâmetros : | | | | | --- | --- | --- | | [in,out] | settings | A instância de configurações do publisher a ser modificada. | | [in] | codecs | Uma matriz de codecs de vídeo a serem priorizados (não pode estar vazia). | | [in] | num_codecs | O número de elementos na matriz de codecs. |
Retorna : OTC_SUCCESS se a operação for bem-sucedida; OT_INVALID_PARAMETER se a lista estiver vazia ou inválida.
otc_publisher_settings_set_preferred_video_codecs_automatic()
| otc_status otc_publisher_settings_set_preferred_video_codecs_automatic | ( | otc_configurações_do_editor * | configurações | ) |
Ativa a priorização automática de codecs para a transmissão deste editor.
No modo automático, o SDK determina a ordem de prioridade de codecs mais adequada, substituindo as configurações padrão do projeto definidas no Painel de Controle.
Isso oferece uma maneira simples de delegar a preferência de codec ao SDK sem precisar especificar uma lista manualmente.
Parâmetros : | | | | | --- | --- | --- | | [in,out] | configurações | A instância de configurações do editor a ser modificada. |
Retorna : OTC_SUCCESS se a operação for bem-sucedida; caso contrário, um código de erro.
otc_publisher_settings_set_publisher_audio_fallback_enabled()
| otc_status otc_publisher_settings_set_publisher_audio_fallback_enabled | ( | otc_configurações_do_editor * | configurações, |
| const otc_bool | ativado | ||
| ) |
Ativa ou desativa o recurso de fallback de áudio do editor.
Com o recurso de fallback de áudio do publisher ativado, quando o publisher determina que a qualidade de um stream se deteriorou significativamente, ele desativa o stream de vídeo para preservar a qualidade do áudio e continua a enviar o stream de áudio. O capturador correspondente a esse publisher não será desativado, e os quadros capturados continuarão sendo exibidos no lado do publisher.
A configuração padrão é OTC_FALSE (o recurso de fallback de áudio está desativado). Ao utilizar o tipo de vídeo de tela em uma sessão que utiliza o OpenTok Media Server, a configuração de fallback de áudio do emissor é definida como OTC_FALSE por padrão, para que o vídeo não seja interrompido nos assinantes.
Parâmetros : | | | | --- | --- | | configurações | As configurações do editor que serão afetadas. | | ativado | Se desejamos ativar ou não o recurso de fallback de áudio. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_scalable_screenshare()
| otc_status otc_publisher_settings_set_scalable_screenshare | ( | otc_configurações_do_editor * | configurações, |
| const otc_bool | ativado | ||
| ) |
Permitir o uso de vídeo escalável vídeo escalável para uma editora que tenha o otc_publisher_video_type definir como OTC_PUBLISHER_VIDEO_TYPE_SCREEN com otc_publisher_new_with_settings.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | enabled | Ativa/desativa o uso de vídeo escalável para transmissões de compartilhamento de tela. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_sender_stats_track()
| otc_status otc_publisher_settings_set_sender_stats_track | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Permite que um canal de estatísticas do remetente para um editor seja criado com otc_publisher_new_with_settings. Atualmente, esse recurso é compatível apenas com chamadas com mais de dois participantes. Por padrão, o canal de estatísticas do remetente está desativado.
Parâmetros
: | | |
| --- | --- |
| settings | A instância otc_publisher_settings a ser afetada. |
| enabled | Ativa/desativa a criação de um canal de estatísticas do remetente para um editor otc_publisher_new_with_settings. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_stereo()
| otc_status otc_publisher_settings_set_stereo | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Permite que um editor crie áudio estéreo com otc_publisher_new_with_settings.
Parâmetros
: | | |
| --- | --- |
| settings | A instância otc_publisher_settings a ser afetada. |
| enabled | Ativa/desativa o suporte a áudio estéreo para um publisher a ser criado com otc_publisher_new_with_settings. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_subscriber_audio_fallback_enabled()
| otc_status otc_publisher_settings_set_subscriber_audio_fallback_enabled | ( | otc_configurações_do_editor * | configurações, |
| const otc_bool | ativado | ||
| ) |
Ativa ou desativa o recurso de fallback de áudio para assinantes (para os assinantes do stream publicado)
O recurso de fallback de áudio do assinante está disponível em sessões que utilizam o Vonage Video Media Router. Com o recurso de fallback de áudio ativado (configuração padrão), quando o Vonage Video Media Router determina que a qualidade de uma transmissão se deteriorou significativamente para um assinante específico, ele desativa o vídeo para esse assinante a fim de preservar a qualidade do áudio.
A configuração padrão é OTC_TRUE (o recurso de fallback de áudio está ativado). Ao utilizar o tipo de vídeo na tela, a configuração de fallback de áudio do assinante é definida como OTC_FALSE por padrão, para que o vídeo não seja interrompido nos assinantes.
Parâmetros : | | | | --- | --- | | configurações | As configurações do editor que serão afetadas. | | ativado | Se desejamos ativar ou não o recurso de fallback de áudio. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_video_capturer()
| otc_status otc_publisher_settings_set_video_capturer | ( | otc_configurações_do_editor * | configurações, |
| const struct otc_video_capturer_callbacks * | capturador | ||
| ) |
Define o capturador de vídeo a ser utilizado para a criação de um editor otc_publisher_new_with_settings.
Parâmetros : | | | | --- | --- | | settings | A instância otc_publisher_settings a ser afetada. | | capturer | O capturador de vídeo. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.
otc_publisher_settings_set_video_track()
| otc_status otc_publisher_settings_set_video_track | ( | otc_configurações_do_editor * | configurações, |
| otc_bool | ativado | ||
| ) |
Permite que uma trilha de vídeo para um editor seja criada com otc_publisher_new_with_settings.
Parâmetros
: | | |
| --- | --- |
| settings | A instância otc_publisher_settings a ser afetada. |
| enabled | Ativa/desativa a criação de uma trilha de vídeo para um editor otc_publisher_new_with_settings. |
Retornos : Valor de retorno que indica se houve erro ou sucesso.