ApsaraVideo Live:Interface AliRtcEngine

Entra em um canal para conferência multiponto.

public abstract int joinChannel(AliRtcAuthInfo authInfo, String userName);

Este método permite entrar em um canal. O ARTC organiza os usuários em canais. Para publicar ou assinar fluxos de áudio e vídeo, é necessário entrar em um canal. Este método, joinChannel[1/3] e joinChannel[3/3] realizam a entrada no canal, mas diferem quanto ao método de autenticação e às informações de usuário transmitidas:

• O método joinChannel[1/3] é a interface de parâmetro único para entrada em canal. Para entrar, passe um token gerado por meio da Autenticação por token. Recomendamos esta interface para entrada em canais em cenários RTC.

• Esta é uma interface de entrada com múltiplos parâmetros. Requer o fornecimento de um token de entrada com múltiplos parâmetros, gerado pela Autenticação por token, além das informações de usuário utilizadas na geração desse token.

• O método 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 o atributo de usuário capabilityProfile.

Limitações

• Após entrar com sucesso em um canal, caso precise ingressar em outro durante a sessão, chame primeiro <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="e2525ba6a0k3s">leaveChannel</a> para sair do canal atual. Aguarde o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="6aefdfedb0op3">onLeaveChannelResult</a> de AliRtcEngineEventListener antes de tentar entrar em um novo canal.

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

• Aplicativos que utilizam App IDs diferentes não são interoperáveis.

Callbacks relacionados

Após a chamada bem-sucedida deste método, os seguintes callbacks são acionados:

• O resultado da entrada do cliente local no canal é notificado pelo callback AliRtcEngineEventListener <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="fb41cdcfc6acj">onJoinChannelResult</a>.

• Depois que você entra com sucesso em um canal, o lado remoto aciona o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="8e9d69ebe54sr">onRemoteUserOnLineNotify</a>.

Parâmetros

Descrição do Retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Entra em um canal para cenários de interação em tempo real com IA.

public abstract int joinChannel(String token, AliRTCSdkChannelParam channelParam);

Este método permite entrar em um canal. O ARTC organiza os usuários em canais. Para publicar ou assinar fluxos de áudio e vídeo, é necessário entrar em um canal. Este método, joinChannel[1/3] e joinChannel[2/3] realizam a entrada no canal, mas diferem quanto ao método de autenticação e às informações de usuário transmitidas:

• O método joinChannel[1/3] é uma interface de entrada com parâmetro único para cenários RTC. Entre em um canal passando um token gerado por meio da Autenticação por token. Recomendamos o uso desta interface para entrada em canais RTC.

• O método joinChannel[2/3] é uma interface para entrada de múltiplos participantes. Requer a passagem do Token gerado via Autenticação por token para múltiplos participantes, além das informações de usuário usadas na geração do 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 o atributo de usuário capabilityProfile. Defina-o como AliCapabilityProfileAiHuman ao se comunicar com agentes de IA.

Limitações

• Após entrar com sucesso em um canal, caso precise ingressar em outro enquanto ainda estiver conectado, chame primeiro <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="719d580348a95">leaveChannel</a> para sair do canal atual. Aguarde o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="d128acfee2fpd">onLeaveChannelResult</a> de AliRtcEngineEventListener antes de tentar entrar em um novo canal.

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

• Aplicativos que utilizam App IDs diferentes não são interoperáveis.

• Não é necessário invocar o método novamente para tentar reentrar em um canal após falha.

Callbacks relacionados

Após a chamada bem-sucedida deste método, os seguintes callbacks são acionados:

• O resultado da entrada do cliente local no canal é reportado pelo callback AliRtcEngineEventListener <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="879ae2fa04zjd">onJoinChannelResult</a>.

• Depois que você entra com sucesso em um canal, os usuários remotos acionam o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="9b5662c5a0nvf">onRemoteUserOnLineNotify</a>.

Parâmetros

Descrição do Retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Sai de um canal. Após chamar este método, o SDK encerra a comunicação em tempo real e deixa o canal atual.

public abstract int leaveChannel();

Quando chamar

• Use este método quando precisar sair de um canal após ter entrado.

• Se já estiver em um canal e precisar entrar em outro, chame este método primeiro.

Callbacks relacionados

• Lado local: Após a chamada deste método, o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="80f5e30245vfn">onLeaveChannelResult</a> é acionado para notificar o resultado da saída do canal.

• Lado remoto: Após a chamada bem-sucedida desta operação, os usuários remotos acionam o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#75c700a2376c1" id="69bf5ff199oda">onRemoteUserOffLineNotify</a>.

Descrição do Retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Verifica se você está em um canal.

public abstract boolean isInCall();

Descrição do Retorno

O valor true indica que você está em um canal. O valor false indica que você não está em um canal.

Define a função do usuário.

public abstract int setClientRole(AliRTCSdkClientRole clientRole);

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

No modo interativo, antes de entrar em um canal:

• Defina a função como streamer: O SDK ingere automaticamente os fluxos locais de áudio e vídeo e puxa os fluxos de áudio e vídeo de outros streamers.

• Defina a função como espectador: O SDK não ingere os fluxos locais de áudio e vídeo, mas puxa os fluxos de áudio e vídeo de outros streamers.

Quando chamar

É possível chamar este método antes ou depois de entrar em um canal. Você pode definir a função antes da entrada ou alternar entre funções após entrar.

Limitações

Este método funciona apenas no modo interativo, ou seja, quando setChannelProfile está definido como AliRTCSdkInteractiveLive.

Recomendamos definir explicitamente a função do usuário antes de entrar em um canal no modo interativo.

Parâmetros

Consulta a função do usuário.

public abstract AliRTCSdkClientRole getCurrentClientRole();

Descrição do Retorno

Retorna a função atual do usuário.

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

public abstract int refreshAuthInfo(AliRtcAuthInfo authInfo);

Este método atualiza as informações de autenticação. Tokens expiram após um período, impedindo que o SDK se conecte ao servidor.

Quando chamar

Nas seguintes situações:

• Ao receber o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="7e1510bec7s3s">onAuthInfoWillExpire</a> informando que as informações de autenticação estão prestes a expirar, recomendamos regenerar o token no lado do servidor e, em seguida, chamar este método para passar o novo token.

• Caso o Token não seja atualizado a tempo, o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="97664f9e46fhp">onAuthInfoExpired</a> será acionado para notificar que a autenticação expirou. Nesse ponto, é necessário regenerar o Token e chamar joinChannel para reentrar no canal.

Parâmetros

Descrição do Retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

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

public abstract int refreshAuthInfo(String token);

Este método atualiza o token. Tokens expiram após um período, impedindo que o SDK se conecte ao servidor.

Quando chamar

Recomendamos regenerar o token no servidor e chamar este método com o novo token nos seguintes casos:

• Quando o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="d708af68eevs9">onAuthInfoWillExpire</a> informar que as informações de autenticação estão prestes a expirar.

• Caso o Token não seja atualizado a tempo, o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="3fd674e985gl8">onAuthInfoExpired</a> será acionado para notificar que a autenticação expirou. Nesse momento, será necessário chamar joinChannel para reentrar no canal.

Parâmetros

Descrição do retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Permite interromper ou retomar a publicação do fluxo de áudio local.

public abstract int publishLocalAudioStream(boolean enable);

Este método controla a publicação do fluxo de áudio capturado localmente. Por padrão, o SDK publica o fluxo de áudio. Para desativar a publicação, chame publishLocalAudioStream(false) antes de entrar no canal.

Quando chamar

É possível chamar este método antes ou depois de entrar em um canal. Chamá-lo antes da entrada modifica a configuração padrão, tendo efeito imediato ao entrar.

Callbacks relacionados

Quando o status da ingestão do fluxo de áudio local mudar, o cliente local aciona o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b7e3bb51c2ga9" id="4ced92c3f5hmj">onAudioPublishStateChanged</a> para notificar a alteração, e o cliente remoto aciona o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="2b5460d448ga9">onRemoteTrackAvailableNotify</a> para informar que os fluxos de áudio e vídeo do usuário remoto foram alterados.

