ApsaraVideo Live:APIs do AliRtcEngine

Cria uma instância de AliRtcEngine.

static AliEngine *Create(const char *extras);

Quando chamar

Chame este método para criar uma instância de AliRtcEngine antes de invocar qualquer outra API do ARTC SDK.

Limites

O SDK suporta apenas uma instância de AliRtcEngine por aplicação.

Descrição dos parâmetros

Valor de retorno

Retorna um objeto singleton da classe AliEngine.

Destrói a instância de AliRtcEngine.

static void Destroy(AliEngineDestroyCompletionCallback *callback = nullptr);

Este método destrói o objeto singleton AliRtcEngine e libera todos os seus recursos internos. Após a chamada deste método, não é mais possível utilizar outros métodos do AliRtcEngine ou quaisquer callbacks. Para utilizá-los novamente, chame Create para criar uma nova instância.

Quando chamar

Chame este método para liberar a instância após terminar de usar a Comunicação em Tempo Real.

Limites

Para evitar deadlocks, não chame este método dentro de nenhum callback do SDK.

Parâmetros

Recupera uma instância de interface de recurso.

virtual int QueryInterface(AliEngineInterfaceIdType iid, void** pInterface) = 0;

Este método recupera uma instância de uma interface de recurso específica. Ao desenvolver aplicações de Comunicação em Tempo Real para a plataforma Windows, muitos recursos avançados são fornecidos por meio de classes de interface correspondentes, como gerenciamento de dispositivos de áudio (AliEngineInterfaceAudioDeviceManager), gerenciamento de dispositivos de vídeo (AliEngineInterfaceVideoDeviceManager) e o mecanismo de mídia (AliEngineInterfaceMediaEngine). Antes de chamar os métodos relacionados, use o método QueryInterface para obter instâncias dessas interfaces.

Parâmetros

Valor de retorno

• 0: A chamada foi bem-sucedida.

• <0: A chamada falhou.

Ativa ou desativa o modo de compatibilidade H5.

static void SetH5CompatibleMode(bool comp);

Parâmetros

Verifica se o modo de compatibilidade H5 está ativado.

static bool GetH5CompatibleMode();

Valor de retorno

true: A compatibilidade H5 está ativada. false: A compatibilidade H5 está desativada.

Define os callbacks do listener de eventos.

virtual int SetEngineEventListener(AliEngineEventListener *listener) = 0;

Este método define um listener de callback para o SDK. Ao configurar este listener, você recebe vários eventos de notificação do mecanismo, como entrada ou saída de usuários de um canal, alterações no status da rede e status dos fluxos de áudio e vídeo.

Implemente a classe AliEngineEventListener para personalizar os métodos de evento que deseja monitorar. Por padrão, todos os métodos possuem implementações vazias, portanto, não é necessário implementar todos eles. Implemente apenas os métodos de evento necessários.

Callbacks relacionados

Se ocorrer uma exceção durante uma operação, o SDK tentará primeiro se recuperar automaticamente usando seu mecanismo interno de nova tentativa. Para erros que não podem ser resolvidos automaticamente, o SDK notifica sua aplicação por meio de interfaces de callback predefinidas. Abaixo estão os principais callbacks para problemas que o SDK não consegue tratar e que exigem que sua aplicação monitore e responda:

Parâmetros

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha. Isso pode ocorrer porque o parâmetro listener é inválido ou o SDK não foi inicializado corretamente.

Consulta a versão atual do SDK.

static const char *GetSDKVersion();

Valor de retorno

O número da versão atual do SDK em formato de string. Exemplo: "2.5.0.x".

Define o perfil do canal.

virtual int SetChannelProfile(const AliEngineChannelProfile channelProfile) = 0;

Este método define o perfil do canal. Atualmente, fornece perfis para cenários de videochamada e cenários de transmissão interativa:

• Perfil de videochamada: Todos os usuários têm a função de streamer e podem publicar e assinar streams.

• Modo de transmissão interativa: Chame o método <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="4e50f781a01e1">SetClientRole</a> para definir a função do usuário. Defina a função dos usuários que enviam streams no canal como streamer (AliRTCSdkInteractive). Se um usuário precisar apenas receber streams e não enviar streams, defina sua função como viewer (AliRTCSdkLive). Este modo é recomendado para cenários RTC.

Quando chamar

Chame este método apenas antes de entrar em um canal. Não é possível redefini-lo enquanto estiver no canal. Redefina-o após sair do canal.

Parâmetros

Valor de retorno

• 0: A chamada do método foi bem-sucedida.

• Outros valores: A chamada do método falhou.

  • -1: O SDK não foi inicializado ou foi destruído.

Define o perfil de áudio.

virtual int SetAudioProfile(int audioProfile, int audioScene) = 0;

Este método define o perfil de codificação de áudio e o cenário de áudio. Para mais informações, consulte Operações e configurações comuns de áudio. O ARTC SDK usa o modo de alta qualidade (AliEngineHighQualityMode) e o modo de cenário musical (AliEngineSceneMusicMode) por padrão. Se as configurações padrão não atenderem às suas necessidades, chame este método para configurá-las.

Quando chamar

Chame este método apenas antes de entrar em um canal. Não é possível redefini-lo após entrar no canal. Redefina-o após sair do canal.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Verifica se o modo atual é apenas áudio.

virtual bool IsAudioOnlyMode() = 0;

Valor de retorno

true: O modo atual é apenas áudio. false: O modo atual é áudio e vídeo.

Define o modo como apenas áudio ou áudio e vídeo.

virtual int SetAudioOnlyMode(bool audioOnly) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Entra em um canal.

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const char *userName) = 0;

Este método permite entrar em um canal. No ARTC, os usuários são organizados por canais. É necessário entrar em um canal para publicar ou assinar streams de áudio e vídeo. Este método, JoinChannel[2/3] e JoinChannel[3/3] podem ser usados para entrar em um canal. Eles diferem nos métodos de autenticação e nas informações de usuário transmitidas, conforme descrito abaixo:

• Este método destina-se a entrar em um canal com um único parâmetro. Passe um token gerado para entrada com parâmetro único usando Autenticação baseada em token. Recomendamos o uso deste método para entrar em um canal em cenários RTC.

• JoinChannel[2/3] destina-se a entrar em um canal com múltiplos parâmetros. Passe um token de múltiplos parâmetros gerado usando Autenticação baseada em token e as informações de usuário usadas para gerar o token.

• JoinChannel[3/3] destina-se a cenários de interação em tempo real com IA. Passe um token de parâmetro único e defina a propriedade do usuário capabilityProfile com base no cenário.

Quando chamar

Chame este método após criar o mecanismo.

Limites

• Após entrar com sucesso em um canal, para entrar em outro, chame primeiro LeaveChannel para sair do canal atual. Só é possível chamar para entrar em outro canal após receber o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="b2522e57e4vom">OnLeaveChannelResult</a>.

• Este método suporta a entrada em apenas um canal por vez.

• Aplicações com App IDs diferentes não podem se comunicar entre si.

• Não chame este método ao tentar novamente após uma falha na entrada em um canal.

Callbacks relacionados

Uma chamada bem-sucedida a este método aciona os seguintes callbacks:

• O resultado da entrada do cliente local em um canal é retornado através do callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="cad6eb9b1bwx7">OnJoinChannelResult</a> de AliRtcEngineEventListener.

• Após entrar com sucesso no canal, o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fab4a94264m28">OnRemoteUserOnLineNotify</a> é acionado nos clientes remotos.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Valor diferente de zero: A chamada do método falhou.

Entra em um canal.

virtual int JoinChannel(const AliEngineAuthInfo &authInfo,
                                 const char *userName) = 0;

Este método permite entrar em um canal. No ARTC, os usuários são organizados por canais. É necessário entrar em um canal para publicar ou assinar streams de áudio e vídeo. Este método, JoinChannel[1/3] e JoinChannel[3/3] podem ser usados para entrar em um canal. Eles diferem nos métodos de autenticação e nas informações de usuário transmitidas, conforme descrito abaixo:

• JoinChannel[1/3] destina-se a entrar em um canal com um único parâmetro. Passe um token gerado para entrada com parâmetro único usando Autenticação baseada em token. Recomendamos o uso deste método para entrar em um canal em cenários RTC.

• Este método destina-se a entrar em um canal com múltiplos parâmetros. Passe um token de múltiplos parâmetros gerado usando Autenticação baseada em token e as informações de usuário usadas para gerar o token.

• JoinChannel[3/3] destina-se a cenários de interação em tempo real com IA. Passe um token de parâmetro único e defina a propriedade do usuário capabilityProfile com base no cenário.

Limites

• Após entrar com sucesso em um canal, para entrar em outro, chame primeiro LeaveChannel para sair do canal atual. Só é possível chamar para entrar em outro canal após receber o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="fcd2fac6abf0y">OnLeaveChannelResult</a>.

• Este método suporta a entrada em apenas um canal por vez.

