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 aplicativo.

Descrições 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 aplicativos 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 callbacks para o SDK. Ao configurar esse listener, você recebe diversos 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 para o seu caso de uso.

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 seu aplicativo 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 seu aplicativo os monitore e responda adequadamente:

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, ele 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 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 sem enviá-los, 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. A redefinição só é permitida 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 Common audio operations and configurations. O ARTC SDK utiliza o modo de alta qualidade (AliEngineHighQualityMode) e o modo de cenário musical (AliEngineSceneMusicMode) por padrão. Caso as configurações padrão não atendam à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. A redefinição só é permitida 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 é somente áudio.

virtual bool IsAudioOnlyMode() = 0;

Valor de retorno

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

Define o modo como somente á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 essa finalidade. Eles diferem nos métodos de autenticação e nas informações de usuário transmitidas, conforme descrito abaixo:

• Destinado a entrar em um canal com um único parâmetro. Passe um token gerado para entrada com parâmetro único usando Token-based authentication. Recomendamos este método para entrada em canais em cenários RTC.

• JoinChannel[2/3] serve para entrar em um canal com múltiplos parâmetros. Passe um token de múltiplos parâmetros gerado via Token-based authentication juntamente com as informações de usuário usadas na geração do token.

• JoinChannel[3/3] é voltado para 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 de acordo com o 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 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.

• Aplicativos com App IDs diferentes não conseguem se comunicar entre si.

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

Callbacks relacionados

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

• O resultado da entrada do cliente local no canal é retornado pelo 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 a entrada bem-sucedida 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 essa finalidade. 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 Token-based authentication. Recomendamos este método para entrada em canais em cenários RTC.

• Utilize este método para entrar em um canal com múltiplos parâmetros. Passe um token de múltiplos parâmetros gerado via Token-based authentication juntamente com as informações de usuário usadas na geração do token.

• JoinChannel[3/3] é voltado para 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 de acordo com o 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 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.

• Aplicativos com App IDs diferentes não conseguem 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 no canal por meio 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 a entrada bem-sucedida no 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 essa finalidade. 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 Token-based authentication. Recomendamos este método para entrada em canais em cenários RTC.

• JoinChannel[2/3] serve para entrar em um canal com múltiplos parâmetros. Passe um token de múltiplos parâmetros gerado via Token-based authentication juntamente com as informações de usuário usadas na geração do token.

• Voltado para 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 de acordo com o cenário. Para comunicação 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.

• Aplicativos com App IDs diferentes não conseguem se comunicar entre si.

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

Callbacks relacionados

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

• O resultado da entrada do usuário local no canal é fornecido pelo 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 a entrada bem-sucedida 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: Falha na chamada do método.

Permite sair do canal.

virtual int LeaveChannel() = 0;

Ao invocar este método, o SDK encerra a chamada de áudio e vídeo e desconecta o usuário do canal atual.

Quando chamar

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

• É obrigatório sair do canal atual antes de ingressar em um novo.

Callbacks relacionados

• A execução deste método dispara 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, informando se a saída do canal ocorreu com sucesso.

• Para 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

O valor 0 indica que a chamada do método foi bem-sucedida. Qualquer outro valor sinaliza falha na execução.

Verifica se o usuário está conectado a um canal no momento.

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 configura a função do usuário como streamer ou viewer.

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

• Caso a função seja definida como streamer, o SDK publica automaticamente os fluxos locais de áudio e vídeo e recebe, por padrão, os fluxos de outros streamers.

• Se a função escolhida for viewer, o SDK não publica os fluxos locais, mas continua recebendo o áudio e vídeo dos demais streamers.

Quando chamar

A invocação pode ocorrer antes ou depois da entrada no canal. Use-a previamente para estabelecer a função inicial, ou posteriormente para alternar entre funções.

Limites

Este método funciona exclusivamente no modo de transmissão interativa. Portanto, é necessário 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 configurar o perfil do canal como AliEngineInteractiveLive.

Recomendamos definir explicitamente a função do usuário através deste método antes de ingressar no canal durante transmissões interativas.