Parâmetros

Descrição do Retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Consulta se um fluxo de áudio está sendo publicado.

public abstract boolean isLocalAudioStreamPublished();

Instruções de Retorno

O valor true indica que o fluxo de áudio está publicado. O valor false indica que o fluxo de áudio não está publicado.

Define se a assinatura de fluxos de áudio de usuários remotos deve ocorrer por padrão.

public abstract int setDefaultSubscribeAllRemoteAudioStreams(boolean sub);

Este método configura se o sistema deve assinar os fluxos de áudio de usuários remotos por padrão. Essa configuração afeta o comportamento de assinatura de novos usuários que entram no canal. Salvo requisitos específicos, recomendamos definir como true.

Quando chamar

É possível chamar este método antes ou depois de entrar em um canal.

• Antes de entrar:

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

• Após entrar:

  • Para interromper a assinatura padrão, chame setDefaultSubscribeAllRemoteAudioStreams(false). Assim, os fluxos de áudio de novos usuários não serão assinados automaticamente.

  • Após interromper a assinatura padrão, utilize a API subscribeRemoteAudioStream para retomar a assinatura do fluxo de áudio de um usuário específico. Chame-a múltiplas vezes para retomar a assinatura de vários usuários.

  • Ao retomar a assinatura padrão com setDefaultSubscribeAllRemoteAudioStreams(true), apenas os usuários que entrarem após a chamada terão seus fluxos assinados. Usuários remotos que entraram durante o período de interrupção não serão assinados automaticamente.

Parâmetros

Descrição do retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Interrompe ou retoma a recepção do fluxo de áudio de um usuário remoto específico.

public abstract int subscribeRemoteAudioStream(String uid, boolean sub);

Este método interrompe ou retoma a assinatura do fluxo de áudio de um usuário remoto específico. Salvo requisitos específicos, recomendamos definir como true.

Parâmetros

Descrição do retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Define se os fluxos de áudio de todos os usuários remotos devem ser recebidos.

public abstract int subscribeAllRemoteAudioStreams(boolean sub);

Este método atua como chave mestra para a assinatura de fluxos de áudio remotos. Recomendamos defini-lo como true. Se definido como false, ocorrerá o seguinte:

• A assinatura de todos os fluxos de áudio remotos na sessão atual será interrompida.

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

• Não será possível usar <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="a56b5f2a3f56k">subscribeRemoteAudioStream</a> para controlar individualmente o fluxo de áudio de um usuário específico.

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

Parâmetros

Descrição do retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Define se o fluxo da câmera deve ser publicado.

public abstract int publishLocalVideoStream(boolean enable);

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

Quando chamar

É possível chamar este método antes ou depois de entrar em um canal.

Chamá-lo antes da entrada modifica a configuração padrão, tendo efeito imediato ao entrar.

Callbacks relacionados

Quando o status da ingestão do fluxo de vídeo local mudar, o lado local aciona o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#afe6d3c4b1rvg" id="8b70bc353aj68">onVideoPublishStateChanged</a> para notificar o status mais recente da ingestão, e o lado remoto aciona o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="176ee94b46lb7">onRemoteTrackAvailableNotify</a> para informar que os fluxos de áudio e vídeo do usuário remoto foram alterados.

Parâmetros

Descrição do Retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Consulta se um fluxo de câmera está sendo publicado.

public abstract boolean isLocalVideoStreamPublished();

Descrição do Retorno

O valor true indica que o fluxo da câmera está publicado. O valor false indica que o fluxo da câmera não está publicado.

Define se a assinatura de fluxos de vídeo de usuários remotos deve ocorrer por padrão.

public abstract int setDefaultSubscribeAllRemoteVideoStreams(boolean sub);

Este método define se os fluxos de vídeo de usuários remotos devem ser assinados por padrão. O SDK realiza a assinatura por padrão.

Quando chamar

É possível chamar este método antes ou depois de entrar em um canal. Se você chamar setDefaultSubscribeAllRemoteVideoStreams(false) após entrar, não receberá fluxos de vídeo de usuários que entrarem posteriormente.

Após interromper o recebimento de fluxos de vídeo, chame subscribeRemoteVideoStream e especifique o ID do usuário remoto para retomar o recebimento do fluxo de vídeo dele. Para retomar o recebimento de múltiplos usuários, é necessário chamar subscribeRemoteVideoStream várias vezes. O método setDefaultSubscribeAllRemoteVideoStreams(true) retoma o recebimento apenas de usuários que entrarem no canal posteriormente.

Este método define se os fluxos de vídeo de usuários remotos devem ser assinados por padrão.

Parâmetros

Descrição do retorno

O valor 0 indica sucesso. Qualquer outro valor indica falha.

Interrompe ou retoma a assinatura de um fluxo de vídeo remoto específico.

public abstract int subscribeRemoteVideoStream(String uid, AliRtcVideoTrack track, boolean sub);

Assina ou cancela a assinatura do fluxo de vídeo de um usuário especificado.

Quando chamar

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

Parâmetros

Descrição do retorno

• 0: o método foi executado com sucesso.

• Diferente de zero: falha na execução do método.

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

public abstract int subscribeAllRemoteVideoStreams(boolean sub);

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

• A interrupção da assinatura de todos os fluxos de vídeo remotos na sessão atual.

• Novos usuários que entrarem posteriormente não terão seus fluxos assinados (mesmo que você tenha definido setDefaultSubscribeAllRemoteVideoStreams(true) para ativar a assinatura padrão).

• Impossibilidade de usar <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b738a1b498bc1" id="19b0cea8593i5">subscribeRemoteVideoStream</a> para controlar individualmente o fluxo de vídeo de um usuário específico.

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

Parâmetros

Descrição do retorno

O valor 0 indica sucesso. Qualquer outro valor indica falha.

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

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, boolean subVideo, boolean subAudio);

Este método combina a assinatura de fluxos de áudio e vídeo remotos.

Métodos relacionados

Em comparação com <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#4cec275051vr6" id="faff82a053mev">subscribeRemoteMediaStream[2/2]</a>, esta API utiliza dois parâmetros booleanos, subVideo e subAudio, para especificar se os fluxos de áudio e vídeo remotos devem ser assinados. O parâmetro videoTrack controla qual fluxo de vídeo deve ser puxado.

Parâmetros

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica que a chamada falhou.

Interrompe ou retoma a assinatura dos fluxos de áudio e vídeo de um usuário remoto em uma única chamada.

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, AliRtcAudioTrack audioTrack) ;

Esta interface mescla os fluxos de áudio e vídeo remotos assinados.

Métodos relacionados

Diferentemente de subscribeRemoteMediaStream[1/2], este método usa os parâmetros videoTrack e audioTrack para especificar o estado de assinatura desejado em uma única chamada de API. Por exemplo:

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

• Para cancelar a assinatura do fluxo da câmera, mas continuar assinando o fluxo do microfone, defina o parâmetro videoTrack como AliRtcVideoTrackNo e o parâmetro audioTrack como AliRtcAudioTrackMic.

• Para cancelar a assinatura de ambos, defina videoTrack e audioTrack como AliRtcVideoTrackNo e AliRtcAudioTrackNo, respectivamente.

• Para assinar tanto os fluxos da câmera quanto do compartilhamento de tela, defina o parâmetro videoTrack como AliRtcVideoTrackBoth. A mesma lógica se aplica aos fluxos de áudio.

Parâmetros

Descrição do retorno

• 0: sucesso.

• <0: falha.

Assina o fluxo de um usuário específico entre canais.

