OpenTok Publisher. Mais...

#include "config.h" #include "stream.h" #include "video_frame.h" #include "audio_data.h" #include "camera_capture_resolution.h" #include "media_transformer.h" #include "video_capturer.h"

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

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

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

Documentação sobre tipos de enumeração

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.

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.

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.

Documentação da função

otc_publisher_delete()

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_audio_fallback_enabled()

Retorna se o recurso de fallback de áudio do editor está ativado ou não. Consulte o otc_publisher_set_audio_fallback_enabled função.

Esta função está obsoleta.

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

Retornos : Se o recurso de fallback de áudio do editor está ativado ou não.

otc_publisher_get_max_video_bitrate()

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

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

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

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

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

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

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

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

Retorna o fluxo associado ao editor.

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_user_data()

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

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

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

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

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_fallback_enabled()

Ativa ou desativa o recurso de fallback de áudio do assinante.

O recurso de fallback de áudio está disponível em sessões que utilizam o OpenTok Media Router. Com o recurso de fallback de áudio ativado (configuração padrão), quando o OpenTok Media Router determina que a qualidade de uma transmissão se deteriorou significativamente para um assinante específico da transmissão, ele desativa o vídeo para esse assinante a fim de preservar a qualidade do áudio.

Para desativar o recurso de fallback de áudio, chame a função otc_publisher_set_audio_fallback_enabled função (e passe OTC_FALSE) antes de chamar a otc_session_publish função.

Esta função está obsoleta. Consulte otc_publisher_settings_set_subscriber_audio_fallback_enabled.

Parâmetros : | | | | --- | --- | | publisher | O publisher a ser afetado. | | enabled | 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_set_audio_transformers()

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_max_audio_bitrate()

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

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

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

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

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

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_video_bitrate_preset()

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

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

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

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

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

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

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

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

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

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

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

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

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

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_publisher_audio_fallback_enabled()

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

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_stereo()

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

Ativa ou desativa o recurso de fallback de áudio para assinantes (para os assinantes do stream publicado)

O recurso de fallback de áudio para assinantes está disponível em sessões que utilizam o OpenTok Media Router. Com o recurso de fallback de áudio ativado (configuração padrão), quando o OpenTok Media Router determina que a qualidade de uma transmissão se deteriorou significativamente para um assinante específico da transmissão, ele desativa o vídeo desse 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()

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

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.