• Aplicações com App IDs diferentes não podem se comunicar entre si.

Callbacks relacionados

Uma chamada bem-sucedida a este método aciona os seguintes callbacks:

• O cliente local é notificado sobre o resultado da entrada em um canal através do callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="b3db8c610ewua">OnJoinChannelResult</a>.

• Após entrar com sucesso em um canal, o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="a1297d33bcd92">OnRemoteUserOnLineNotify</a> é acionado nos clientes remotos.

Parâmetros

Entra em um canal.

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const AliEngineChannelParam &userParam) = 0;

Este método permite entrar em um canal. No ARTC, os usuários são organizados por canais. É necessário entrar em um canal para publicar ou assinar streams de áudio e vídeo. Este método, JoinChannel[1/3] e JoinChannel[2/3] podem ser usados para entrar em um canal. Eles diferem nos métodos de autenticação e nas informações de usuário transmitidas, conforme descrito abaixo:

• JoinChannel[1/3] é um método de parâmetro único para entrar em um canal em cenários RTC. Passe um token gerado para entrada com parâmetro único usando Autenticação baseada em token. Recomendamos o uso deste método para entrar em um canal em cenários RTC.

• JoinChannel[2/3] destina-se a entrar em um canal com múltiplos parâmetros. Passe um token de múltiplos parâmetros gerado usando Autenticação baseada em token e as informações de usuário usadas para gerar o token.

• Este método destina-se a cenários de interação em tempo real com IA. Passe um token de parâmetro único e defina a propriedade do usuário capabilityProfile com base no cenário. Para se comunicar com um agente de IA, defina como AliCapabilityProfileHuman.

Limites

• Após entrar com sucesso em um canal, para entrar em outro, chame primeiro leaveChannel para sair do canal atual. Só é possível entrar em um canal novamente após receber o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="15ec544e3985m">OnLeaveChannelResult</a>.

• Este método suporta a entrada em apenas um canal por vez.

• Aplicações com App IDs diferentes não podem se comunicar entre si.

• Não chame este método ao tentar novamente após uma falha na entrada em um canal.

Callbacks relacionados

Uma chamada bem-sucedida a este método aciona os seguintes callbacks:

• O resultado da entrada do usuário local em um canal é fornecido através do callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="5d109191c950l">OnJoinChannelResult</a>.

• Após entrar com sucesso no canal, o cliente remoto aciona o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fa6f8d9357glx">OnRemoteUserOnLineNotify</a>.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Valor diferente de zero: A chamada do método falhou.

Sai do canal.

virtual int LeaveChannel() = 0;

Após chamar este método, o SDK encerra a chamada de áudio e vídeo e sai do canal atual.

Quando chamar

• Chame este método para sair de um canal.

• Chame este método para sair do canal atual antes de entrar em um novo.

Callbacks relacionados

• A chamada deste método aciona o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="9626ae24d89ue">OnLeaveChannelResult</a> no cliente local, que informa se o cliente saiu do canal com sucesso.

• Usuários remotos: Uma chamada bem-sucedida a esta API aciona o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#44ce12a0ecj52" id="0dfcab6a6fylt">OnRemoteUserOffLineNotify</a>.

Descrição da resposta

Um valor 0 indica que a chamada do método foi bem-sucedida. Qualquer outro valor indica que a chamada do método falhou.

Verifica se o usuário está atualmente em um canal.

virtual bool IsInCall() = 0;

Valor de retorno

true: O usuário está em um canal. false: O usuário não está em um canal.

Define a função do usuário.

virtual int SetClientRole(const AliEngineClientRole clientRole) = 0;

Este método define a função do usuário como streamer ou viewer.

No modo de transmissão interativa, antes de entrar em um canal:

• Se você definir a função do usuário como streamer, o SDK publicará automaticamente os streams locais de áudio e vídeo e receberá os streams de áudio e vídeo de outros streamers por padrão.

• Se você definir a função do usuário como viewer, o SDK não publicará os streams locais de áudio e vídeo, mas receberá os streams de áudio e vídeo de outros streamers.

Quando chamar

Este método pode ser chamado antes ou depois de entrar em um canal. Chame-o antes de entrar para definir a função do usuário, ou depois de entrar para alternar a função do usuário.

Limites

Este método é eficaz apenas no modo de transmissão interativa. Isso significa que você deve chamar o método <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#901e748242y3g" id="322c3da902jpt">SetChannelProfile</a> e definir o perfil do canal como AliEngineInteractiveLive.

No modo de transmissão interativa, recomendamos que você chame explicitamente este método para definir a função do usuário antes de entrar em um canal.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Obtém o tipo de função atual do usuário (streamer ou espectador).

virtual AliEngineClientRole GetClientRole() = 0;

Valor de retorno

Se a chamada do método for bem-sucedida, ela retornará um objeto AliEngineClientRole. Trata-se de um tipo de enumeração que indica se a função é streamer (0) ou espectador (1).

Atualiza as informações de autenticação.

virtual int RefreshAuthInfo(const AliEngineAuthInfo &authInfo) = 0;

Este método atualiza as informações de autenticação. O token expira após um determinado período. Quando o token expira, o SDK não consegue se conectar ao servidor.

Quando chamar

Nas seguintes situações:

• Ao receber o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="f52a19bb78yoi">OnAuthInfoWillExpire</a>, que indica que as informações de autenticação estão prestes a expirar, recomenda-se regenerar um token no servidor e, em seguida, chamar este método com o novo token.

• Caso o token não seja atualizado a tempo, o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="440c501877fxr">OnAuthInfoExpired</a> será acionado para notificar que a autenticação expirou. Nesse caso, é necessário regenerar o token e chamar JoinChannel para entrar novamente no canal.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Atualiza as informações de autenticação.

virtual int RefreshAuthInfo(const char *token) = 0;

Este método atualiza o token. O token expira após um determinado período. Quando o token expira, o SDK não consegue se conectar ao servidor.

Quando chamar

Nas situações abaixo, recomenda-se regenerar o token no servidor e, em seguida, chamar este método para passar o novo token:

• Ao receber o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="b21949148djrc">OnAuthInfoWillExpire</a>, indicando que as informações de autenticação estão prestes a expirar.

• Se o token não for atualizado a tempo, o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="62df9bf63786v">OnAuthInfoExpired</a> será acionado para indicar que a autenticação expirou. Nesse cenário, chame JoinChannel para entrar novamente no canal.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Ativa ou desativa a publicação do fluxo de áudio local.

virtual int PublishLocalAudioStream(bool enabled) = 0;

Este método controla a publicação do fluxo de áudio coletado localmente. Por padrão, o SDK publica o fluxo de áudio. Caso não deseje publicar o fluxo de áudio por padrão, chame PublishLocalAudioStream(false) antes de entrar no canal para desativar a publicação do fluxo de áudio.

Quando chamar

É possível chamar este método antes ou depois de entrar em um canal. Chamá-lo antes de entrar no canal modifica a configuração padrão, que entra em vigor no momento da entrada.

Callbacks relacionados

Quando o estado de ingestão do fluxo de áudio local muda, o cliente local aciona o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#eb8fab7f5ak7v" id="c584949653jn5">OnAudioPublishStateChanged</a> para relatar o estado mais recente da ingestão do fluxo de áudio. O cliente remoto aciona o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="75f2096b1efxy">OnRemoteTrackAvailableNotify</a> para relatar alterações nos fluxos de áudio e vídeo do usuário remoto.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Consulta se a publicação do fluxo de áudio está permitida no momento.

virtual bool IsLocalAudioStreamPublished() = 0;

Valor de retorno

true: A publicação está permitida. false: A publicação não está permitida.

Define se deve haver assinatura dos fluxos de áudio remotos por padrão.

virtual int SetDefaultSubscribeAllRemoteAudioStreams(bool sub) = 0;

Este método configura a assinatura padrão dos fluxos de áudio de usuários remotos. Essa configuração afeta o comportamento de assinatura de fluxo de áudio para novos usuários que entram no canal. Recomenda-se definir como true, a menos que haja requisitos específicos.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

• Antes de entrar em um canal:

  • O SDK assina os fluxos de áudio de usuários remotos por padrão ao entrar em um canal. Para alterar esse comportamento, chame este método antes de entrar.

• Depois de entrar em um canal:

  • Para interromper a assinatura padrão, chame <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e95a7e2d6fjwt">SetDefaultSubscribeAllRemoteAudioStreams</a>(false). Assim, você não assinará os fluxos de áudio de usuários que entrarem no canal posteriormente.

  • Após interromper a assinatura padrão, chame <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="1a391bcabc66e">SubscribeRemoteAudioStream</a> para retomar a assinatura do fluxo de áudio de um usuário específico. Para retomar a assinatura de vários usuários, chame este método múltiplas vezes.

  • Ao chamar <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e79b5ad58awcw">SetDefaultSubscribeAllRemoteAudioStreams</a>(true) após interromper a assinatura padrão, a assinatura será retomada apenas para os fluxos de áudio de usuários que entrarem no canal subsequentemente. Isso não assina os fluxos de usuários remotos que entraram enquanto a assinatura estava interrompida.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe ou retoma a assinatura do fluxo de áudio de um usuário remoto específico.