public abstract int subscribeRemoteDestChannelStream(String channelId, String uid, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica que a chamada do método foi bem-sucedida, enquanto qualquer outro valor indica que a chamada falhou.

Interrompe ou retoma a assinatura dos fluxos de todos os usuários entre canais.

public abstract int subscribeRemoteDestChannelAllStream(String channelId, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Parâmetros

Descrição do retorno

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

• Diferente de zero: falha na chamada do método.

Ajusta o volume de reprodução do fluxo de áudio recebido.

public abstract int setRemoteAudioVolume(String uid, int volume);

Use este método para ajustar o volume de reprodução do fluxo de áudio de um usuário específico no dispositivo local.

Parâmetros

Descrição do retorno

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

• Diferente de zero: falha na chamada do método, por exemplo, devido a um valor de volume inválido.

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

public abstract int muteLocalMic(boolean mute, AliRtcMuteLocalAudioMode mode);

Quando chamar

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

Callbacks relacionados

Após a chamada bem-sucedida, o usuário remoto aciona a notificação <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#ea457055e4izi" id="cce3d390a3xud">onUserAudioMuted</a> para indicar se está silenciado.

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica sucesso. Qualquer outro valor indica falha. Silenciar envia quadros silenciosos, mas a captura e a codificação de áudio continuam em execução.

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

public abstract int muteRemoteAudioPlaying(String uid, boolean mute);

Esta API controla apenas a reprodução do fluxo de áudio de um usuário remoto específico. Ela não afeta o recebimento ou a decodificação do áudio remoto. Para cancelar a assinatura do fluxo de áudio de um usuário, chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="66a2ef0919jjg">subscribeRemoteAudioStream</a>.

Quando chamar

Você pode definir isso antes ou depois de entrar em um canal.

Parâmetros

Descrição do retorno

O valor 0 indica sucesso. Qualquer outro valor indica falha.

Interrompe ou retoma a reprodução de todos os fluxos de áudio remotos.

public abstract int muteAllRemoteAudioPlaying(boolean mute);

Este método interrompe ou retoma todos os fluxos de áudio remotos.

Quando chamar

Você pode definir isso antes ou depois de entrar em um canal.

Parâmetros

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Inicia a captura de áudio.

public abstract int startAudioCapture();

Este método inicia a captura de áudio. Você pode chamá-lo antes de entrar em um canal para ativar a captura de áudio antecipadamente. Se este método não for chamado, o SDK controlará automaticamente o dispositivo de captura de áudio. Você também pode chamar este método para reativar a captura de áudio após chamar stopAudioCapture.

Quando chamar

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

Métodos relacionados

A API <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b71a48f4b84n0" id="4565abdceeq8i">startAudioCapture[2/2]</a> usa parâmetros para controlar se o dispositivo de captura de áudio permanece ativado após você sair de uma reunião.

Callbacks relacionados

Após chamar este método, o callback onLocalAudioStateChanged notifica sobre a alteração no status de captura de áudio local.

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica que a chamada falhou.

Inicia a captura de áudio.

public abstract int startAudioCapture(boolean keepAlive);

Desativa a captura do microfone após silenciar.

Este método inicia a captura de áudio. Você pode chamá-lo antes de entrar em um canal para ativar a captura de áudio antecipadamente. Se você não definir este método, o SDK controlará automaticamente o dispositivo de captura de áudio.

Quando chamar

Este método pode ser chamado 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 ativo após sair de um canal usando o parâmetro keepAlive.

Callbacks relacionados

Após chamar este método para alterar o status de captura de áudio local, você pode obter as alterações de status por meio do callback onLocalAudioStateChanged.

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica sucesso. Qualquer outro valor indica falha.

Interrompe a captura de áudio.

public abstract int stopAudioCapture();

O SDK ativa a captura de áudio por padrão. Quando você inicia uma pré-visualização ou entra em um canal, a captura de áudio começa automaticamente. Chame este método para interromper a captura do dispositivo de áudio.

Callbacks relacionados

Após chamar este método, o SDK aciona o callback onLocalAudioStateChanged para relatar a alteração no status de captura de áudio local.

Descrição do retorno

Um valor de retorno 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica que a chamada falhou.

Define se o dispositivo de saída de áudio padrão é o viva-voz.

public abstract int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

Este método configura o dispositivo de roteamento de áudio padrão antes de você entrar em um canal. Você pode definir a saída padrão como o auricular ou o viva-voz. Por padrão, o SDK usa o viva-voz. Para alterar esse padrão, chame este método antes de entrar em um canal.

O SDK define uma prioridade de roteamento de áudio que alterna automaticamente com base no status atual de conexão de periféricos, da seguinte forma: fone de ouvido com fio > fone de ouvido Bluetooth > configurações do usuário > configurações padrão. Portanto, se nenhum periférico estiver conectado e enableSpeakerphone não estiver definido, o SDK aplicará as configurações padrão.

Configurações de roteamento de áudio.

Dispositivos móveis geralmente suportam dois dispositivos de saída de áudio: o auricular e o viva-voz:

• Quando o áudio é roteado para o auricular, o som é mais baixo e exige segurar o telefone próximo ao ouvido, proporcionando maior privacidade e sendo adequado para chamadas telefônicas.

• Quando o áudio é roteado para o viva-voz, o som é mais alto e permite o uso sem as mãos, sem necessidade de segurar o telefone junto ao ouvido.

Métodos relacionados

Este método modifica a configuração padrão de roteamento de áudio. O método enableSpeakerphone define o dispositivo de roteamento de áudio atual.

Quando chamar

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

Parâmetros

Descrição da resposta

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

• <0: falha na chamada do método.

Define o dispositivo de saída de áudio como o fone de ouvido ou o alto-falante.

public abstract int enableSpeakerphone(boolean enable);

Este método seleciona o dispositivo de reprodução de áudio atual após entrar em um canal, alternando entre o auricular e o alto-falante. Se você não chamar este método, a reprodução usará o dispositivo especificado pela rota de áudio padrão.

O SDK define uma ordem de prioridade predefinida para roteamento de áudio e realiza a troca automática com base no status atual de conexão de periféricos. A ordem de prioridade é a seguinte: fone de ouvido com fio > fone de ouvido Bluetooth > configurações do usuário > configurações padrão. Portanto, quando um periférico está conectado, esta chamada de API não tem efeito. Configurações de roteamento de áudio.

Quando chamar

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

Métodos relacionados

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#d4dab00b21ebx" id="944fb5797e773">setDefaultAudioRoutetoSpeakerphone</a> modifica as configurações padrão de roteamento de áudio e define o dispositivo de roteamento atual.

Parâmetros

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Determina se o dispositivo de saída de áudio atual é o auricular ou o alto-falante.

public abstract boolean isSpeakerOn();

Descrição do retorno

O valor true indica o alto-falante. O valor false indica o auricular.

Ativa o aviso de volume do usuário.

public abstract int enableAudioVolumeIndication(int interval, int smooth, int reportVad);

Este método permite que o SDK relate periodicamente o volume do usuário local e do usuário remoto com o volume atual mais alto. Para usar esse recurso, implemente a classe AliRtcAudioVolumeObserver e chame registerAudioVolumeObserver para registrar o observador.

Quando chamar

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

Callbacks relacionados

Após chamar este método com sucesso, se houver usuários publicando fluxos no canal, o SDK acionará os dois callbacks a seguir em um intervalo especificado:

• O callback AliRtcAudioVolumeObserver#onAudioVolume relata o volume de áudio de cada orador. A frequência deste callback é determinada pelo parâmetro interval.

• Detecção de atividade de voz: quando um orador ativo é detectado, seu ID de usuário (UID) é relatado por meio do callback AliRtcAudioVolumeObserver#onActiveSpeaker.

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica que a chamada do método foi bem-sucedida. Qualquer outro valor indica falha na chamada.

Ativa o monitoramento in-ear.

public abstract int enableEarBack(boolean enable);

Este método ativa ou desativa o monitoramento in-ear. Para obter melhores resultados, ative o monitoramento in-ear ao usar fones de ouvido com fio ou Bluetooth.

Quando chamar

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

Parâmetros

Descrição do retorno

Um valor 0 indica sucesso. Qualquer outro valor indica falha.

Define o volume do monitoramento in-ear.

public abstract int setEarBackVolume(int volume) ;

Este método só tem efeito após a ativação do monitoramento in-ear por meio da chamada de enableEarBack.

Quando chamar

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

Parâmetros

Instruções de retorno

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

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

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

public abstract int startAudioPlayer();

Use este método para ativar a reprodução de áudio antecipadamente. Se você não chamar este método, o SDK ativará automaticamente a reprodução de áudio após a assinatura de um stream de áudio.

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Valor diferente de zero: A chamada falhou e retorna um código de erro.

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

 public abstract int stopAudioPlayer();

Esta interface interrompe a reprodução de áudio e é a contraparte de startAudioPlayer.

Informações de retorno

• 0: A chamada foi bem-sucedida.

• Diferente de zero: A chamada falhou. Um código de erro é retornado.

Define o volume de reprodução local.

public abstract int setPlayoutVolume(int volume);

Parâmetros

Descrição da resposta

• 0: A chamada foi bem-sucedida.

• Valor diferente de zero: A chamada falhou.

Define o volume de gravação.

public abstract int setRecordingVolume(int volume);

Parâmetros

Descrição do retorno

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

• Um código de retorno diferente de zero indica que a chamada falhou.

Reproduz o arquivo de áudio.

public abstract int playAudioFileTest(String filePath) ;

Use este método para reproduzir um arquivo de áudio antes de entrar em um canal, a fim de testar a reprodução de áudio.

Quando chamar

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

Limites de chamada

Chamadas múltiplas substituem as anteriores. Chamar este método interrompe qualquer arquivo em reprodução no momento.

Parâmetros

Descrição do retorno

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

• Um valor diferente de zero indica que a chamada falhou.

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

public abstract int stopAudioFileTest();

Esta interface corresponde à interface playAudioFileTest e interrompe a reprodução do arquivo de áudio.

Limitações

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

Descrição do retorno

• 0: Chamada bem-sucedida.

• Diferente de zero: Chamada falhou.

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

public abstract int startAudioCaptureTest();

Chame este método para testar se o dispositivo de captura de áudio local está funcionando corretamente antes de uma chamada. Após chamar este método, o SDK relata o volume do dispositivo de captura de áudio por meio do callback AliRtcAudioVolumeObserver::OnTestAudioVolume.

Quando chamar

É necessário chamar este método antes de entrar em um canal. Após concluir o teste, chame stopAudioCaptureTest para parar o teste e liberar o dispositivo de áudio.

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Diferente de zero: A chamada falhou. Um código de erro é retornado.

Desativa a detecção de captura de áudio.

public abstract int stopAudioCaptureTest();

Este método interrompe o teste do dispositivo de captura de áudio. Após chamar startAudioCaptureTest, chame este método para parar o teste.

Quando chamar

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

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Valor diferente de zero: A chamada falhou e um código de erro é retornado.

Define o modo de alteração de voz.

public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);

Parâmetros

Descrição do retorno

Um valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Define os parâmetros de ajuste de tom.

public abstract int setAudioEffectPitchValue(double value);

Parâmetros

Descrição do retorno

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

Define o modo de reverberação.

public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);