Parâmetros

Valor de retorno

0: Chamada bem-sucedida. Outros valores: Falha na execução do método.

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

virtual AliEngineClientRole GetClientRole() = 0;

Valor de retorno

Em caso de sucesso, retorna um objeto AliEngineClientRole. Trata-se de uma enumeração onde 0 representa streamer e 1 indica viewer.

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

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

Renova os dados de autenticação. Como o token possui validade limitada, sua expiração impede que o SDK mantenha conexão com o 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>, indicando que a autenticação está prestes a expirar, gere um novo token no servidor e invoque este método com as novas credenciais.

• Sem a atualização tempestiva do token, o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="440c501877fxr">OnAuthInfoExpired</a> notifica a expiração da autenticação. Nesse cenário, regenere o token e chame JoinChannel para reconectar ao canal.

Parâmetros

Valor de retorno

0: Execução bem-sucedida. Outros valores: Erro na chamada do método.

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

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

Atualiza o token vigente. Devido à validade temporária do token, o SDK perde a conexão com o servidor após a expiração.

Quando chamar

Recomendamos regenerar o token no servidor e utilizar este método para aplicar as novas credenciais nas situações abaixo:

• Recebimento do callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="b21949148djrc">OnAuthInfoWillExpire</a>, sinalizando proximidade da expiração da autenticação.

• Caso o token não seja renovado 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> indicará a perda de validade. Será necessário então chamar JoinChannel para reingressar no canal.

Parâmetros

Valor de retorno

0: Sucesso na operação. Demais valores: Falha na execução.

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

virtual int PublishLocalAudioStream(bool enabled) = 0;

Controla a divulgação do áudio capturado localmente. Por padrão, o SDK publica esse fluxo. Para inibir esse comportamento inicial, execute PublishLocalAudioStream(false) antes de entrar no canal.

Quando chamar

Aceita chamadas tanto antes quanto depois da conexão ao canal. Se executado previamente, altera a configuração padrão aplicada no momento da entrada.

Callbacks relacionados

Mudanças no status de ingestão do áudio local disparam o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#eb8fab7f5ak7v" id="c584949653jn5">OnAudioPublishStateChanged</a> no cliente local. Simultaneamente, clientes remotos recebem o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="75f2096b1efxy">OnRemoteTrackAvailableNotify</a> informando alterações nos fluxos do usuário distante.

Parâmetros

Valor de retorno

0: Operação concluída com êxito. Outros valores: Erro durante a chamada.

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

virtual bool IsLocalAudioStreamPublished() = 0;

Valor de retorno

true: Publicação autorizada. false: Publicação bloqueada.

Configura a assinatura automática de fluxos de áudio remotos.

virtual int SetDefaultSubscribeAllRemoteAudioStreams(bool sub) = 0;

Determina se o sistema deve assinar por padrão o áudio de participantes remotos. Essa definição impacta diretamente novos usuários que entrarem no canal. Salvo necessidades específicas, mantenha o valor como true.

Quando chamar

Executável antes ou após a entrada no canal.

• Antes de ingressar:

  • O SDK assina automaticamente o áudio remoto na conexão. Invoque este método previamente caso deseje modificar tal comportamento.

• Depois de entrar:

  • Para cessar a assinatura automática, utilize <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e95a7e2d6fjwt">SetDefaultSubscribeAllRemoteAudioStreams</a>(false). Assim, fluxos de áudio de futuros participantes não serão assinados.

  • Uma vez suspensa a assinatura padrão, use <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 recepção de um usuário específico. Repita a chamada para cada participante adicional desejado.

  • Reativar a assinatura padrão via <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e79b5ad58awcw">SetDefaultSubscribeAllRemoteAudioStreams</a>(true) afeta apenas quem entrar dali em diante. Usuários conectados durante o período de suspensão permanecem sem assinatura ativa.

Parâmetros

Valor de retorno

0: Sucesso na chamada. Valores distintos: Falha na operação.

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

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