virtual int SubscribeRemoteAudioStream(const char* uid, bool sub) = 0;

Este método interrompe ou retoma a assinatura do fluxo de áudio de um usuário remoto específico. Recomenda-se definir como true, a menos que haja requisitos específicos.

Parâmetros

Descrição da resposta

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe ou retoma o recebimento de todos os fluxos de áudio remotos.

virtual int SubscribeAllRemoteAudioStreams(bool sub) = 0;

Este método funciona como o interruptor principal para a assinatura de fluxos de áudio remotos. Recomenda-se defini-lo como true. Se definido como false, ocorre o seguinte:

• A assinatura de todos os fluxos de áudio remotos no canal atual é interrompida.

• Usuários que entrarem posteriormente também não terão seus fluxos assinados.

• Não é possível usar <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="aface4ad3920l">SubscribeRemoteAudioStream</a> para controlar o fluxo de áudio de um usuário específico.

Para reassinar, chame este método novamente e defina-o como true para retomar a assinatura.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Publica ou interrompe a publicação do fluxo da câmera.

virtual int PublishLocalVideoStream(bool enabled) = 0;

Este método controla a publicação do fluxo de vídeo coletado localmente.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Chamá-lo antes de entrar no canal modifica a configuração padrão, que entra em vigor no momento da entrada.

Callbacks relacionados

Quando o estado de ingestão do fluxo de áudio local muda, o cliente local aciona o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="d37709b09147d">OnVideoPublishStateChanged</a> para relatar o novo status de ingestão do fluxo de áudio, e o cliente remoto aciona o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="f16e4b51bchqb">OnRemoteTrackAvailableNotify</a> para relatar alterações no fluxo de áudio e vídeo do usuário remoto.

Parâmetros

Valor de retorno

• 0: A chamada do método foi bem-sucedida.

• <0: A chamada do método falhou.

Ativa ou desativa o envio do fluxo de vídeo.

virtual int PublishLocalVideoStream(bool enabled, AliEngineVideoTrack track) = 0;

Este método controla a publicação do fluxo de vídeo coletado localmente.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Chamá-lo antes de entrar no canal modifica a configuração padrão, que entra em vigor no momento da entrada.

Callbacks relacionados

Quando o estado de ingestão do fluxo de vídeo local muda, o cliente local aciona o callback <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="18a9d4b47ezcc">OnVideoPublishStateChanged</a> para relatar o estado mais recente da ingestão do fluxo de vídeo. O cliente remoto aciona o callback <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="d01e7a574f92o">OnRemoteTrackAvailableNotify</a> para notificar que os fluxos de áudio e vídeo do usuário remoto foram alterados.

Parâmetros

Retornos

• 0: A chamada do método foi bem-sucedida.

• <0: A chamada do método falhou.

Consulta se a publicação do fluxo de vídeo está permitida no momento.

virtual bool IsLocalVideoStreamPublished() = 0;

Valor de retorno

true: O fluxo da câmera está publicado. false: O fluxo da câmera não está publicado.

Define se os fluxos de vídeo devem ser recebidos por padrão.

virtual int SetDefaultSubscribeAllRemoteVideoStreams(bool sub) = 0;

Este método define se deve haver assinatura dos fluxos de vídeo por padrão. O SDK assina por padrão.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

• Antes de entrar em um canal:

  • Use este método para cancelar a configuração de assinatura padrão.

• Depois de entrar em um canal:

  • Para interromper a assinatura padrão, chame SetDefaultSubscribeAllRemoteVideoStreams(false). Isso impede a assinatura dos fluxos de vídeo de usuários que entrarem no canal subsequentemente.

  • Após interromper a assinatura padrão, caso deseje retomar a assinatura do fluxo de vídeo de um usuário específico, chame o método SubscribeRemoteVideoStream. Para retomar a assinatura de vários usuários, chame-o múltiplas vezes.

  • Após a interrupção da assinatura padrão, uma chamada para SetDefaultSubscribeAllRemoteVideoStreams(false) retoma apenas os fluxos de áudio de usuários que entrarem no canal posteriormente.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe ou retoma a assinatura do fluxo de vídeo de um usuário remoto.

virtual int SubscribeRemoteVideoStream(const char* uid, AliEngineVideoTrack track, bool sub) = 0;

Este método assina ou cancela a assinatura do fluxo de vídeo de um usuário específico.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

• true: A configuração foi bem-sucedida.

• false: A configuração falhou.

Interrompe ou retoma o recebimento de todos os fluxos de vídeo remotos.

virtual int SubscribeAllRemoteVideoStreams(bool sub) = 0;

Este método funciona como o interruptor principal para a assinatura de fluxos de vídeo remotos. Se definido como false, ocorre o seguinte:

• A assinatura de todos os fluxos de vídeo remotos no canal atual é interrompida.

• Os fluxos de vídeo de novos usuários que entrarem no canal posteriormente também não serão assinados, mesmo que você tenha chamado <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#2cbc54790brn3" id="b7b0080f3cnoq">SetDefaultSubscribeAllRemoteVideoStreams</a>(true) para assinar por padrão.

• Não é possível usar <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#jyGTp" id="0e2edf97aa1g6">SubscribeRemoteVideoStream</a> para controlar independentemente o fluxo de áudio de um usuário especificado.

Para reassinar, chame este método novamente e defina-o como true para retomar a assinatura.

Parâmetros

Descrição da resposta

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe ou retoma o fluxo de mídia de um usuário remoto específico.

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, bool subVideo,  bool subAudio) = 0;

Este método assina os fluxos de áudio e vídeo remotos simultaneamente.

Métodos relacionados

Em comparação com SubscribeRemoteMediaStream[2/2], este método usa dois parâmetros booleanos, subVideo e subAudio, para determinar se deve assinar os fluxos de áudio e vídeo remotos. O parâmetro videoTrack controla qual fluxo de vídeo deve ser puxado.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe ou retoma o fluxo de mídia de um usuário remoto específico.

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, AliEngineAudioTrack audioTrack) = 0;

Este método assina os fluxos de áudio e vídeo remotos simultaneamente.

Métodos relacionados

Em comparação com SubscribeRemoteMediaStream[1/2], este método usa os parâmetros videoTrack e audioTrack para informar ao SDK o estado de assinatura desejado em uma única chamada. Por exemplo:

• Para assinar o fluxo da câmera e o fluxo do microfone, defina videoTrack e audioTrack como AliRtcVideoTrackCamera e AliRtcAudioTrackMic, respectivamente, ao chamar o método.

• Para cancelar a assinatura do fluxo da câmera, mas manter o fluxo do microfone, chame o método novamente e defina videoTrack e audioTrack como AliRtcVideoTrackNo e AliRtcAudioTrackMic, respectivamente.

• Para cancelar ambas as assinaturas, chame o método novamente e defina videoTrack e audioTrack como AliRtcVideoTrackNo e AliRtcAudioTrackNo, respectivamente.

• Para assinar tanto o fluxo da câmera quanto o fluxo de compartilhamento de tela simultaneamente, defina videoTrack como AliRtcVideoTrackBoth. O mesmo se aplica ao áudio.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Assina o fluxo de um usuário especificado entre canais.

virtual int SubscribeRemoteDestChannelStream(const char* channelId, const char* uid, AliEngineVideoTrack track, bool sub_audio, bool sub) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Ajusta o volume de reprodução de um usuário remoto especificado.

virtual int SetRemoteAudioVolume(const char *uid, int volume) = 0;

Parâmetros

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha.

Interrompe ou retoma o envio de dados de áudio local.

virtual int MuteLocalMic(bool mute, AliEngineMuteLocalAudioMode mode = AliEngineMuteLocalAudioModeDefault) = 0;

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Callbacks relacionados

Após a chamada ser bem-sucedida, o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#a15f0a6cf6id7" id="f4ae88f094vqy">OnUserAudioMuted</a> é acionado nos clientes remotos para indicar se o usuário está silenciado.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe ou retoma a reprodução de áudio remoto.

virtual int MuteRemoteAudio(const char *uid,
                                    bool mute) = 0;

Esta API serve exclusivamente para interromper ou retomar a reprodução de áudio de um usuário remoto específico. Ela não afeta o pull de stream nem a decodificação do áudio remoto. Para cancelar a assinatura do stream de áudio de um usuário, chame <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="89841a0989t7y">SubscribeRemoteAudioStream</a>.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe ou retoma a reprodução das faixas de áudio de todos os usuários remotos.

virtual int MuteAllRemoteAudio(bool mute) = 0;

Utilize este método para interromper ou retomar toda a reprodução de áudio remoto.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Um valor diferente de zero: A chamada do método falhou.

Inicia a captura de áudio.