Parâmetros

Descrição do retorno

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

Define o tipo e os parâmetros para o efeito sonoro de reverberação.

public abstract int setAudioEffectReverbParamType(AliRtcAudioEffectReverbParamType type, float value);

Parâmetros

Descrição do retorno

Um valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Define um modo predefinido de embelezamento de voz.

public abstract int setAudioEffectBeautifyMode(AliRtcAudioEffectBeautifyMode mode);

Este método define um modo predefinido de embelezamento de voz fornecido pelo SDK. É adequado para cenários que exigem qualidade vocal aprimorada, como transmissão ao vivo de voz, karaokê e redes sociais de voz. Ao selecionar um modo de embelezamento de voz, você pode alterar o som da voz humana, tornando-a mais ressonante ou melhorando sua clareza. Isso aprimora a experiência auditiva 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 operação foi bem-sucedida.

• Valor diferente de zero: A operação falhou.

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

public abstract int setAudioEffectEqualizationParam(AliRtcAudioEffectEqualizationBandFrequency bandIndex, float gain);

Este método ajusta o equalizador gráfico para sinais de voz e áudio capturados localmente. Ao ajustar o ganho (em dB) de uma banda de frequência específica, você pode personalizar o som para finalidades como otimizar a clareza da voz, destacar vocais e melhorar a redução de ruído.

O equalizador suporta todo o espectro de áudio de 31 Hz a 16 kHz em 10 bandas padrão. O ganho de cada banda pode ser definido independentemente para um valor de -15 dB a 15 dB. O valor padrão é 0 dB, o que indica nenhuma melhoria ou atenuação.

Limitações

• Ative o modo de embelezamento de voz chamando setAudioEffectBeautifyMode antes de chamar este método.

Parâmetros

Descrição do retorno

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

Valor diferente de zero: A chamada do método falhou.

Adiciona um stream de áudio externo.

public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);

Este método adiciona um stream de áudio externo. Siga estas etapas:

1. Invoque a API <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="20c33a9acb0ui">addExternalAudioStream</a> para adicionar um stream de áudio externo e obter seu ID.

2. Chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="d3deb62b2fl0f">pushExternalAudioStreamRawData</a> para enviar dados de áudio para o stream de áudio externo.

3. Ao encerrar uma chamada, chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="16d826dedcli6">removeExternalAudioStream</a> para remover o stream de áudio externo.

Se desejar publicar captura de áudio personalizada em um canal, consulte Captura de áudio personalizada.

Quando chamar

Descrição do retorno

Um valor de retorno maior que 0 indica uma chamada de método bem-sucedida e representa o ID do stream de áudio externo. Qualquer outro valor indica que a chamada do método falhou.

Insere dados de stream de áudio externo.

public abstract int pushExternalAudioStreamRawData(int streamId, AliRtcAudioFrame rawData);

Use esta interface para enviar dados para um stream de áudio especificado. As etapas são as seguintes:

1. Chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="8822f2932e9ep">addExternalAudioStream</a> para adicionar um stream de áudio externo e obter o ID do stream de áudio externo.

2. Chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="880fe8cd02j10">pushExternalAudioStreamRawData</a> para enviar dados de áudio para o stream de áudio criado.

3. Após o término da chamada, invoque <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="106c7aefa27c0">removeExternalAudioStream</a> para remover o stream de áudio externo.

Para publicar a partir de uma fonte de áudio personalizada, implemente Captura de áudio personalizada.

Quando chamar

Chame este método após entrar em um canal.

Parâmetros

Descrição do retorno

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

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

public abstract int setExternalAudioStreamPublishVolume(int streamId, int publishVolume);

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica que a chamada falhou.

Recupera o volume de ingestão de stream do stream de áudio externo.

public abstract int getExternalAudioStreamPublishVolume(int streamId);

Parâmetros

Descrição do retorno

Volume de ingestão de stream: Os valores válidos são 0 a 100. Um valor menor que 0 indica falha.

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

public abstract int setExternalAudioStreamPlayoutVolume(int streamId, int playoutVolume);

Parâmetros

Descrição do retorno

Um valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica que a chamada falhou.

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

public abstract int getExternalAudioStreamPlayoutVolume(int streamId);

Parâmetros

Descrição da resposta

O volume de reprodução possui valores válidos variando de 0 a 100. Um valor menor que 0 indica falha.

Remove um stream de áudio externo.

public abstract int removeExternalAudioStream(int streamId);

Este método remove o stream de áudio externo que corresponde ao ID de stream especificado. É a contraparte do método addExternalAudioStream.

Quando chamar

Para usar o recurso de entrada de áudio personalizada, primeiro chame o método addExternalAudioStream para adicionar um stream de áudio e obter seu ID de stream. Em seguida, chame o método pushExternalAudioStreamRawData para enviar seus dados de áudio para o SDK. Quando quiser parar de usar a entrada de áudio personalizada, chame este método para remover o stream de áudio e liberar seus recursos.

Parâmetros

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• <0: A chamada falhou. Um código de erro é retornado.

Recupera informações do arquivo de áudio.

public abstract int getAudioFileInfo(String fileName);