Gerencia a recepção do fluxo de áudio de um participante remoto individual. Recomenda-se manter o valor true, exceto se houver requisitos especiais.

Parâmetros

Descrição da resposta

0: Método executado corretamente. Outros resultados: Ocorreu uma falha.

Suspende ou reativa a recepção global de áudio remoto.

virtual int SubscribeAllRemoteAudioStreams(bool sub) = 0;

Funciona como chave mestra para a assinatura de áudio remoto. Mantenha-o ativado preferencialmente. Definir como false acarreta:

• Interrupção imediata de todas as assinaturas de áudio no canal vigente.

• Novos participantes também terão seus fluxos ignorados.

• Impossibilidade de usar <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="aface4ad3920l">SubscribeRemoteAudioStream</a> para gerenciar áudio individualmente.

Para restabelecer o serviço, invoque novamente este método com o valor true.

Parâmetros

Valor de retorno

0: Êxito na execução. Diferente de zero: Problema na chamada.

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

virtual int PublishLocalVideoStream(bool enabled) = 0;

Gerencia o envio do vídeo capturado localmente.

Quando chamar

Pode ser executado antes ou depois da entrada no canal.

Chamadas prévias ajustam a configuração base aplicada no momento da conexão.

Callbacks relacionados

Alterações no status de ingestão do vídeo local acionam o callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="d37709b09147d">OnVideoPublishStateChanged</a> localmente. Clientes remotos são notificados via callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="f16e4b51bchqb">OnRemoteTrackAvailableNotify</a> sobre mudanças nos fluxos audiovisuais.

Parâmetros

Valor de retorno

• 0: Chamada realizada com sucesso.

• <0: Ocorreu erro na execução.

Habilita ou desabilita o envio do fluxo de vídeo.

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

Controla a publicação do vídeo coletado localmente.

Quando chamar

Disponível para uso antes ou após a conexão ao canal.

Ajustes feitos anteriormente à entrada modificam o comportamento padrão adotado na conexão.

Callbacks relacionados

Variações no estado de ingestão do vídeo local geram o callback <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="18a9d4b47ezcc">OnVideoPublishStateChanged</a> no lado local. O lado remoto recebe o aviso via callback <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="d01e7a574f92o">OnRemoteTrackAvailableNotify</a> indicando alteração nos fluxos.

Parâmetros

Retorno

• 0: Execução bem-sucedida.

• <0: Falha identificada.

Verifica se a publicação do fluxo de vídeo está habilitada.

virtual bool IsLocalVideoStreamPublished() = 0;

Valor de retorno

true: Fluxo da câmera sendo publicado. false: Publicação do fluxo da câmera inativa.

Define a preferência padrão para recebimento de vídeo.

virtual int SetDefaultSubscribeAllRemoteVideoStreams(bool sub) = 0;

Estabelece se a assinatura de vídeos remotos deve ocorrer automaticamente. O SDK vem configurado para assinar por padrão.

Quando chamar

Aceita execução antes ou depois de ingressar no canal.

• Pré-conexão:

  • Use para revogar a configuração automática de assinatura.

• Pós-conexão:

  • Execute SetDefaultSubscribeAllRemoteVideoStreams(false) para parar a assinatura automática. Isso evita a recepção de vídeo de quem entrar posteriormente.

  • Com a assinatura padrão suspensa, utilize o método SubscribeRemoteVideoStream para voltar a receber o vídeo de alguém específico. Chamadas múltiplas são necessárias para vários usuários.

  • Note que reativar via SetDefaultSubscribeAllRemoteVideoStreams(false) afeta somente novos entrantes, restaurando seus fluxos de áudio.

Parâmetros

Valor de retorno

0: Operação concluída. Outros códigos: Erro detectado.

Gerencia a assinatura do fluxo de vídeo de um usuário remoto.

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

Permite assinar ou cancelar a assinatura do vídeo de um participante específico.

Quando chamar

Válido tanto antes quanto depois de entrar no canal.

Parâmetros

Valor de retorno

• true: Configuração aplicada com êxito.