virtual int StartAudioCapture() = 0;

Este método inicia a captura de áudio. Chame-o também antes de entrar em um canal para iniciar a captura antecipadamente. Caso não seja definido, o SDK controla automaticamente o dispositivo de captura de áudio. Para reiniciar a captura após ela ter sido interrompida por stopAudioCapture, utilize este método.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Métodos relacionados

• O método StartAudioCapture[2/2] permite controlar, via parâmetro, se o dispositivo de captura de áudio permanece ligado após você sair do canal.

Callbacks relacionados

Ao alterar o estado da captura de áudio local com este método, obtenha a mudança de estado através do callback OnLocalAudioStateChange.

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Inicia a captura de áudio.

virtual int StartAudioCapture(bool keepAlive) = 0;

Interrompe a captura de áudio do microfone após o silenciamento.

Este método inicia a captura de áudio. Chame-o também antes de entrar em um canal para iniciar a captura antecipadamente. Caso não seja definido, o SDK controla automaticamente o dispositivo de captura de áudio.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Métodos relacionados

Em comparação com StartAudioCapture[1/2], este método permite controlar se o dispositivo de captura permanece ligado após você sair do canal, utilizando o parâmetro keepAlive.

Callbacks relacionados

Ao alterar o estado da captura de áudio local com este método, obtenha a mudança de estado através do callback OnLocalAudioStateChange.

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe a captura de áudio.

virtual int StopAudioCapture() = 0;

Após iniciar a captura do dispositivo de áudio com StartAudioCapture, chame este método para interrompê-la.

Callbacks relacionados

Ao alterar o estado da captura de áudio local com este método, obtenha a mudança de estado através do callback OnLocalAudioStateChange.

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Define a frequência do callback de volume e o coeficiente de suavização.

virtual int EnableAudioVolumeIndication(int interval, int smooth, int reportVad) = 0;

Este método permite que o SDK relate periodicamente ao aplicativo informações sobre o volume dos usuários locais que estão publicando e do usuário remoto com o maior volume instantâneo.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Callbacks relacionados

Após uma chamada bem-sucedida a este método, se houver usuários publicando no canal, o SDK aciona os dois callbacks abaixo no intervalo de tempo definido:

• O volume de áudio do falante é relatado pelo callback OnAudioVolumeCallback. A frequência do callback é determinada pelo parâmetro interval.

• Detecção de atividade de voz. Quando um usuário ativo é detectado, o UID do falante é relatado pelo callback OnActiveSpeaker.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Parâmetros

Descrição da resposta

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Inicia o dispositivo de reprodução de áudio.

virtual int StartAudioPlayer() = 0;

Este método pode iniciar a reprodução de áudio antecipadamente. Caso não seja definido, o SDK inicia automaticamente a reprodução de áudio após a assinatura de um stream de áudio.

Valor de retorno

• 0: Sucesso.

• Um valor diferente de zero: Falha. Um código de erro é retornado.

Interrompe a reprodução de áudio.

virtual int StopAudioPlayer() = 0;

Este método interrompe a reprodução de áudio. Ele corresponde a AliEngine::StartAudioPlayer.

Parâmetros

Nenhum.

Valor de retorno

• 0: Sucesso.

• Um valor diferente de zero: Falha. Um código de erro é retornado.

Define o volume de reprodução.

virtual int SetPlayoutVolume(int volume) = 0;

Parâmetros

Valor de retorno

• 0: Sucesso.

• Um valor diferente de zero: Falha. Um código de erro é retornado.

virtual int SetRecordingVolume(int volume) = 0;

Parâmetros

Descrição da resposta

• 0: Sucesso.

• Um valor diferente de zero: Falha. Um código de erro é retornado.

Reproduz um arquivo de áudio.

virtual int PlayAudioFileTest(const char* filePath) = 0;

Parâmetros

Valor de retorno

• 0: Sucesso.

• <0: Falha.

Interrompe a reprodução do arquivo de áudio.

virtual int StopAudioFileTest() = 0;

Valor de retorno

• 0: Sucesso.

• <0: Falha.

Inicia um teste de captura de áudio antes de uma chamada.

virtual int StartAudioCaptureTest() = 0;

Este método inicia um teste de captura de áudio. Use o resultado do callback AliEngineEventListener::OnTestAudioVolumeCallback para determinar se a captura de áudio está normal.

Valor de retorno

• 0: Sucesso.

• <0: Falha.

Interrompe o teste de captura de áudio.

virtual int StopAudioCaptureTest() = 0;

Valor de retorno

• 0: Sucesso.

• <0: Falha.

Ativa ou desativa a captura e publicação de áudio do sistema.

virtual int EnableSystemAudioRecording(bool enable, const char *path = nullptr, const char *device_id = nullptr) = 0;

Este método ativa ou desativa a captura de áudio do sistema, como sons reproduzidos por navegadores e aplicativos.

Parâmetros

Valor de retorno

• 0: A chamada do método foi bem-sucedida.

• <0: A chamada do método falhou.

Verifica se a captura e publicação de áudio do sistema estão atualmente ativadas.

virtual bool IsSystemAudioRecording() = 0;

Valor de retorno

• true: Ativado.

• false: Desativado.

Define o volume de captura e publicação de áudio do sistema.

virtual int SetSystemAudioRecordingVolume(int volume) = 0;

Este método é válido apenas nas plataformas Windows e macOS.

Esta configuração só pode ser aplicada após a ativação da captura e publicação de áudio do sistema. Caso contrário, a definição será inválida.

Parâmetros

Valor de retorno

• 0: Sucesso.

• <0: Falha.

Obtém o volume atual de captura e publicação de áudio do sistema.

virtual int GetSystemAudioRecordingVolume() = 0;

Este método é válido apenas nas plataformas Windows e macOS.

Valor de retorno

O volume de publicação da captura do sistema.

Define o volume de reprodução de áudio do sistema.

virtual int SetSystemAudioPlayoutVolume(int volume) = 0;

Este método é válido apenas nas plataformas Windows e macOS.

Esta configuração só pode ser aplicada após a ativação da captura e publicação de áudio do sistema. Caso contrário, a definição será inválida.

Parâmetros

Valor de retorno

• 0: Sucesso.

• <0: Falha.

Obtém o volume atual de reprodução de áudio do sistema.

virtual int GetSystemAudioPlayoutVolume() = 0;

Este método é válido apenas nas plataformas Windows e macOS.

Valor de retorno

O volume de reprodução das faixas do sistema.

Obtém a lista de dispositivos de gravação no sistema.

virtual AliEngineDeviceInfoList* GetAudioCaptureList() = 0;

Valor de retorno

Um ponteiro para a lista de dispositivos de gravação, AliEngineDeviceInfoList *.

Obtém o nome do dispositivo de gravação em uso.

virtual String GetCurrentAudioCaptureName() = 0;

Valor de retorno

O nome do dispositivo de captura de áudio atual.

Obtém o ID do dispositivo de gravação em uso.

virtual String GetCurrentAudioCaptureID() = 0;

Valor de retorno

O ID do dispositivo de gravação atualmente em uso.

Seleciona um dispositivo de gravação pelo nome.

virtual int SetCurrentAudioCaptureName(const char* captureName) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Seleciona um dispositivo de gravação pelo ID.

virtual int SetCurrentAudioCaptureID(const char* captureID) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Obtém a lista de alto-falantes no sistema.

virtual AliEngineDeviceInfoList* GetAudioPlayerList() = 0;

Valor de retorno

Um ponteiro para a lista de alto-falantes no sistema, AliEngineDeviceInfoList *.

Obtém a lista de alto-falantes graváveis no sistema (para gravação interna do sistema).

virtual AliEngineDeviceInfoList* GetSystemRecordAudioPlayerList() = 0;

Valor de retorno

A lista de dispositivos de reprodução de áudio, usada principalmente como último parâmetro para EnableSystemAudioRecording para capturar o áudio de reprodução do sistema.

Obtém o nome do alto-falante atualmente em uso.

virtual String GetCurrentAudioPlayerName() = 0;

Valor de retorno

O nome do dispositivo de reprodução de áudio atual.

Obtém o ID do alto-falante atualmente em uso.

virtual String GetCurrentAudioPlayerID() = 0;

Valor de retorno

O ID do dispositivo de reprodução de áudio atual.

Seleciona um alto-falante pelo nome.

virtual int SetCurrentAudioPlayerName(const char* playerName) = 0;

Valor de retorno

O nome do dispositivo de reprodução de áudio.

Seleciona um alto-falante pelo ID.

virtual int SetCurrentAudioPlayerID(const char* playerID) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Define o volume do dispositivo de captura de áudio. O intervalo de volume é [0, 100].

virtual int SetRecordingDeviceVolume(int volume) = 0;

Lista de parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Obtém o volume do dispositivo de captura de áudio.

virtual int GetRecordingDeviceVolume() = 0;

Valor de retorno

>=0 retorna o volume. Outros valores indicam falha.