Chame esta interface de forma assíncrona para recuperar a duração de um arquivo. Esta é uma interface assíncrona e você pode obter informações do arquivo de áudio usando onAudioFileInfo.

Parâmetros

Retorno à Introdução

• 0: A chamada foi bem-sucedida.

• Diferente de zero: Um código de erro é retornado.

Inicia a mixagem de acompanhamento de áudio.

public abstract int startAudioAccompany(String fileName, AliRtcAudioAccompanyConfig config) ;

Esta interface reproduz arquivos de acompanhamento locais ou online. É uma interface assíncrona. Após chamar esta interface, monitore o status de reprodução do acompanhamento usando AliRtcEngineNotify#onAudioAccompanyStateChanged.

Quando chamar

Chame este método apenas após entrar em um canal.

Limitações

Ao contrário dos efeitos sonoros, apenas um acompanhamento pode ser reproduzido por vez. Chamadas repetidas substituem a reprodução do acompanhamento anterior.

Parâmetros

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Diferente de zero: A chamada falhou e retorna um código de erro.

Define o fone de ouvido ou alto-falante como dispositivo de saída de áudio.

public abstract int stopAudioAccompany() ;

Esta interface é a contraparte de startAudioAccompany e interrompe a reprodução do acompanhamento de áudio.

Quando chamar

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

Descrição da resposta

• 0: A chamada foi bem-sucedida.

• Diferente de zero: A chamada falhou e retorna um código de erro.

Define o volume do acompanhamento de áudio tanto para reprodução local quanto para ingestão de stream.

public abstract int setAudioAccompanyVolume( int volume) ;

Esta API define o volume do acompanhamento de áudio para reprodução local e para publicação. Para definir apenas o volume de reprodução local, use setAudioAccompanyPlayoutVolume. Para definir apenas o volume de publicação, use setAudioAccompanyPublishVolume.

Parâmetros

Descrição da resposta

• 0: A chamada foi bem-sucedida.

• Valor diferente de zero: A chamada falhou e retorna um código de erro.

Define o volume do acompanhamento de áudio para ingestão de stream.

public abstract int setAudioAccompanyPublishVolume(int volume) ;

Parâmetros

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Valor diferente de zero: A chamada falhou. O valor retornado é um código de erro.

Recupera o volume de ingestão do stream de acompanhamento.

public abstract int getAudioAccompanyPublishVolume() ;

Descrição da resposta

Volume de ingestão do stream de música de acompanhamento.

• 0 a 100: Sucesso.

• Outros valores: Código de erro.

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

public abstract int setAudioAccompanyPlayoutVolume(int volume) ;

Parâmetros

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Valor diferente de zero: A chamada falhou e um código de erro é retornado.

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

public abstract int getAudioAccompanyPlayoutVolume() ;

Descrição do retorno

Volume de reprodução local do acompanhamento.

• [0-100]: Sucesso.

• Outros valores: Código de erro.

Pausa a mixagem de acompanhamento.

public abstract int pauseAudioAccompany();

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Diferente de zero: A chamada falhou e retornou um código de erro.

Retoma a mixagem de acompanhamento.

public abstract int resumeAudioAccompany();

Descrição do retorno

• Um valor 0 indica que a chamada foi bem-sucedida.

• Um valor diferente de zero indica que a chamada falhou e retorna um código de erro.

Recupera a duração do arquivo de acompanhamento, em milissegundos.

public abstract int getAudioAccompanyDuration();

Este método recupera a duração do arquivo de acompanhamento atual.

Descrição do retorno

• >= 0: Duração do arquivo de acompanhamento.

• < 0: A chamada falhou e retorna um código de erro.

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

public abstract int getAudioAccompanyCurrentPosition();

Este método obtém o progresso de reprodução do arquivo de acompanhamento atual, em milissegundos.

Descrição da resposta

• Valor maior ou igual a 0: Progresso de reprodução do arquivo de acompanhamento.

• Valor menor que 0: A chamada falhou. Um código de erro é retornado.

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

public abstract int setAudioAccompanyPosition(int posMs);

Este método define o progresso de reprodução do acompanhamento. É útil para recursos como arrastar uma barra de progresso. Após a chamada bem-sucedida deste método, o acompanhamento é reproduzido a partir da posição especificada.

Parâmetros

Descrição do retorno

• 0: A chamada foi bem-sucedida.

• Valor diferente de zero: A chamada falhou. Um código de erro é retornado.

Pré-carrega um efeito sonoro.

public abstract int preloadAudioEffect(int soundId, String filePath);

Parâmetros

Descrição do retorno

Um valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Exclui um arquivo de efeito sonoro pré-carregado.

public abstract int unloadAudioEffect(int soundId);

Parâmetros

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Inicia a reprodução de um efeito sonoro.

public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);

Parâmetros

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Um valor diferente de zero indica que a chamada falhou.

Interrompe a reprodução de um efeito sonoro.

public abstract int stopAudioEffect(int soundId);

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica que a chamada foi bem-sucedida. Um valor diferente de zero indica que a chamada falhou.

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

public abstract int stopAllAudioEffects();

Descrição do Retorno

O valor 0 indica que a chamada foi bem-sucedida. Um valor diferente de zero indica que a chamada falhou.

Define o volume para ingestão de fluxo do efeito sonoro.

public abstract int setAudioEffectPublishVolume(int soundId, int volume);

Parâmetros

Descrição do Retorno

Um valor de retorno 0 indica sucesso. Qualquer outro valor indica falha.

Consulta o volume de ingestão de fluxo do efeito sonoro.

public abstract int getAudioEffectPublishVolume(int soundId);

Parâmetros

Descrição da resposta

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

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

public abstract int setAudioEffectPlayoutVolume(int soundId, int volume);

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Obtém o volume de reprodução local do efeito sonoro em dispositivos Android e iOS.

public abstract int getAudioEffectPlayoutVolume(int soundId);

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica sucesso. Qualquer outro valor indica falha.

Define o volume de mixagem para todos os efeitos sonoros na ingestão de fluxo.

public abstract int setAllAudioEffectsPublishVolume(int volume);

Parâmetros

Descrição do retorno

Um valor de retorno 0 indica sucesso. Qualquer outro valor indica falha.

Define o volume de reprodução local para todos os efeitos sonoros (Android e iOS).

public abstract int setAllAudioEffectsPlayoutVolume(int volume);

Parâmetros

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Inicia a gravação de um arquivo de mídia.

public abstract boolean startRecord(AliRtcRecordType recordType, AliRtcRecordFormat recordFormat, String filePath, AliRtcRecordAudioConfig audioConfig, AliRtcRecordVideoConfig videoConfig, long maxSize, long maxDuration);

Parâmetros

Valor de retorno

Um valor de retorno TRUE indica sucesso. Qualquer outro valor indica falha.

Interrompe a gravação de arquivos de mídia.

  public abstract void stopRecord();

Parâmetros

Nenhum.

Pausa um efeito sonoro.

public abstract int pauseAudioEffect(int soundId);

Parâmetros

Descrição do Retorno

Um valor de retorno 0 indica sucesso. Qualquer outro valor indica falha.

Pausa todos os efeitos sonoros.

public abstract int pauseAllAudioEffects();

Descrição do Retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Retoma a reprodução de um efeito sonoro.

public abstract int resumeAudioEffect(int soundId);

Parâmetros

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

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

public abstract int resumeAllAudioEffects();

Descrição do Retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Cria uma visualização de renderização SurfaceView.

public abstract SophonSurfaceView createRenderSurfaceView(Context context);

É obrigatório chamar este método para exibir visualizações de vídeo em vez de criar um SurfaceView diretamente. Para usar este método:

• Atribua o valor de retorno a AliRtcVideoCanvas#view.

• Chame setLocalViewConfig para definir a visualização de pré-visualização local ou setRemoteViewConfig para definir a visualização de pré-visualização remota.

Momento da chamada

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

Limitações

A chamada deste método deve ser feita na thread principal.

Parâmetros

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

public abstract int setLocalViewConfig(AliRtcVideoCanvas viewConfig, AliRtcVideoTrack track);