• false: Falha ao aplicar a configuração.

Controla globalmente a recepção de vídeos remotos.

virtual int SubscribeAllRemoteVideoStreams(bool sub) = 0;

Atua como interruptor geral para assinatura de vídeo remoto. Definir como false provoca:

• Parada imediata na recepção de todos os vídeos no canal.

• Bloqueio de vídeos de novos entrantes, mesmo que <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#2cbc54790brn3" id="b7b0080f3cnoq">SetDefaultSubscribeAllRemoteVideoStreams</a>(true) tenha sido chamado para assinatura padrão.

• Impedimento de controle individual via <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#jyGTp" id="0e2edf97aa1g6">SubscribeRemoteVideoStream</a> para usuários específicos.

Para reassinar, basta chamar o método novamente com true.

Parâmetros

Descrição da resposta

0: Sucesso confirmado. Outros valores: Indicação de erro.

Gerencia 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;

Realiza a assinatura conjunta de áudio e vídeo remotos.

Métodos relacionados

Diferentemente de SubscribeRemoteMediaStream[2/2], esta versão emprega dois booleanos (subVideo e subAudio) para decidir sobre a assinatura dos fluxos. Já o parâmetro videoTrack seleciona qual fonte de vídeo puxar.

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 stream 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 streams de áudio e vídeo remotos simultaneamente.

Métodos relacionados

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

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

• Para cancelar a assinatura do stream da câmera, mas manter o stream 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 stream da câmera quanto o stream 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 stream 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.

• Um 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 apenas para interromper ou retomar a reprodução de áudio de um usuário remoto especificado. Ela não afeta o pull do 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 de áudio antecipadamente. Se não for definido, o SDK controla automaticamente o dispositivo de captura de áudio. Para iniciar a captura de áudio após ela ter sido interrompida pela chamada de 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 se o dispositivo de captura de áudio permanece ligado após você sair do canal por meio de um parâmetro.

Callbacks relacionados

Após chamar este método para alterar o estado de captura de áudio local, 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 de áudio antecipadamente. Se não for 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 usando o parâmetro keepAlive.

Callbacks relacionados

Após chamar este método para alterar o estado de captura de áudio local, 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

Após chamar este método para alterar o estado de captura de áudio local, 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 informações relacionadas ao volume sobre usuários locais publicando e o usuário remoto com o maior volume instantâneo para a aplicação.

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 seguintes no intervalo de tempo definido:

• O volume de áudio do orador é relatado através do 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 orador é relatado através do 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. Se não for definido, o SDK inicia automaticamente a reprodução de áudio após assinar 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 pode interromper 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 pode iniciar 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 aplicações.

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.

Configure este método apenas após a captura e publicação de áudio do sistema serem ativadas. Caso contrário, a configuraçã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.

Configure este método apenas após a captura e publicação de áudio do sistema serem ativadas. Caso contrário, a configuraçã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 indica sucesso; outros valores indicam falha.

Seleciona um dispositivo de gravação por ID.

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

Parâmetros

Valor de retorno

0 indica sucesso; outros valores indicam 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 *.

Recupera 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 o último parâmetro de EnableSystemAudioRecording para coletar o áudio de reprodução do sistema.

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

virtual String GetCurrentAudioPlayerName() = 0;

Valor de retorno

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

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

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 por ID.

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

Parâmetros

Valor de retorno

0 indica sucesso; outros valores indicam 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 indica sucesso; outros valores indicam 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 indica sucesso; outros valores indicam 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 indicam falha.

Silencia o dispositivo de captura de áudio.

virtual int SetRecordingDeviceMute(bool mute) = 0;

Parâmetros

Valor de retorno

0 indica sucesso; outros valores indicam falha.

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

virtual bool GetRecordingDeviceMute() = 0;

Valor de retorno

Indica 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 indica sucesso; outros valores indicam falha.

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

virtual bool GetPlaybackDeviceMute() = 0;

Valor de retorno