Define o volume do dispositivo de reprodução de áudio. O intervalo de volume é [0, 100].

virtual int SetPlaybackDeviceVolume(int volume) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Obtém o volume do dispositivo de reprodução de áudio.

virtual int GetPlaybackDeviceVolume() = 0;

Valor de retorno

>=0 para o volume do sistema. Outros valores para falha.

Silencia o dispositivo de captura de áudio.

virtual int SetRecordingDeviceMute(bool mute) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Obtém o status de silenciamento do dispositivo de captura de áudio.

virtual bool GetRecordingDeviceMute() = 0;

Valor de retorno

Se a gravação está silenciada.

Silencia o dispositivo de reprodução de áudio.

virtual int SetPlaybackDeviceMute(bool mute) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Obtém o status de silenciamento do dispositivo de reprodução de áudio.

virtual bool GetPlaybackDeviceMute() = 0;

Valor de retorno

Se o dispositivo de reprodução está silenciado.

Define o modo de efeito de modificador de voz.

virtual int SetAudioEffectVoiceChangerMode(const AliEngineAudioEffectVoiceChangerMode &mode) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Define o parâmetro de tom (pitch).

virtual int SetAudioEffectPitchValue(double value) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Define o modo de efeito de reverberação.

virtual int SetAudioEffectReverbMode(const AliEngineAudioEffectReverbMode& mode) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Define o tipo de efeito de reverberação e parâmetros específicos.

virtual int SetAudioEffectReverbParamType(const AliEngineAudioEffectReverbParamType& type,
                                                  float value) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Define o modo predefinido de efeito sonoro de embelezamento.

virtual int SetAudioEffectBeautifyMode(const AliEngineAudioEffectBeautifyMode& mode) = 0;

Este método define modos de embelezamento predefinidos dentro do SDK. É adequado para cenários que exigem melhoria na qualidade da voz humana, como transmissões ao vivo de voz, karaokê e redes sociais por voz. Ao selecionar diferentes modos de embelezamento, você altera o efeito auditivo da voz humana, como aumentar o magnetismo ou melhorar a clareza. Isso aprimora a experiência de audição para usuários remotos.

Quando chamar

Chame este método antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

• 0: A configuração foi bem-sucedida.

• Um valor diferente de zero: A configuração falhou.

Define os parâmetros do equalizador de áudio (EQ) para ajustar o ganho de uma banda de frequência específica.

virtual int SetAudioEffectEqualizationParam(const AliEngineAudioEffectEqualizationBandFrequency &bandIndex, float gain) = 0;

Este método ajusta a voz humana ou o sinal de áudio capturado localmente usando um Equalizador Gráfico. Ao ajustar o ganho (em dB) de uma das 10 bandas de frequência fixas, você personaliza o timbre. É adequado para cenários como otimização de clareza de voz, aprimoramento de voz humana e auxílio na redução de ruído.

O equalizador suporta ajuste de todo o espectro de áudio de 31 Hz a 16 kHz, com um total de 10 bandas de frequência padrão. O valor de ganho para cada banda pode ser definido independentemente, variando de [-15, 15] dB, com padrão de 0 dB (sem reforço ou atenuação).

Limites

• O equalizador não pode ser usado isoladamente antes que o modo de embelezamento seja ativado. Chame este método após chamar setAudioEffectBeautifyMode.

Parâmetros

Descrição da resposta

0: A configuração foi bem-sucedida.

Valor diferente de zero: Falha na configuração.

Adiciona um stream de áudio externo.

virtual int AddExternalAudioStream(const AliEngineExternalAudioStreamConfig& config) = 0;

Este método adiciona um novo stream de áudio externo. Siga as etapas abaixo:

1. Chame <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="08ee3d1ed35jj">AddExternalAudioStream</a> para adicionar um stream de áudio externo e obter o ID desse stream.

2. Utilize <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="fae817d0f00p3">PushExternalAudioStreamRawData</a> para enviar dados de áudio ao stream criado.

3. Ao finalizar a chamada, chame <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="3b9a3eb119umh">RemoveExternalAudioStream</a> para remover o stream de áudio externo.

Para mais informações sobre como publicar áudio coletado personalizado em um canal, consulte Coleta de áudio personalizada.

Parâmetros

Valor de retorno

Um valor maior que 0 indica sucesso na chamada do método e retorna o ID do stream de áudio externo. Outros valores indicam falha na chamada.

Insere dados no stream de áudio externo.

virtual int PushExternalAudioStreamRawData(int streamId, AliEngineAudioRawData& data) = 0;

Este método insere dados no stream de áudio especificado. O processo é o seguinte:

1. Invoque a API <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="3836ac109732c">AddExternalAudioStream</a> para adicionar um stream de áudio externo e obter seu ID.

2. Use PushExternalAudioStreamRawData para passar os dados de áudio ao stream criado.

3. Quando a chamada terminar, será necessário chamar <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="398ea88d61fn0">RemoveExternalAudioStream</a> para remover o stream de áudio externo.

Para detalhes sobre a publicação de áudio coletado personalizado em um canal, veja Coleta de áudio personalizada.

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define o volume de publicação do stream de áudio externo.

virtual int SetExternalAudioStreamPublishVolume(int streamId, int vol) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define o volume de reprodução local do stream de áudio externo.

virtual int SetExternalAudioStreamPlayoutVolume(int streamId, int vol) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Obtém o volume de publicação do stream de áudio externo.

virtual int GetExternalAudioStreamPublishVolume(int streamId) = 0;

Parâmetros

Retorno

[0, 100]: Volume de publicação. Um valor menor que 0 indica falha.

Obtém o volume de reprodução local do stream de áudio externo.

virtual int GetExternalAudioStreamPlayoutVolume(int streamId) = 0;

Parâmetros

Valor de retorno

[0, 100]: Volume de reprodução local. Um valor menor que 0 indica falha.

Remove um stream de áudio externo.

virtual int RemoveExternalAudioStream(int streamId) = 0;

Este método remove o stream de áudio externo correspondente com base no streamId fornecido. Ele corresponde ao método AddExternalAudioStream.

Quando chamar

Para utilizar o recurso de entrada de áudio personalizada, chame o método AddExternalAudioStream a fim de adicionar um stream de áudio e obter seu ID. Em seguida, use a interface <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="bdab74f108i1p">PushExternalAudioStreamRawData</a> para inserir seus dados de áudio no SDK. Caso deseje interromper a entrada de áudio personalizada, invoque esta interface para remover o stream de áudio externo correspondente e liberar recursos.

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Obtém informações do arquivo de áudio.

virtual int GetAudioFileInfo(const char *filePath) = 0;

Trata-se de um método assíncrono. As informações do arquivo de áudio podem ser obtidas por meio de AliEngineEventListener::OnAudioFileInfo.

Parâmetros

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Inicia a mixagem de áudio para acompanhamento.

virtual int StartAudioAccompany(const char *filePath, const AliEngineAudioAccompanyConfig& config) = 0;

Método assíncrono. É possível monitorar o status do reprodutor de acompanhamento musical através de AliEngineEventListener::OnAudioAccompanyStateChanged.

Parâmetros

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Interrompe a mixagem de áudio para acompanhamento.

virtual int StopAudioAccompany() = 0;

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Define o volume do acompanhamento.

 virtual int SetAudioAccompanyVolume(int volume) = 0;

Parâmetros

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Define o volume de publicação do acompanhamento.

virtual int SetAudioAccompanyPublishVolume(int volume) = 0;

Parâmetros

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Obtém o volume de publicação do acompanhamento.

virtual int GetAudioAccompanyPublishVolume() = 0;

Valor de retorno

Volume de publicação do acompanhamento. O intervalo é [0-100].

Define o volume de reprodução local do acompanhamento.

virtual int SetAudioAccompanyPlayoutVolume(int volume) = 0;

Parâmetros

Valor de retorno

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Obtém o volume de reprodução local do acompanhamento.

virtual int GetAudioAccompanyPlayoutVolume() = 0;

Valor de retorno

Volume de reprodução local do acompanhamento. O intervalo é [0-100].

Pausa a mixagem de áudio para acompanhamento.

virtual int PauseAudioAccompany() = 0;

Descrição da resposta

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Retoma a mixagem de áudio para acompanhamento.

virtual int ResumeAudioAccompany() = 0;

Descrição da resposta

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Obtém a duração do arquivo de acompanhamento em milissegundos.

virtual int GetAudioAccompanyDuration() = 0;

Descrição da resposta

Duração do arquivo de acompanhamento musical em milissegundos.

Obtém o progresso de reprodução do arquivo de acompanhamento em milissegundos.

virtual int GetAudioAccompanyCurrentPosition() = 0;

Valor de retorno

Posição atual de reprodução do arquivo de acompanhamento musical em milissegundos.

Define a posição de reprodução do arquivo de acompanhamento.

virtual int SetAudioAccompanyPosition(int pos) = 0;

Descrição da Resposta