Este método define a visualização de pré-visualização local vinculando o fluxo de vídeo local a uma visualização e configurando 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 ingerido. Para definir a visualização da interface do usuário remoto, chame setRemoteViewConfig.

Momento da chamada

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

Parâmetros

Instruções de Retorno

O valor 0 indica sucesso. Qualquer outro valor indica falha.

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

public abstract int setRemoteViewConfig(AliVideoCanvas canvas, String uid,AliRtcVideoTrack track);

Este método vincula a visualização de exibição para o fluxo de vídeo de um usuário remoto específico e configura o modo de renderização, o modo de espelhamento e o ângulo de rotação do vídeo desse usuário quando exibido localmente. Isso afeta apenas o vídeo mostrado ao usuário local. Para configurar a visualização de pré-visualização local, chame setLocalViewConfig.

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

• Para redefinir o parâmetro renderMode de AliRtcVideoCanvas durante a reprodução, modifique o valor de renderMode mantendo todos os outros parâmetros inalterados.

• Para alterar o parâmetro mirrorMode de AliRtcVideoCanvas durante a reprodução, modifique o valor de mirrorMode mantendo os outros parâmetros inalterados.

Momento da chamada

Recomendamos chamar esta função ao receber o callback onRemoteTrackAvailableNotify. A configuração pode ser feita quando o vídeo de um usuário remoto ficar disponível.

Parâmetros

Descrição do Retorno

O valor 0 indica que a chamada foi bem-sucedida, enquanto qualquer outro valor indica falha.

Define as preferências de captura da câmera, como a direção da câmera e a taxa de quadros de captura.

public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);

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

Momento da chamada

A chamada deste método deve ocorrer antes de ligar a câmera, por exemplo, antes de executar as seguintes operações:

• startPreview (inicia a pré-visualização de vídeo)

• joinChannel (entra em um canal)

Parâmetros

Descrição do Retorno

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

Desativa ou reativa a captura de vídeo local.

public abstract int enableLocalVideo(boolean enable);

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, não há dados de vídeo para pré-visualização local ou ingestão de fluxo, 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, tanto a pré-visualização local quanto a ingestão de fluxo remoto permanecerão no último quadro.

Momento da chamada

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

Callbacks relacionados

Uma chamada bem-sucedida a esta API notifica o usuário remoto por meio do callback onUserVideoEnabled.

Parâmetros

Descrição do Retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

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

public abstract int muteLocalCamera(boolean mute, AliRtcVideoTrack track);

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

Parâmetros

Descrição do Retorno

O valor 0 indica que a chamada foi bem-sucedida.

Verifica se a câmera está ligada.

public abstract boolean isCameraOn();

Descrição do Retorno

O valor true indica que a câmera está ligada. O valor false indica que a câmera está desligada.

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

public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);

Este método define as propriedades de codificação de vídeo para o fluxo 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.

Momento da chamada

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 para o fluxo da câmera apenas uma vez por sessão, recomendamos chamar este método antes de entrar no canal.

Limitações

O parâmetro mirrorMode deste método e o método setVideoMirrorMode definem o espelhamento para ingestão de fluxo de vídeo. Recomendamos usar apenas um desses métodos. O uso de ambos pode causar sobreposição de efeitos de espelhamento, levando a falhas ou inconsistências no espelhamento.

Parâmetros

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

    public abstract void setVideoDecoderConfiguration(AliRtcVideoDecoderConfiguration config);

Este método define os parâmetros de vídeo para decodificar um fluxo de vídeo.

Momento da chamada

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

Parâmetros

Alterna entre as câmeras frontal e traseira. A câmera frontal é usada por padrão.

public abstract int switchCamera();

Este método controla se a câmera frontal ou traseira é usada. Por padrão, a câmera frontal é utilizada. É possível alternar dinamicamente entre as câmeras durante a execução do aplicativo, com base nas câmeras disponíveis, sem reiniciar o fluxo de vídeo ou reconfigurar a fonte de vídeo.

Momento da chamada

Este método só pode ser chamado após a câmera ser ativada com sucesso.

Limitações

Este método é suportado apenas no Android e iOS.

Descrição do retorno

O valor 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica que ela falhou.

Obtém a direção atual da câmera.

public abstract AliRTCCameraDirection getCurrentCameraDirection();

Instruções de Retorno

• O valor CAMERA_REAR (0) indica a câmera traseira.

• O valor CAMERA_FRONT (1) indica a câmera frontal.

• O valor CAMERA_INVALID (-1) indica um valor inválido.

Inicia a pré-visualização local.

public abstract int startPreview();

Este método inicia uma pré-visualização de vídeo local e ativa automaticamente a câmera. Para parar a pré-visualização local, chame o método stopPreview.

Momento da invocação

• Defina uma visualização para a pré-visualização local chamando setLocalViewConfig antes da chamada. Caso contrário, a pré-visualização não será exibida, mas a ingestão de fluxo não será afetada.

• Se necessário, chame este método para iniciar a pré-visualização antes de chamar joinChannel. A câmera liga automaticamente.

Descrição do retorno

O valor 0 indica uma chamada bem-sucedida, enquanto qualquer outro valor indica falha.

Interrompe a pré-visualização local.

public abstract int stopPreview();

Este método interrompe a pré-visualização de vídeo local e desliga a câmera. Após a interrupção da pré-visualização, a visualização local exibe o último quadro capturado, e a ingestão de fluxo não é afetada.

Momento da chamada

Este método pode ser chamado após iniciar a pré-visualização local.

Descrição do Retorno

Um valor de retorno 0 indica sucesso. Qualquer outro valor indica falha.

Define a taxa de zoom da câmera.

public abstract int setCameraZoom(float zoom);

Defina o fator de zoom da câmera.

Limitações

Este método está disponível apenas em dispositivos iOS e Android.

Momento da chamada

Esta configuração entra em vigor somente após a ativação da câmera. O zoom é redefinido sempre que a câmera é reiniciada.

Parâmetros

Descrição do Retorno

• 0: chamada bem-sucedida.

• Diferente de zero: a chamada do método falhou.

Obtém o fator de zoom máximo (zoom óptico) suportado pela câmera.

public abstract float GetCameraMaxZoomFactor();

Descrição do Retorno

O fator de zoom máximo suportado pela câmera do dispositivo.

Obtém a configuração atual do fator de zoom da câmera.

public abstract float GetCurrentZoom();

Descrição do Retorno

O fator de zoom atual da câmera do dispositivo.

Define a exposição da câmera.

public abstract int SetExposure(float exposure);

Quando o ambiente de filmagem está muito escuro ou muito claro, a qualidade da captura de vídeo é afetada. Para melhorar a qualidade do vídeo, use este método para ajustar o nível de exposição da câmera. Obtenha o intervalo de níveis de exposição suportados usando GetMinExposure e GetMaxExposure.

Parâmetros

Descrição da resposta

• 0: chamada bem-sucedida.

• Um valor diferente de zero indica falha na chamada do método.

Obtém o nível de exposição da câmera.

public abstract float GetCurrentExposure();

Recupera a configuração atual do nível de exposição da câmera em uso.

Descrição do retorno

O nível de exposição atual da câmera.

Obtém a exposição mínima suportada pela câmera.

public abstract float GetMinExposure();

Descrição do retorno

O nível mínimo de exposição da câmera.

Recupera o nível máximo de exposição suportado pela câmera.

public abstract float GetMaxExposure();

Descrição do Retorno

O nível máximo de exposição da câmera.

Ativa ou desativa o flash da câmera.

public abstract int setCameraFlash(boolean flash);

Habilita ou desabilita o flash.

Limitações

Este método é suportado apenas em iOS e Android.

Parâmetros

Descrição do Retorno

• 0: Configuração aplicada com sucesso.

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

Consulta se o foco manual é suportado no dispositivo atual.

public abstract boolean isCameraFocusPointSupported();

Verifica se a câmera atual permite definir um ponto de foco para ajuste manual.

Limitações

Este método está disponível apenas em iOS e Android.