Indica 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.

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 de 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 faixa 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 coletado localmente usando um Equalizador Gráfico. Ao ajustar o ganho (em dB) de uma das 10 faixas de frequência fixas, você personaliza o timbre. É indicado para cenários como otimização de clareza de voz, realce 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 faixas de frequência padrão. O valor de ganho para cada faixa pode ser definido independentemente, variando de [-15, 15] dB, com um 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.

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

Adiciona um fluxo de áudio externo.

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

Este método adiciona um novo fluxo de áudio externo. As etapas são as seguintes:

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 fluxo de áudio externo e obter o ID do fluxo de áudio externo.

2. Chame <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 para o fluxo de áudio criado.

3. Quando a chamada terminar, 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 fluxo de áudio externo.

Para mais informações sobre como publicar áudio coletado personalizado em um canal, consulte Custom audio collection.

Parâmetros

Valor de retorno

Um valor maior que 0 indica uma chamada de método bem-sucedida e retorna o ID do fluxo de áudio externo. Outros valores indicam uma chamada de método com falha.

Insere dados de fluxo de áudio externo.

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

Este método passa dados para o fluxo de áudio especificado. As etapas são as seguintes:

1. Chame 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 fluxo de áudio externo e obter o ID do fluxo de áudio externo.

2. Chame PushExternalAudioStreamRawData para passar dados de áudio para o fluxo de áudio criado.

3. Quando a chamada terminar, chame <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 fluxo de áudio externo.

Para mais informações sobre como publicar áudio coletado personalizado em um canal, consulte Custom audio collection.

Parâmetros

Valor de retorno

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

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

virtual int SetExternalAudioStreamPublishVolume(int streamId, int vol) = 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 volume de reprodução do fluxo de áudio externo.

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

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 volume de publicação do fluxo de áudio externo.

virtual int GetExternalAudioStreamPublishVolume(int streamId) = 0;

Parâmetros

Retornos

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

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

virtual int GetExternalAudioStreamPlayoutVolume(int streamId) = 0;

Parâmetros

Valor de retorno

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

Remove um fluxo de áudio externo.

virtual int RemoveExternalAudioStream(int streamId) = 0;

Este método remove o fluxo de áudio externo correspondente com base no streamId passado. Corresponde ao método AddExternalAudioStream.

Quando chamar

Se você quiser usar o recurso de entrada de áudio personalizada, chame o método AddExternalAudioStream para adicionar um fluxo de áudio e obter o ID do fluxo de áudio externo. Em seguida, chame 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. Quando quiser interromper a entrada de áudio personalizada, chame esta interface para remover o fluxo de áudio externo correspondente e limpar os recursos.

Parâmetros

Valor de retorno

0 indica sucesso; outros valores indicam falha.

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

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

Este é um método assíncrono. Recupere as informações do arquivo de áudio através de AliEngineEventListener::OnAudioFileInfo.

Parâmetros

Valor de retorno

• 0: Sucesso.

• Um 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;

Este é um método assíncrono. Ouça o status do reprodutor de acompanhamento de áudio através de AliEngineEventListener::OnAudioAccompanyStateChanged.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

Para a mixagem de áudio para acompanhamento.

virtual int StopAudioAccompany() = 0;

Valor de retorno

• 0: Sucesso.

• Um 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.

• Um 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.

• Um 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

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

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

virtual int SetAudioAccompanyPlayoutVolume(int volume) = 0;

Parâmetros

Valor de retorno

• 0: Sucesso.

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

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

virtual int GetAudioAccompanyPlayoutVolume() = 0;

Valor de retorno

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

Pausa a mixagem de áudio para acompanhamento.

virtual int PauseAudioAccompany() = 0;

Descrição da resposta

• 0: Sucesso.

• Um 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.

• Um 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

A duração do arquivo de acompanhamento de áudio em milissegundos.

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

virtual int GetAudioAccompanyCurrentPosition() = 0;

Valor de retorno

A posição atual de reprodução do arquivo de acompanhamento de áudio 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.

• Um 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: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

Exclui um arquivo de efeito sonoro pré-carregado.