• 0: Sucesso.

• Valor diferente de zero: Falha. Um código de erro é retornado.

Pré-carrega um arquivo de efeito sonoro.

virtual int PreloadAudioEffect(unsigned int soundId,
                                       const char *filePath) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Exclui um arquivo de efeito sonoro pré-carregado.

virtual int UnloadAudioEffect(unsigned int soundId) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Inicia a reprodução de um efeito sonoro.

virtual int PlayAudioEffect(unsigned int soundId, const char *filePath, const AliEngineAudioEffectConfig& config) = 0;

Parâmetros

Retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Interrompe a reprodução de um efeito sonoro.

virtual int StopAudioEffect(unsigned int soundId) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Interrompe a reprodução de todos os efeitos sonoros.

- (int)StopAllAudioEffects;

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Pausa um efeito sonoro.

virtual int PauseAudioEffect(unsigned int soundId) = 0;

Parâmetros

Descrição da Resposta

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Pausa todos os efeitos sonoros.

virtual int PauseAllAudioEffects() = 0;

Descrição da resposta

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Retoma a reprodução de um efeito sonoro.

virtual int ResumeAudioEffect(unsigned int soundId) = 0;

Parâmetros

Descrição da resposta

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Retoma a reprodução de todos os efeitos sonoros.

virtual int ResumeAllAudioEffects() = 0;

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define o volume de publicação de um efeito sonoro.

virtual int SetAudioEffectPublishVolume(unsigned int soundId, int volume) = 0;

Parâmetros

Retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Obtém o volume de publicação de um efeito sonoro.

virtual int GetAudioEffectPublishVolume(unsigned int soundId) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define o volume de publicação para todos os efeitos sonoros.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define o volume de reprodução local de um efeito sonoro.

virtual int SetAudioEffectPlayoutVolume(unsigned int soundId, int volume) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Obtém o volume de reprodução local de um efeito sonoro.

virtual int GetAudioEffectPlayoutVolume(unsigned int soundId) = 0;

Parâmetros

Descrição da resposta

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define o volume de reprodução para todos os efeitos sonoros.

virtual int SetAllAudioEffectsPlayoutVolume(int volume) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define o volume de publicação para todos os efeitos sonoros.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define a janela de renderização e os parâmetros de desenho para a pré-visualização local.

virtual int SetLocalViewConfig(AliEngineVideoCanvas renderConfig,
                                         AliEngineVideoTrack track) = 0;

Este método configura a visualização de pré-visualização local. Ele vincula a view de exibição do stream de vídeo local e define o modo de renderização, o modo espelho e o ângulo de rotação da view do usuário local. Isso afeta apenas a pré-visualização do usuário local, não o vídeo publicado. Para configurar a view de um usuário remoto, chame SetRemoteViewConfig.

Quando chamar

Este método pode ser chamado antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define as preferências de captura da câmera.

virtual int SetCameraCapturerConfiguration(const AliEngineCameraCapturerConfiguration& config) = 0;

Este método configura as preferências de captura da câmera, como direção da câmera e taxa de quadros de captura.

Quando chamar

É obrigatório definir isso antes de abrir a câmera. Por exemplo, faça a chamada antes das seguintes operações:

• StartPreview (inicia a pré-visualização)

• JoinChannel (entra em um canal)

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Desativa ou reativa a captura de vídeo local.

virtual int EnableLocalVideo(bool enabled) = 0;

Este método controla a ativação e desativação da captura de vídeo local. Quando a captura de vídeo local está desativada, tanto a pré-visualização local quanto o stream publicado ficam sem dados de vídeo, mas isso não afeta o recebimento de vídeo remoto. Se você chamar este método para desativar a captura da câmera local, a pré-visualização local e o stream publicado remoto permanecerão no último quadro.

Quando chamar

Este método pode ser chamado antes ou depois de entrar em um canal.

Callbacks relacionados

Após uma chamada bem-sucedida a este método, o callback OnUserVideoEnabled notifica os usuários remotos.

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Interrompe ou retoma o envio de dados de vídeo local.

virtual int MuteLocalCamera(bool mute, AliEngineVideoTrack track) = 0;

Durante a publicação de um stream, chame este método para publicar quadros de vídeo totalmente pretos. A pré-visualização local permanece normal, e os módulos de captura, codificação e envio continuam funcionando, mas o conteúdo do vídeo consiste em quadros pretos.

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Define a janela de renderização e os parâmetros de desenho para um vídeo remoto.

virtual int SetRemoteViewConfig(AliEngineVideoCanvas renderConfig,
                                          const char *uid,
                                          AliEngineVideoTrack track) = 0;

Este método associa a view de exibição para um stream de vídeo específico de um usuário remoto e define propriedades para a exibição local dessa view remota, como modo de renderização, modo espelho e ângulo de rotação. Essa ação afeta apenas a imagem de vídeo vista pelo usuário local. Para configurar a view de pré-visualização local, chame <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#fbc8ab10f5e03" id="c0f59b8c26y7o">SetLocalViewConfig</a>.

• Caso o parâmetro view em AliEngineVideoCanvas esteja vazio, a renderização para.

• Para redefinir o parâmetro renderMode de AliEngineVideoCanvas durante a reprodução, mantenha os demais parâmetros inalterados e modifique apenas renderMode.

• Para redefinir o parâmetro mirrorMode de AliEngineVideoCanvas durante a reprodução, mantenha os demais parâmetros inalterados e modifique apenas mirrorMode.

Quando chamar

Recomendamos fazer esta chamada ao receber o callback OnRemoteTrackAvailableNotify, momento em que o vídeo do usuário remoto se torna disponível.

Parâmetros

Valor de retorno

0: Chamada de método bem-sucedida. Outros valores: Falha na chamada de método.

Verifica se a câmera está ligada.

virtual bool IsCameraOn() = 0;

Valor de retorno

true: A câmera está ligada. false: A câmera não está ligada.

Define as propriedades de codificação de vídeo.

virtual void SetVideoEncoderConfiguration(const AliEngineVideoEncoderConfiguration& config) = 0;

Este método define os parâmetros de vídeo para as propriedades de codificação do stream de vídeo, como resolução, taxa de quadros, taxa de bits e orientação do vídeo. Recomendamos chamar este método para todos os cenários de vídeo.

Quando chamar

Este método pode ser chamado antes ou depois de entrar em um canal. Se você precisar definir as propriedades de codificação de vídeo do stream da câmera apenas uma vez por sessão, recomendamos fazer a chamada antes de entrar no canal.

Limites

O mirrorMode deste método e setVideoMirrorMode podem ambos configurar o espelhamento da publicação de vídeo. Recomendamos usar apenas um deles. O uso simultâneo de vários métodos pode causar o acúmulo de efeitos de espelhamento, levando a falhas ou configurações incorretas.

Parâmetros

Define as propriedades de decodificação de vídeo. Este método configura as propriedades de decodificação do fluxo de vídeo da câmera, incluindo ajustes de decodificação por software e hardware, além da ativação de B-frames.

virtual void SetVideoDecoderConfiguration(const AliEngineVideoDecoderConfiguration& config) = 0;

Quando chamar

Recomendamos chamar este método antes de entrar em um canal e iniciar o pull do fluxo.

Parâmetros

Inicia a pré-visualização local e liga a câmera automaticamente.

virtual int StartPreview(int width = 0, int height = 0) = 0;

Este método inicia a pré-visualização de vídeo local e liga a câmera automaticamente. Para interromper a pré-visualização local, chame o método StopPreview.

Quando chamar

• Antes de chamar este método, defina uma visualização para a pré-visualização local por meio de SetLocalViewConfig. Caso contrário, a pré-visualização do vídeo não funcionará, mas isso não afeta a publicação.

• Se necessário, chame este método antes de entrar em um canal com JoinChannel para iniciar a pré-visualização, o que ligará a câmera automaticamente.

Descrição da resposta

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe a pré-visualização local.

virtual int StopPreview() = 0;

Este método encerra a pré-visualização de vídeo local e desliga a câmera. Após interromper a pré-visualização, o lado local permanecerá no último quadro exibido, sem afetar a publicação.

Quando chamar

Para interromper a pré-visualização após iniciá-la, chame este método.

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Define as capacidades de espelhamento para pré-visualização e publicação.

virtual int setVideoMirrorMode(AliEngineVideoPipelineMirrorMode mirrorMode) = 0;

Este método define se o modo de espelhamento deve ser ativado para o vídeo de pré-visualização local e para o fluxo de vídeo publicado.

Quando chamar

É possível definir este método dinamicamente antes ou depois de entrar em um canal. O SDK registra o estado e opera sobre o vídeo quando a pré-visualização e a codificação (publicação) podem ser manipuladas.

Limites

Este método sobrepõe-se ao parâmetro mirrorMode em SetLocalViewConfig e SetVideoEncoderConfiguration. Recomendamos utilizar apenas este método.

Parâmetros

Valor de retorno