Descrição da resposta

• true: O dispositivo suporta foco manual.

• false: O dispositivo não suporta foco manual.

Verifica se há suporte para definir o ponto de exposição da câmera.

public abstract boolean isCameraExposurePointSupported();

Determina se é possível definir um ponto de exposição no dispositivo atual.

Limitações

Este método está disponível apenas em iOS e Android.

Descrição do Retorno

• true: É possível definir o ponto de exposição da câmera.

• false: Não é possível definir o ponto de exposição da câmera.

Define o ponto de foco manual da câmera.

public abstract int setCameraFocusPoint(float x, float y);

Estabelece o ponto de foco para a câmera atual. Após chamar esta operação, a câmera ajusta a exposição para o ponto especificado e mantém esse valor de foco. Antes de executar esta operação, recomendamos chamar isCameraFocusPointSupported para verificar se o dispositivo suporta foco manual.

Limitações

Este método está disponível apenas em iOS e Android.

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

Descrição do Retorno

• 0: chamada bem-sucedida.

• Diferente de zero: falha na chamada.

Define o ponto de exposição da câmera.

public abstract int setCameraExposurePoint(float x, float y);

Esta operação configura o ponto de exposição da câmera. Após a chamada, a câmera ajusta a exposição uma única vez para o ponto especificado e mantém esse valor. Recomendamos chamar isCameraExposurePointSupported antes desta operação para confirmar se o dispositivo permite a definição manual do ponto de exposição.

Limitações

Este método está disponível apenas em dispositivos iOS e Android.

Parâmetros

Descrição do Retorno

• 0: Chamada do método bem-sucedida.

• Diferente de zero: Falha na chamada do método.

Verifica se a câmera suporta foco automático facial.

public abstract boolean isCameraAutoFocusFaceModeSupported();

Determina se a câmera oferece suporte ao foco automático em rostos.

Quando chamar

Este método só pode ser chamado após a ativação da câmera. Ele retorna true se a câmera estiver ativada e suportar tanto detecção facial quanto foco automático. Caso contrário, retorna false.

Limitações

Este método está disponível apenas em iOS e Android.

Descrição do retorno

• true: Foco automático facial suportado.

• false: Foco automático facial não suportado.

Configura o foco facial da câmera.

public abstract boolean setCameraAutoFocusFaceModeEnabled(boolean enable);

Esta interface habilita o foco automático em tempo real em rostos humanos. Antes de chamar este método, é obrigatório chamar isCameraAutoFocusFaceModeSupported para verificar se o dispositivo suporta este recurso.

Limitações

Este método está disponível apenas em iOS e Android.

Parâmetros

Descrição do retorno

• true: Chamada bem-sucedida.

• false: Falha na chamada.

Configure o espelhamento de vídeo para pré-visualização e ingestão de stream.

public abstract int setVideoMirrorMode(AliRtcVideoPipelineMirrorMode mirrorMode);

Especifica se o modo de espelhamento deve ser ativado para o vídeo de pré-visualização local e para os streams de vídeo ingeridos.

Quando chamar

É possível definir este método dinamicamente antes ou depois de entrar em um canal. O SDK registra o estado internamente e aplica as operações de vídeo quando a pré-visualização e a codificação (ingestão de stream) estiverem disponíveis.

Limites de Chamada

Este método sobrepõe o parâmetro mirrorMode em setLocalViewConfig e setVideoEncoderConfiguration. Recomendamos utilizar apenas um desses métodos.

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

Descrição da resposta

• 0: A configuração foi aplicada com sucesso.

• <0: Falha nas configurações.

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

Define o momento do redimensionamento na captura de vídeo.

public abstract void setCapturePipelineScaleMode(AliRtcCapturePipelineScaleMode mode);

Determina se o redimensionamento dos dados de captura de vídeo 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, defina o momento do redimensionamento para garantir a consistência entre os dados de pré-visualização e os dados de ingestão de stream.

Quando chamar

Defina este método antes de ativar a câmera. Por exemplo, configure-o antes de iniciar a pré-visualização com startPreview ou antes de entrar em um canal com joinChannel.

Parâmetros

Descrição do Retorno

Nenhum.

Habilita uma fonte de entrada de vídeo externa.

public abstract void setExternalVideoSource(boolean enable,boolean useTexture,
 AliRtcVideoTrack streamType,AliRtcRenderMode renderMode);

Parâmetros

Importa dados de vídeo.

public abstract int pushExternalVideoFrame(AliRtcRawDataFrame aliRawDataFrame,AliRtcVideoTrack streameType);

Parâmetros

Descrição da resposta

Um valor igual a 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Inicia a transmissão ao vivo retransmitida.

public abstract int startPublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Parâmetros

Descrição da resposta

Um valor igual a 0 indica que a chamada foi bem-sucedida. Qualquer outro valor indica falha.

Atualize os parâmetros da transmissão ao vivo por bypass.

public abstract int updatePublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Parâmetros

Instruções de retorno

Um valor igual a 0 indica sucesso. Qualquer outro valor indica falha.

Interrompe o stream ao vivo por bypass.

public abstract int stopPublishLiveStream(String streamUrl);

Parâmetros

Descrição do retorno

Um valor igual a 0 indica sucesso. Qualquer outro valor indica falha.

Recupera o status da transmissão ao vivo por bypass.

public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl);

Parâmetros

Instruções de Retorno

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

Habilite a sondagem de qualidade de rede.

public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config);

Parâmetros

Descrição do retorno

Um valor igual a 0 indica sucesso, enquanto um valor diferente de zero indica falha.

Interrompe o teste de qualidade de rede.

public abstract int stopNetworkQualityProbeTest();

Descrição do Retorno

Um valor igual a 0 indica sucesso. Qualquer outro valor indica falha.

Envie informações de extensão de mídia.

public abstract int sendMediaExtensionMsg(byte[]message, int repeatCount, int delay, boolean isKeyFrame);

O SDK permite enviar e receber mensagens de extensão de mídia. O método de envio utiliza o protocolo de extensão SEI. Os receptores podem obter as mensagens ouvindo o evento onMediaExtensionMsgReceived.

Os casos de uso comuns incluem:

• Utilizar informações de extensão de mídia para transmitir timestamps, calcular a latência de rede ponta a ponta ou sincronizar dados com outras operações de negócio.

• Usar informações de extensão de mídia para transmitir dados descritivos. É possível transmitir até 4 KB de dados, adequado para pequenos volumes de informação. Recomendamos o uso de JSON ou strings simples.

Quando chamar

Este método pode ser chamado após o início da ingestão de stream.

Limitações

O uso de informações de extensão de mídia requer a reutilização do canal de dados de áudio e vídeo. Portanto, controle a frequência de envio das mensagens personalizadas e o tamanho dos dados da mensagem. As limitações são as seguintes:

• É possível enviar até fps mensagens por segundo, conforme especificado no perfil, pois as informações SEI são incorporadas em streams H.264 ou H.265 e exigem codificação de quadros de vídeo para anexar as informações de extensão.

• Para evitar impacto na qualidade da transmissão de dados de mídia, o corpo da mensagem personalizada é limitado a 4 KB, sendo adequado para pequenas quantidades de informação.

• O parâmetro repeatCount na função sendMediaExtensionMsg especifica o nível de redundância das mensagens personalizadas. Se este valor for maior que 1, a mensagem será enviada múltiplas vezes.

• Essa redundância ajuda a prevenir a perda de mensagens causada por perda de pacotes de rede. Nesses casos, outros participantes na sala recebem múltiplas mensagens idênticas e devem realizar a deduplicação.

• Os assinantes na sala também recebem mensagens personalizadas durante a transmissão ao vivo retransmitida.

• Apenas um MediaExtensionMsg é transmitido por vez. Múltiplas chamadas para sendMediaExtensionMsg sobrescrevem os dados previamente enfileirados.

Callbacks relacionados

O receptor do stream pode recuperar as informações de extensão de mídia enviadas pelo originador do stream ouvindo o callback onMediaExtensionMsgReceived.