virtual int UnloadAudioEffect(unsigned int soundId) = 0;

Parâmetros

Valor de retorno

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

Inicia a reprodução de um efeito sonoro.

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

Parâmetros

Retornos

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

Para a reprodução de um efeito sonoro.

virtual int StopAudioEffect(unsigned int soundId) = 0;

Parâmetros

Valor de retorno

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

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

- (int)StopAllAudioEffects;

Valor de retorno

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

Pausa um efeito sonoro.

virtual int PauseAudioEffect(unsigned int soundId) = 0;

Parâmetros

Descrição da Resposta

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

Pausa todos os efeitos sonoros.

virtual int PauseAllAudioEffects() = 0;

Descrição da resposta

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

Retoma a reprodução de um efeito sonoro.

virtual int ResumeAudioEffect(unsigned int soundId) = 0;

Parâmetros

Descrição da resposta

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

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

virtual int ResumeAllAudioEffects() = 0;

Valor de retorno

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

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

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

Parâmetros

Retorno

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

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

virtual int GetAudioEffectPublishVolume(unsigned int soundId) = 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 volume de reprodução local para todos os efeitos sonoros.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 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 volume de reprodução local para um efeito sonoro.

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

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 volume de reprodução local de um efeito sonoro.

virtual int GetAudioEffectPlayoutVolume(unsigned int soundId) = 0;

Parâmetros

Descrição da resposta

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

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

virtual int SetAllAudioEffectsPlayoutVolume(int volume) = 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 volume de publicação para todos os efeitos sonoros.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

Parâmetros

Valor de retorno

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

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 visualização de exibição do stream de vídeo local e define o modo de renderização, o modo de espelhamento e o ângulo de rotação da visualização do usuário local. Isso afeta apenas a pré-visualização do usuário local, não o vídeo publicado. Para definir a visualização de um usuário remoto, chame SetRemoteViewConfig.

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.

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 a direção da câmera e a taxa de quadros de captura.

Quando chamar

Defina isso antes de abrir a câmera. Por exemplo, chame-o antes das seguintes operações:

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

• JoinChannel (entra 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.

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

Chame este método 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: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

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

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

Ao publicar 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: A chamada do método foi bem-sucedida. Outros valores: A chamada do método falhou.

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 anexa a visualização de exibição para um stream de vídeo específico de um usuário remoto e define propriedades para a exibição local da visualização remota, como o modo de renderização, o modo de espelhamento e o ângulo de rotação. Esta ação afeta apenas a imagem de vídeo que o usuário local vê. Para definir a visualização 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>.

• Se o parâmetro view em AliEngineVideoCanvas estiver vazio, a renderização será interrompida.

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

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

Quando chamar

Recomendamos chamar este método ao receber o callback OnRemoteTrackAvailableNotify, momento em que o vídeo do usuário remoto fica disponível.

Parâmetros

Valor de retorno

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

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, bitrate e orientação do vídeo. Recomendamos chamar este método para todos os cenários de vídeo.

Quando chamar

Chame este método 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 chamá-lo antes de entrar no canal.

Limites

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

Parâmetros

Define as propriedades de decodificação de vídeo. Este método configura as propriedades de decodificação de vídeo do stream da câmera, incluindo configurações de decodificação por software e hardware e se deve ativar B-frames.

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

Quando chamar

Recomendamos chamar este método antes de entrar em um canal e puxar um stream.

Parâmetros

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

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

Este método inicia a pré-visualização de vídeo local e liga automaticamente a câmera. Para parar 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 através de SetLocalViewConfig. Caso contrário, não será possível pré-visualizar o vídeo, 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á automaticamente a câmera.

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 fecha a pré-visualização de vídeo local e desliga a câmera. Após parar a pré-visualização, o lado local permanecerá no último quadro, o que não afeta a publicação.

Quando chamar

Para parar 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 os recursos de espelhamento de pré-visualização e publicação.

virtual int setVideoMirrorMode(AliEngineVideoPipelineMirrorMode mirrorMode) = 0;