• 0: A configuração foi bem-sucedida.

• <0: Falha na configuração.

  • AliRtcErrInner: Erro interno de estado do SDK. Verifique se a instância do SDK foi criada com sucesso.

Define o momento do redimensionamento da captura. Os dados de vídeo são redimensionados imediatamente após a captura ou durante a codificação.

virtual void SetCapturePipelineScaleMode(const AliEngineCapturePipelineScaleMode mode) = 0;

Este método define se o redimensionamento dos dados de vídeo capturados ocorre imediatamente após a captura ou durante a codificação. Por exemplo, quando a resolução de captura difere da resolução de codificação, você pode definir o momento do redimensionamento para determinar se os dados de pré-visualização e os dados publicados serão consistentes.

Quando chamar

Configure este método antes de abrir a câmera, por exemplo, antes de iniciar a pré-visualização com StartPreview ou entrar em um canal com JoinChannel.

Parâmetros

Obtém a lista de câmeras.

virtual AliEngineDeviceInfoList* GetCameraList() = 0;

Valor de retorno

Um ponteiro para o objeto da lista de câmeras, AliEngineDeviceInfoList*.

Obtém o nome da câmera em uso.

virtual String GetCurrentCameraName() = 0;

Valor de retorno

O nome do dispositivo de câmera atualmente em uso.

Obtém o ID da câmera em uso.

virtual String GetCurrentCameraID() = 0;

Valor de retorno

O ID da câmera atualmente em uso.

Seleciona uma câmera pelo nome.

virtual int SetCurrentCameraName(const char* cameraName) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Seleciona uma câmera pelo ID.

virtual int SetCurrentCameraID(const char* cameraID) = 0;

Parâmetros

Valor de retorno

0 para sucesso, outros valores para falha.

Obtém as resoluções suportadas.

virtual AliEngineVideoResolutionList * GetCurrentCameraSupportedResolutionList(int source) = 0 ;

Parâmetros

Valor de retorno

Se o valor não for NULL, retorna a lista de resoluções suportadas. NULL indica falha.

Ativa uma fonte de entrada de vídeo externa.

virtual int SetExternalVideoSource(bool enable,
        AliEngineVideoTrack type,
        AliEngineRenderMode renderMode) = 0;

Parâmetros

Insere dados de vídeo.

virtual int PushExternalVideoFrame(const AliEngineVideoRawData &frame,
        AliEngineVideoTrack type) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Inicia uma transmissão ao vivo via bypass.

virtual int StartPublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Atualiza os parâmetros da transmissão ao vivo via bypass.

virtual int UpdatePublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

Parâmetros

Valor de retorno

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Interrompe a transmissão ao vivo via bypass.

virtual int StopPublishLiveStream(const String& streamURL) = 0;

Parâmetros

Descrição da resposta

0: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Obtém o status da transmissão ao vivo via bypass.

virtual AliEngineLiveTranscodingState GetPublishLiveStreamState(const String& streamURL) = 0;

Parâmetros

Descrição da resposta

Retorna o status da transmissão ao vivo via bypass.

Inicia a detecção de qualidade de rede. Problemas na rede local podem causar falhas em chamadas de áudio e vídeo. Ao chamar este método, você obtém informações como largura de banda de upload e download, taxa de perda de pacotes, jitter e RTT do link, ajudando a identificar e resolver problemas de rede relacionados.

 virtual int StartLastmileDetect(bool uplink, bool downlink, int uplinkBandWidth, int downlinkBandWidth) = 0;

Quando chamar

Chame este método antes de JoinChannel. Os resultados da detecção serão fornecidos por meio de callback. Uma detecção de rede pode levar bastante tempo. Se necessário, chame StopLastmileDetect para interromper a detecção.

Limites

O SDK só pode executar uma detecção de rede por vez. Chamadas repetidas antes da conclusão da detecção anterior serão inválidas.

Callbacks relacionados

Após uma chamada bem-sucedida a este método, dois callbacks serão acionados:

• OnLastmileDetectResultWithQuality: Acionado em cerca de 3 segundos para determinar aproximadamente o nível de qualidade da rede.

• OnLastmileDetectResultWithBandWidth: Acionado em cerca de 30 segundos para fornecer resultados detalhados da detecção.

Parâmetros

Valor de retorno

• 0: A chamada do método foi bem-sucedida.

• <0: A chamada do método falhou. Isso pode ocorrer, por exemplo, se você já tiver entrado em um canal.

Interrompe a detecção de qualidade de rede. Chame este método para parar a detecção.

virtual int StopLastmileDetect() = 0;

Quando chamar

Chame este método após criar o engine e antes de entrar em um canal.

Valor de retorno

• 0: Este método foi chamado com sucesso.

• <0: A chamada deste método falhou.

Envia informações de extensão de mídia, implementadas internamente usando SEI.

virtual int SendMediaExtensionMsg(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame) = 0;

O SDK fornece a funcionalidade de envio e recebimento de informações de extensão de mídia. O recebimento refere-se a AliEngineEventListener::OnMediaExtensionMsgReceived. Ao usar informações de extensão de mídia, é necessário reutilizar o canal de dados de áudio e vídeo, portanto, a frequência de envio e o tamanho dos dados das mensagens personalizadas devem ser controlados. Os limites de uso são:

• Envie no máximo fps mensagens por segundo, conforme definido pelo perfil.

• Para evitar impacto na qualidade de transmissão dos dados de mídia, o corpo da mensagem personalizada é limitado a 4 KB, adequado para transmitir pequenos volumes de dados.

• O parâmetro repeatCount na função sendMediaExtensionMsg representa a redundância da mensagem personalizada. Se for maior que 1, a mensagem será enviada várias vezes para evitar perdas devido a perda de pacotes na rede. Nesse caso, outros participantes da sala também receberão a mesma mensagem múltiplas vezes, sendo necessária a remoção de duplicatas.

• Quando a mensagem personalizada é enviada, os assinantes na sala também a recebem durante a transmissão ao vivo via bypass. Definir como -1 significa enviar os dados permanentemente, a menos que sendMediaExtensionMsg seja chamado novamente.

• Apenas uma sendMediaExtensionMsg é enviada por vez. Isso significa que chamar sendMediaExtensionMsg sobrescreverá a chamada anterior se esta ainda não tiver sido enviada ou concluída.

Parâmetros

Valor de retorno

• 0: Sucesso.

• <0: Falha. Um código de erro é retornado.

  • ERR_INNER(-1): Erro interno do SDK. Pode ocorrer se o SDK não estiver inicializado ou se for chamado após ser destruído.

Envia informações de extensão de mídia, implementadas internamente usando SEI.

virtual int SendMediaExtensionMsgEx(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame, int32_t payloadType) = 0;

O SDK fornece a funcionalidade de envio e recebimento de informações de extensão de mídia. O recebimento refere-se a AliEngineEventListener::OnMediaExtensionMsgReceived. Ao usar informações de extensão de mídia, é necessário reutilizar o canal de dados de áudio e vídeo, portanto, a frequência de envio e o tamanho dos dados das mensagens personalizadas devem ser controlados. Os limites de uso são:

• Envie no máximo fps mensagens por segundo, conforme definido pelo perfil.

• Para evitar impacto na qualidade de transmissão dos dados de mídia, o corpo da mensagem personalizada é limitado a 4 KB, adequado para transmitir pequenos volumes de dados.

• O parâmetro repeatCount na função sendMediaExtensionMsg representa a redundância da mensagem personalizada. Se for maior que 1, a mensagem será enviada várias vezes para evitar perdas devido a perda de pacotes na rede. Nesse caso, outros participantes da sala também receberão a mesma mensagem múltiplas vezes, sendo necessária a remoção de duplicatas.

• Quando a mensagem personalizada é enviada, os assinantes na sala também a recebem durante a transmissão ao vivo via bypass. Definir como -1 significa enviar os dados permanentemente, a menos que sendMediaExtensionMsg seja chamado novamente.

• Apenas uma sendMediaExtensionMsg é enviada por vez. Isso significa que chamar sendMediaExtensionMsg sobrescreverá a chamada anterior se esta ainda não tiver sido enviada ou concluída.

Parâmetros

Valor de retorno

• 0: Sucesso.

• <0: Falha. Um código de erro é retornado.

  • ERR_INNER(-1): Erro interno do SDK. Pode ocorrer se o SDK não estiver inicializado ou se for chamado após ser destruído.

Callback para alterações no status da conexão de rede.

virtual void OnConnectionStatusChange(int status, int reason) {};

Parâmetros

Callback para exceções em dispositivos locais. É importante prestar atenção a este callback.

virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg){};

Parâmetros

Notificação de que as informações de autenticação do usuário estão prestes a expirar. A autenticação expirará 30 segundos após o recebimento desta notificação. É importante prestar atenção a este callback.

virtual void OnAuthInfoWillExpire() {};