Parâmetros

Instruções de Retorno

• 0: Chamada bem-sucedida.

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

  • ERR_INNER(-1): Erro interno do SDK. Causas possíveis: O SDK não foi inicializado ou foi chamado após ter sido destruído.

Envia informações de extensão de mídia.

public abstract int sendMediaExtensionMsgEx(byte[]message, int repeatCount, int delay, boolean isKeyFrame, int payloadType);

O SDK fornece um recurso para enviar e receber informações de extensão de mídia. Este método envia tais informações usando o protocolo de extensão SEI. Você pode obtê-las ouvindo o evento onMediaExtensionMsgReceived. Quando payloadType é 5, isso equivale a usar a interface sendMediaExtensionMsg.

Os casos de uso comuns incluem:

• Utilizar informações de extensão de mídia para transmitir timestamps, calcular a latência de rede ponta a ponta ou sincronizar dados com outras operações de negócio.

• Usar informações de extensão de mídia para transmitir dados descritivos. É possível transmitir até 4 KB de dados, adequado para pequenos volumes de informação. Recomendamos o uso de JSON ou strings simples.

Quando chamar

Este método pode ser chamado após o início da ingestão de stream.

Limitações

O uso de informações de extensão de mídia requer a reutilização do canal de dados de áudio e vídeo. Portanto, controle a frequência de envio das mensagens personalizadas e o tamanho dos dados da mensagem. As limitações são as seguintes:

• É possível enviar até fps mensagens por segundo, conforme especificado no perfil, pois as informações SEI são incorporadas em streams H.264 ou H.265 e exigem codificação de quadros de vídeo para anexar as informações de extensão.

• Para evitar degradação na qualidade da transmissão de dados de mídia, o corpo da mensagem personalizada é limitado a 4 KB, sendo adequado para pequenas quantidades de informação.

• O parâmetro repeatCount na função sendMediaExtensionMsg especifica o nível de redundância das mensagens personalizadas. Se este valor for maior que 1, a mensagem será enviada múltiplas vezes.

• Essa redundância ajuda a prevenir a perda de mensagens causada por perda de pacotes de rede. Nesses casos, outros participantes na sala recebem múltiplas mensagens idênticas e devem realizar a deduplicação.

• Os assinantes na sala também recebem mensagens personalizadas durante a transmissão ao vivo retransmitida.

• Apenas um MediaExtensionMsg é transmitido por vez. Múltiplas chamadas para sendMediaExtensionMsg sobrescrevem os dados previamente enfileirados.

Descrição dos parâmetros

Descrição do retorno

• 0: Chamada bem-sucedida.

• <0: Falha na chamada e retorno de um código de erro.

  • ERR_INNER(-1): Ocorreu um erro interno do SDK. As causas possíveis incluem falha na inicialização do SDK ou chamada do SDK após ele ter sido destruído.

Este callback é invocado quando o status da conexão de rede muda. É importante monitorar este callback.

public void onConnectionStatusChange(AliRtcEngine.AliRtcConnectionStatus status,
 AliRtcEngine.AliRtcConnectionStatusChangeReason reason);

Parâmetros

Callback invocado quando ocorre uma exceção no dispositivo local. Preste muita atenção a este callback.

public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg)

Parâmetros

Este callback indica que a autenticação do usuário expirará em 30 segundos. Você deve tratar este callback.

public void onAuthInfoWillExpire();

Este callback sinaliza que as informações de autenticação do usuário expirarão em 30 segundos. Obtenha um novo token e atualize as informações de autenticação usando um dos seguintes métodos:

• Chame <a baseurl="t2309760_v6_4_1.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#975b9af9ecq1a" id="8099ac5a509hn">refreshAuthInfo</a> para atualizar as informações de autenticação.

• Chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="fe88be037dy4g">leaveChannel</a> para sair do canal atual e, em seguida, chame joinChannel para entrar novamente no canal.

Momento de Disparo

O SDK dispara este callback 30 segundos antes da expiração das informações de autenticação do usuário. Ao receber este callback, atualize as informações de autenticação prontamente.

O usuário invoca uma interface que requer autenticação e o servidor retorna informações expiradas.

public void onAuthInfoExpired();

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

• Chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="c3b0cf2f19dgm">leaveChannel</a> para sair do canal atual. Em seguida, chame joinChannel para entrar novamente.

Momento de disparo

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

Este callback retorna o resultado da entrada em um canal.

public void onJoinChannelResult(int result, String channel, String userId, int elapsed);

Parâmetros

Callback que retorna o resultado da saída de um canal.

public void onLeaveChannelResult(int result, AliRtcEngine.AliRtcStats stats);

Condições de disparo

Este callback é acionado quando o aplicativo chama <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="7f3d2133c81tx">leaveChannel</a> com sucesso e o sistema retorna o resultado da saída do canal junto com as informações estatísticas da sessão.

Parâmetros

Callback de desconexão para um usuário remoto.

public void onRemoteUserOffLineNotify(String uid, AliRtcUserOfflineReason reason);

Este callback notifica o usuário local que um usuário remoto saiu do canal porque ficou offline.

Condições de disparo

• Quando um usuário remoto sai ativamente do canal, o callback é acionado.

• Quando um streamer remoto chama <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="4c0adbe948tif">setClientRole</a> para mudar para a função de espectador (chamando AliRtcEngine#setClientRole e definindo a função como AliRTCSdkLive), o callback é acionado.

• Quando um streamer remoto é considerado offline porque nenhum dado foi recebido dele por um longo período, o callback é acionado.

Parâmetros

Este callback é invocado quando um usuário remoto fica online.

public void onRemoteUserOnLineNotify(String uid, int elapsed);

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

Condições de disparo

• Um usuário remoto entra no canal.

• Após o usuário local entrar no canal, este callback é invocado para cada usuário que já está no canal. Isso permite que o usuário local identifique os usuários existentes.

Parâmetros

Este callback é invocado quando os streams de áudio e vídeo de um usuário remoto mudam.

public void onRemoteTrackAvailableNotify(String uid, AliRtcAudioTrack audioTrack,
 AliRtcVideoTrack videoTrack);

Este callback é acionado quando o status de ingestão de stream de um usuário remoto muda. Por meio deste callback, os desenvolvedores podem obter informações em tempo real sobre se os usuários remotos estão ingerindo streams de áudio e vídeo e, consequentemente, exibir ou ocultar as informações de áudio e vídeo desses usuários.

Condições de disparo

Este callback é acionado nos seguintes cenários:

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

• Quando o usuário remoto para de transmitir tanto áudio quanto vídeo.

• No modo interativo, este callback é acionado quando um usuário remoto chama setClientRole para mudar da função de espectador para a função de streamer e configura a ingestão de stream.

Por exemplo, para vídeo, este callback não é acionado se o usuário remoto não realizar a ingestão de stream.

• Quando um usuário remoto começa a ingerir um stream de câmera (status de ingestão: sem stream de vídeo -> apenas stream de câmera), o callback local retorna AliRtcVideoTrackCamera, indicando que o stream de câmera do usuário remoto está disponível.

• Quando um usuário remoto também ingere um stream de compartilhamento de tela (status de ingestão: apenas stream de câmera -> stream de câmera e stream de compartilhamento de tela), o callback local retorna AliRtcVideoTrackBoth, indicando que tanto o stream de câmera quanto o stream de compartilhamento de tela do usuário remoto estão disponíveis.

• Quando um usuário remoto para de ingerir o stream de câmera e mantém apenas o stream de compartilhamento de tela (status de ingestão: stream de câmera e stream de compartilhamento de tela -> apenas stream de compartilhamento de tela), o callback local retorna AliRtcVideoTrackScreen, indicando que apenas o stream de compartilhamento de tela está disponível no momento.

• Quando um usuário remoto para de ingerir o stream de compartilhamento de tela (status de ingestão: apenas stream de compartilhamento de tela -> sem stream de vídeo), o callback local retorna AliRtcVideoTrackNo, indicando que nenhum stream de vídeo está disponível no momento.

Parâmetros