Este callback indica que as informações de autenticação do usuário estão prestes a expirar. A autenticação expirará 30 segundos após o recebimento deste callback. Obtenha um novo token e atualize as informações de autenticação de uma das seguintes formas:

• Chame o método RefreshAuthInfo para atualizar as informações de autenticação.

• Chame LeaveChannel para sair do canal atual e, em seguida, chame JoinChannel para entrar novamente no canal.

Quando é acionado

O SDK aciona este callback 30 segundos antes da expiração das informações de autenticação do usuário. Atualize as informações de autenticação prontamente após receber este callback.

O usuário chama uma interface que requer autenticação e o servidor retorna que as informações expiraram.

virtual void OnAuthInfoExpired() {};

Este callback indica que as informações de autenticação do usuário expiraram. Para continuar a sessão, gere um novo token no servidor e atualize as informações de autenticação usando o seguinte método:

• Chame LeaveChannel para sair do canal atual e, em seguida, chame JoinChannel para entrar novamente no canal.

Quando é acionado

Este callback é acionado quando as informações de autenticação do usuário expiram.

Callback para o resultado da entrada em um canal. Este callback equivale à operação de bloqueio ao chamar o método JoinChannel, lidando com eventos após a entrada no canal. Escolha uma das opções.

virtual void OnJoinChannelResult(int result, const char *channel, const char *userId, int elapsed) {}

Condições de acionamento

Quando a aplicação chama o método JoinChannel, este callback indica se a entrada no canal foi bem-sucedida e retorna informações sobre a entrada e o tempo decorrido.

Parâmetros

Callback para o resultado da saída de um canal. Retornado após a chamada do método LeaveChannel. Se você chamar Destroy imediatamente após esta chamada, não receberá este callback.

virtual void OnLeaveChannelResult(int result, AliEngineStats stats) {}

Condições de acionamento

Quando a aplicação chama com sucesso LeaveChannel para sair do canal, este callback é acionado para retornar o resultado da saída e as estatísticas desta sessão de canal.

Parâmetros

Callback para quando um usuário remoto fica offline.

virtual void OnRemoteUserOffLineNotify(const char *uid, AliEngineUserOfflineReason reason) {}

Este callback notifica o usuário local que um usuário remoto saiu do canal por vários motivos. Quando um usuário remoto fica offline, este método é acionado.

Condições de acionamento

• Acionado quando um usuário remoto sai ativamente do canal.

• Acionado quando um streamer remoto chama <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="03e45f655fcxx">SetClientRole</a> para mudar sua função para espectador (definido como AliEngineClientRoleLive).

• Acionado quando nenhum dado é recebido do streamer remoto por um longo período, considerando que ele caiu.

Parâmetros

Callback para quando um usuário remoto fica online.

virtual void OnRemoteUserOnLineNotify(const char *uid, int elapsed) {}

Este método notifica o cliente local que um usuário remoto entrou no canal.

Condições de acionamento

• Um usuário remoto entra com sucesso no canal.

• Após o usuário atual entrar no canal, ele recebe um callback de entrada para usuários que já estavam no canal. Isso serve para exibir usuários que entraram anteriormente.

Parâmetros

Callback para quando o fluxo de um usuário remoto muda.

virtual void OnRemoteTrackAvailableNotify(const char *uid,
                                                  AliEngineAudioTrack audioTrack,
                                                  AliEngineVideoTrack videoTrack) {}

Este callback é acionado quando o estado de publicação de um usuário remoto muda. Por meio dele, é possível saber em tempo real se um usuário remoto está publicando fluxos de áudio e vídeo. Assim, você pode exibir ou ocultar as informações de áudio e vídeo do usuário remoto na UI adequadamente.

Condições de acionamento

Este callback é acionado nos seguintes cenários:

• Quando um usuário remoto passa de não publicar para publicar (incluindo áudio e vídeo).

• Quando um usuário remoto passa de publicar para não publicar (incluindo áudio e vídeo).

• No modo de transmissão interativa, quando um usuário remoto chama SetClientRole para mudar de espectador para streamer e também define a publicação, este callback é acionado.

Tomando o vídeo como exemplo, suponha que um usuário remoto esteja configurado para não publicar. Nesse caso, este callback não será acionado.

• Quando o usuário remoto começa a publicar o fluxo da câmera (estado de publicação: sem fluxo de vídeo -> apenas fluxo da câmera), o callback local retorna AliEngineVideoTrackCamera, indicando que o fluxo da câmera do usuário remoto está disponível.

• Quando o usuário remoto também publica o fluxo de compartilhamento de tela (estado de publicação: apenas fluxo da câmera -> fluxo da câmera e fluxo de compartilhamento de tela), o callback local retorna AliEngineVideoTrackBoth, indicando que tanto o fluxo da câmera quanto o de compartilhamento de tela do usuário remoto estão disponíveis.

• Quando o usuário remoto para de publicar o fluxo da câmera e mantém apenas o fluxo de compartilhamento de tela (estado de publicação: fluxo da câmera e fluxo de compartilhamento de tela -> apenas fluxo de compartilhamento de tela), o callback local retorna AliEngineVideoTrackScreen, indicando que apenas o fluxo de compartilhamento de tela está disponível no momento.

• Quando o usuário remoto para de publicar o fluxo de compartilhamento de tela (estado de publicação: apenas fluxo de compartilhamento de tela -> sem fluxo de vídeo), o callback local retorna AliEngineVideoTrackNo, indicando que nenhum fluxo de vídeo está disponível no momento.

Parâmetros

Callback para quando o usuário é expulso pelo servidor ou o canal é fechado.

virtual void OnBye(int code) {}

Quando um usuário é desconectado por algum motivo ou o canal é fechado, este callback é acionado. Use o parâmetro do callback code para identificar o motivo da desconexão e tratá-lo adequadamente.

Condições de acionamento

• O usuário atual é expulso pelo servidor.

• O canal é fechado (o servidor remove ativamente o canal).

• Saída passiva, exigindo que o cliente tente restaurar a sessão ou reconectar.

Parâmetros

Callback para alterações na publicação de áudio.

virtual void OnAudioPublishStateChanged(AliEnginePublishState oldState, AliEnginePublishState newState, int elapseSinceLastState, const char *channel) {};

Este callback monitora as mudanças no estado de publicação do fluxo de áudio do usuário local.

Condições de acionamento

Quando o estado de publicação de áudio do usuário muda, por exemplo:

• A publicação é interrompida.

• Chama <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="904fc4e83a35n">SetClientRole</a> para mudar para espectador.

Parâmetros

Callback para alterações na assinatura de áudio.

virtual void OnAudioSubscribeStateChanged(const char *uid,
                                                  AliEngineSubscribeState oldState, 
                                                  AliEngineSubscribeState newState,
                                                  int elapseSinceLastState,
                                                  const char *channel) {};

Este callback notifica o usuário local sobre mudanças no estado de assinatura do fluxo de áudio de um usuário remoto. Por meio dele, é possível identificar a alteração no estado de assinatura do fluxo da câmera de um usuário remoto e o intervalo de tempo entre o estado anterior e o atual.

Parâmetros

Notificação de que um usuário silenciou o áudio.

virtual void OnUserAudioMuted(const char* uid, bool isMute) {}

Parâmetros

Notificação de que o áudio de um usuário foi interrompido. Isso geralmente ocorre em cenários onde o áudio é preemptado, como por uma chamada telefônica.

virtual void OnUserAudioInterruptedBegin(const char* uid) {}

Parâmetros

Notificação de que a interrupção do áudio de um usuário terminou. Corresponde a OnUserAudioInterruptedBegin.

virtual void OnUserAudioInterruptedEnded(const char* uid) {}

Parâmetros

Callback para alterações na publicação de vídeo.

virtual void OnVideoPublishStateChanged(AliEnginePublishState oldState, AliEnginePublishState newState, int elapseSinceLastState, const char *channel) {};

Este callback monitora as mudanças no estado de publicação de vídeo do usuário local.

Parâmetros

Callback para alterações na assinatura do fluxo da câmera.

virtual void OnVideoSubscribeStateChanged(const char *uid, 
                                                  AliEngineSubscribeState oldState, 
                                                  AliEngineSubscribeState newState,
                                                  int elapseSinceLastState,
                                                  const char *channel) {};

Este callback notifica o usuário local sobre mudanças no estado de assinatura do fluxo da câmera de um usuário remoto. Por meio dele, é possível identificar a alteração no estado de assinatura do fluxo da câmera de um usuário remoto e o intervalo de tempo entre o estado anterior e o atual.

Callbacks relacionados

Os fluxos de vídeo incluem principalmente fluxos de câmera e fluxos de compartilhamento de tela. Este método refere-se às mudanças no estado de assinatura do fluxo da câmera. O método de callback relacionado para fluxos de compartilhamento de tela é OnScreenShareSubscribeStateChanged.

Parâmetros

Notificação de que um usuário silenciou o vídeo.

virtual void OnUserVideoMuted(const char* uid, bool isMute) {}

Parâmetros