ApsaraVideo Live:Interface AliRtcEngine

Entra em um canal (entrada com múltiplos parâmetros).

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

Esta operação é usada para entrar em um canal. O ARTC usa canais para organizar os usuários, e um usuário deve entrar em um canal para publicar ou assinar streams de áudio e vídeo. Esta operação, junto com joinChannel[1/3] e joinChannel[3/3], pode ser usada para entrar em um canal. As diferenças estão no método de autenticação e nas informações do usuário passadas, conforme detalhado abaixo:

• joinChannel[1/3] é a API de parâmetro único para entrar em um canal. Passe um token gerado para uma entrada com parâmetro único via Token authentication para entrar no canal. Esta API é recomendada para entrar em um canal em cenários de RTC.

• Esta API é uma interface de entrada com múltiplos parâmetros. Passe um token de entrada com múltiplos parâmetros gerado usando Token-based authentication e as informações do usuário que foram usadas para gerar o token.

• joinChannel[3/3] é usado para cenários de IA Conversacional em Tempo Real e exige que você passe um token de entrada com parâmetro único e defina a propriedade do usuário capabilityProfile com base no cenário.

Limites

• Se precisar mudar para outro canal após entrar em um, 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 e 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> do AliRtcEngineEventListener antes de entrar em outro canal.

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

• Aplicativos que usam App IDs diferentes não podem se comunicar entre si.

Callbacks relacionados

Chamar este método com sucesso aciona os seguintes callbacks:

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

• Após entrar com sucesso no canal, o usuário 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

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. Um valor diferente de zero indica falha.

Entra em um canal (entrada com parâmetro único).

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

Esta interface é usada para entrar em um canal. O Alibaba Real-Time Communication (ARTC) utiliza canais para organizar os usuários. Você precisa entrar em um canal para publicar ou assinar fluxos de áudio e vídeo. Esta interface, joinChannel[1/3] e joinChannel[2/3] podem ser usadas para entrar em um canal. As diferenças estão no método de autenticação e nas informações do usuário transmitidas, conforme detalhado abaixo:

• joinChannel[1/3] é a API recomendada para entrar em um canal com um único parâmetro em cenários RTC. Entre em um canal transmitindo um token gerado com Token authentication.

• joinChannel[2/3] é a API para entrar em um canal com vários parâmetros. Para usar esta API, utilize Token authentication para gerar um token de entrada com múltiplos parâmetros e, em seguida, transmita o token gerado junto com as informações do usuário usadas para criá-lo.

• Esta API é voltada para o cenário de IA Conversacional em Tempo Real, em que você transmite o token para entrar em uma sessão como um único parâmetro e define a propriedade de usuário capabilityProfile de acordo com o cenário. Para interagir com um agente de IA, defina esta propriedade como AliCapabilityProfileAiHuman.

Limites

• Se precisar entrar em outro canal após entrar em um com sucesso, 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 entrar em um canal novamente.

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

• Aplicativos que usam App IDs diferentes não podem se comunicar entre si.

• Não é necessário chamar este método novamente se o SDK estiver tentando entrar no canal após uma falha.

Callbacks relacionados

A chamada bem-sucedida deste método aciona os seguintes callbacks:

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

• Após entrar no canal com sucesso, o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="9b5662c5a0nvf">onRemoteUserOnLineNotify</a> é acionado.

Parâmetros

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. Um valor diferente de zero indica falha.

Sai de um canal. Após chamar este método, o SDK encerra a interação de áudio e vídeo em tempo real e sai do canal atual.

public abstract int leaveChannel();

Quando chamar

• Chame este método quando precisar sair do canal após ter entrado nele.

• Se você já entrou em um canal e precisa entrar em outro, chame este método primeiro para sair do canal atual.

Callbacks relacionados

• Cliente local: Após chamar este 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 API, os usuários remotos recebem o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#75c700a2376c1" id="69bf5ff199oda">onRemoteUserOffLineNotify</a>.

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. Um valor diferente de zero indica falha.

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

public abstract boolean isInCall();

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.

public abstract int setClientRole(AliRTCSdkClientRole clientRole);

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

No modo interativo, antes de entrar em um canal:

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

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

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal. Chame-o antes de entrar para definir a função do usuário ou depois de entrar para alterar a função.

Limites

Este método é eficaz apenas no modo interativo, o que significa que você deve chamar o método setChannelProfile para definir o perfil do canal como AliRTCSdkInteractiveLive.

No modo interativo, recomendamos definir explicitamente a função do usuário antes de entrar em uma sessão.

Parâmetros

Obtém a função do usuário.

public abstract AliRTCSdkClientRole getCurrentClientRole();

Valor de 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. Os tokens expiram após um determinado período e o SDK não consegue estabelecer conexão com o servidor após a expiração.

Quando chamar

Nas seguintes situações:

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

• Se você não atualizar o token 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, indicando que a autenticação expirou. Nesse caso, gere o token novamente e chame joinChannel para entrar no canal outra vez.

Parâmetros

Valor de retorno

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

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

public abstract int refreshAuthInfo(String token);

Este método atualiza o token. Os tokens expiram após um determinado período e o SDK não consegue estabelecer conexão com o servidor após a expiração.

Quando chamar

Nas situações a seguir, recomendamos gerar um novo token no servidor e chamar este método para transmitir o novo token:

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

• Se o Token não for atualizado a tempo, isso aciona <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="3fd674e985gl8">onAuthInfoExpired</a>, indicando que a autenticação expirou. Nesse caso, chame joinChannel para entrar no canal novamente.

Parâmetros

Valor de retorno

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

Interrompe ou retoma 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 local. Por padrão, o SDK publica o fluxo de áudio. Para desativar esse comportamento, chame publishLocalAudioStream(false) antes de entrar em uma reunião.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal. Se chamá-lo antes de entrar, a configuração entra em vigor no momento da entrada no canal.

Callbacks relacionados

Quando o estado de ingestão do fluxo de áudio local muda, o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b7e3bb51c2ga9" id="4ced92c3f5hmj">onAudioPublishStateChanged</a> é acionado no cliente local para relatar o estado mais recente da ingestão do fluxo de áudio, e o callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="2b5460d448ga9">onRemoteTrackAvailableNotify</a> é acionado no cliente remoto para relatar que os fluxos de áudio e vídeo do usuário remoto foram alterados.

Parâmetros

Valor de retorno

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

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

public abstract boolean isLocalAudioStreamPublished();

Valor de retorno

true: O fluxo de áudio está sendo publicado. false: O fluxo de áudio não está sendo publicado.

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

public abstract int setDefaultSubscribeAllRemoteAudioStreams(boolean sub);

Este método configura se o sistema assina os fluxos de áudio de usuários remotos por padrão. Essa configuração afeta o comportamento de assinatura de fluxos de áudio dos usuários que entrarem no canal posteriormente. Recomendamos definir como true, a menos que você tenha requisitos específicos.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

• Antes de entrar em um canal:

  • 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 de entrar no canal.

• Depois de entrar em um canal:

  • Para interromper a assinatura padrão, chame setDefaultSubscribeAllRemoteAudioStreams(false). Você não assinará os fluxos de áudio dos usuários que entrarem no canal subsequentemente.

  • Após interromper a assinatura padrão, se quiser retomar a assinatura do fluxo de áudio de um usuário específico, chame o método subscribeRemoteAudioStream. Para retomar a assinatura de vários usuários, chame este método várias vezes.

  • Após interromper a assinatura padrão, chamar setDefaultSubscribeAllRemoteAudioStreams(true) retoma apenas os fluxos de áudio dos usuários que entrarem no canal depois disso. Os fluxos de áudio dos usuários remotos que entraram no canal enquanto a assinatura estava interrompida não serão assinados.

Parâmetros

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. 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. Recomendamos definir como true, a menos que você tenha requisitos específicos.

Parâmetros

Valor de retorno

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

Define se todos os fluxos de áudio remotos devem ser assinados.

public abstract int subscribeAllRemoteAudioStreams(boolean sub);

Este método é o interruptor principal para a assinatura de fluxos de áudio remotos. Recomendamos defini-lo como true. Se você defini-lo como false, ocorrerá o seguinte:

• O SDK interrompe a assinatura de todos os fluxos de áudio remotos na sessão atual.

• Novos usuários que entrarem no canal posteriormente não serão assinados.

• Você não pode 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

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. 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 coletado localmente.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Se chamá-lo antes de entrar, a configuração entra em vigor no momento da entrada no canal.

Callbacks relacionados

Quando o estado de ingestão do fluxo de vídeo local muda, o cliente 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 do fluxo de vídeo, 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="176ee94b46lb7">onRemoteTrackAvailableNotify</a> para notificar alterações no fluxo de áudio e vídeo do usuário remoto.

Parâmetros

Valor de retorno

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

Consulta se o fluxo da câmera está sendo publicado.

public abstract boolean isLocalVideoStreamPublished();

Valor de retorno

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

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

public abstract int setDefaultSubscribeAllRemoteVideoStreams(boolean sub);

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

Quando chamar

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

Após interromper o recebimento dos fluxos de vídeo, se quiser retomar, chame subscribeRemoteVideoStream e especifique o ID do usuário remoto que deseja receber. Para retomar o recebimento de fluxos de vídeo de vários usuários, chame subscribeRemoteVideoStream várias vezes. Chamar setDefaultSubscribeAllRemoteVideoStreams(true) retoma apenas o recebimento dos fluxos de vídeo dos usuários que entrarem no canal depois disso.

Este método define se a assinatura dos fluxos de vídeo de usuários remotos deve ocorrer por padrão.

Parâmetros

Valor de retorno

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

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

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

Você pode chamar 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.

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

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

public abstract int subscribeAllRemoteVideoStreams(boolean sub);

Este método é o interruptor principal para a assinatura de fluxos de vídeo remotos. Se você defini-lo como false, ocorrerá o seguinte:

• O SDK interrompe a assinatura de todos os fluxos de vídeo remotos na sessão atual.

• Novos usuários que entrarem na reunião posteriormente também não serão assinados (mesmo que você defina <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#c90127d90d22o" id="8661e30c89dum">setDefaultSubscribeAllRemoteVideoStreams</a>(true) para assinar por padrão).

• Você não pode 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

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. 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 unifica a assinatura de streams de áudio e vídeo remotos.

Interfaces relacionadas

Ao contrário de <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 os dois parâmetros booleanos subVideo e subAudio para determinar se deve assinar os streams de áudio e vídeo remotos, enquanto o parâmetro videoTrack controla qual stream de vídeo será puxado.

Parâmetros

Valor de retorno

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

Interrompe ou retoma a assinatura dos streams de áudio e vídeo de um usuário remoto.

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

Este método unifica a assinatura de streams de áudio e vídeo remotos.

Interfaces relacionadas

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

• Para assinar os streams da câmera e do microfone, defina videoTrack como AliRtcVideoTrackCamera e audioTrack como AliRtcAudioTrackMic ao fazer a chamada.

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

• Para cancelar ambos, defina videoTrack e audioTrack como AliRtcVideoTrackNo e AliRtcAudioTrackNo, respectivamente, em uma chamada subsequente.

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

Parâmetros

Valor de retorno

• 0: Sucesso.

• <0: Falha.

Assina o stream 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

Valor de retorno

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

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

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

Parâmetros

Valor de retorno

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

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

Ajusta o volume de reprodução de um stream puxado.

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

Com esta interface, o usuário local pode ajustar o volume de reprodução do stream de áudio de um usuário especificado no dispositivo local.

Parâmetros

Valor de retorno

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

• Diferente de zero: A chamada do método falhou. Por exemplo, o valor do volume é inválido.

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

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

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Callbacks relacionados

Após a chamada ser 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 esse usuário está silenciado.

Parâmetros

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. Qualquer outro valor indica falha. O silenciamento envia apenas quadros silenciosos para os dados de áudio. Os módulos de captura e codificação continuam funcionando.

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

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

Esta API é usada apenas para interromper ou retomar a reprodução de áudio de um usuário remoto especificado. Ela não afeta o pull ou a decodificação do stream de áudio remoto. Para cancelar a assinatura do stream 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

Valor de retorno

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

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

public abstract int muteAllRemoteAudioPlaying(boolean mute);

Este método interrompe ou retoma toda a reprodução de áudio remoto.

Quando chamar

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

Parâmetros

Valor de retorno

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

Ativa a captura de áudio.

public abstract int startAudioCapture();

Esta interface é usada para iniciar a captura de áudio. Você pode chamar esta interface antes de entrar em uma reunião para iniciar a captura de áudio antecipadamente. Se você não chamar esta interface, o SDK controla automaticamente o dispositivo de captura de áudio. Para iniciar a captura de áudio novamente após interrompê-la chamando stopAudioCapture, chame esta interface.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Interfaces relacionadas

<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

Depois de chamar este método para alterar o status de captura de áudio local, você pode obter a alteração de status por meio do callback onLocalAudioStateChanged.

Valor de retorno

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

Ativa a captura de áudio.

public abstract int startAudioCapture(boolean keepAlive);

O silenciamento desativa a captura do microfone.

Este método controla a ativação da captura de áudio. Você também pode chamá-lo antes de entrar em um canal para ativar a captura de áudio antecipadamente. Se você não definir isso, o SDK controla automaticamente o dispositivo de captura de áudio.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Interfaces relacionadas

Em comparação com startAudioCapture[1/2], esta API permite usar o parâmetro keepAlive para controlar se o dispositivo de captura permanece ligado após você sair da sessão.

Callbacks relacionados

Depois de chamar este método para alterar o status de captura de áudio local, você pode obter a alteração de status por meio do callback onLocalAudioStateChanged.

Parâmetros

Valor de retorno

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

Desativa a captura de áudio.

public abstract int stopAudioCapture();

O SDK ativa a captura de áudio por padrão. Sem uma configuração especial, ações como iniciar uma pré-visualização ou entrar em um canal iniciam automaticamente a captura de áudio. Para interromper a captura do dispositivo de áudio, chame este método.

Callbacks relacionados

Depois de chamar este método para alterar o status de captura de áudio local, você pode obter a alteração de status por meio do callback onLocalAudioStateChanged.

Valor de retorno

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

Define se a saída de áudio padrão é o alto-falante.

public abstract int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

Este método define o dispositivo de roteamento de áudio padrão antes de entrar em um canal. Você pode escolher a saída padrão para o auricular ou o alto-falante. O SDK usa o alto-falante como padrão. Se quiser alterar essa configuração padrão, chame este método antes de entrar em um canal.

A prioridade de roteamento de áudio é predefinida no SDK e alterna automaticamente com base no status de conexão dos periféricos. A ordem de prioridade é a seguinte: Wired headset > Bluetooth headset > User settings > Default settings. Portanto, se nenhum periférico estiver conectado e a rota de áudio não for definida usando enableSpeakerphone, as configurações padrão serão usadas.

Para mais informações sobre as configurações de roteamento de áudio, consulte Audio routing settings.

Os dispositivos móveis geralmente possuem dois dispositivos de roteamento de áudio: o auricular e o alto-falante.

• Quando a rota de áudio é o auricular, o som é mais baixo e só pode ser ouvido claramente quando o ouvido está próximo. Oferece maior privacidade e é adequado para atender chamadas.

• Quando a rota de áudio é o alto-falante, o som é mais alto e pode ser ouvido sem precisar levar o telefone ao rosto, ativando o recurso "viva-voz".

Interfaces relacionadas

Esta API é usada para modificar as configurações padrão de roteamento de áudio. A API enableSpeakerphone é usada para definir o dispositivo de roteamento atual.

Quando chamar

Você pode chamar 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.

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

Define a saída de áudio para o auricular ou alto-falante.

public abstract int enableSpeakerphone(boolean enable);

Este método define o dispositivo de reprodução de áudio atual após entrar em um canal, escolhendo entre o auricular e o alto-falante. Se esse recurso não for definido, o dispositivo configurado pelo roteamento de áudio padrão será usado para reprodução.

A prioridade de roteamento de áudio é predefinida no SDK e alterna automaticamente com base no status de conexão dos periféricos. A prioridade é a seguinte: Wired headset > Bluetooth headset > User settings > Default settings. Portanto, quando um periférico está conectado, esta chamada de API não tem efeito. Para mais informações sobre as configurações de roteamento de áudio, consulte Audio Routing Settings.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Interfaces relacionadas

<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. Esta API define o dispositivo de roteamento atual.

Parâmetros

Valor de retorno

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

Obtém se a saída de áudio atual é o auricular ou o alto-falante.

public abstract boolean isSpeakerOn();

Valor de retorno

true: Alto-falante. false: Auricular.

Ativa a indicação de volume do usuário.

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

Esta interface permite que o SDK relate periodicamente informações de volume ao seu aplicativo sobre o usuário local que está publicando um stream e o usuário remoto com o maior volume instantâneo. Para usar este recurso, implemente a classe AliRtcAudioVolumeObserver e chame a interface registerAudioVolumeObserver para registrar o objeto receptor.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Callbacks relacionados

Após este método ser chamado com sucesso, se houver usuários publicando no canal, o SDK aciona os dois callbacks a seguir no intervalo de tempo definido:

• O volume de áudio do falante é notificado por meio do callback AliRtcAudioVolumeObserver#onAudioVolume. A frequência do callback é determinada pelo intervalo.

• Detecção de atividade de voz. Quando um usuário ativo é detectado, o uid do falante é retornado por meio do callback AliRtcAudioVolumeObserver#onActiveSpeaker.

Parâmetros

Valor de retorno

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

Ativa o monitoramento in-ear.

public abstract int enableEarBack(boolean enable);

Este método ativa ou desativa o recurso de monitoramento in-ear. Recomendamos ativar o monitoramento in-ear ao usar fones de ouvido (com fio ou Bluetooth) para obter melhores resultados.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

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

Define o volume do monitoramento in-ear.

public abstract int setEarBackVolume(int volume) ;

Este método define o volume do monitoramento in-ear. Ele só entra em vigor após você ativar o recurso de monitoramento in-ear chamando enableEarBack.

Quando chamar

Você pode chamar 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.

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

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

public abstract int startAudioPlayer();

Este método permite controlar a ativação da reprodução de áudio antecipadamente. Se você não definir isso, o SDK ativa automaticamente a reprodução de áudio após a assinatura de um fluxo de áudio.

Valor de retorno

• 0: Sucesso.

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

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

 public abstract int stopAudioPlayer();

Este método interrompe a reprodução de áudio e corresponde a startAudioPlayer.

Valor de retorno

• 0: Sucesso.

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

Define o volume de reprodução local.

public abstract int setPlayoutVolume(int volume);

Parâmetros

Valor de retorno

• 0: Sucesso.

• Diferente de zero: Falha.

Define o volume de gravação.

public abstract int setRecordingVolume(int volume);

Parâmetros

Valor de retorno

• 0: Sucesso.

• Diferente de zero: Falha.

Reproduz um arquivo de áudio.

public abstract int playAudioFileTest(String filePath) ;

Este método reproduz um arquivo de áudio antes de entrar em um canal para testar a reprodução de áudio.

Quando chamar

Você só pode chamar este método antes de entrar em um canal.

Limites

Múltiplas chamadas se substituirão. Uma nova chamada interrompe qualquer arquivo que esteja sendo reproduzido no momento.

Parâmetros

Valor de retorno

• 0: Sucesso.

• Diferente de zero: Falha.

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

public abstract int stopAudioFileTest();

Este método corresponde a playAudioFileTest e interrompe a reprodução do arquivo de áudio.

Limites

Você só pode chamar este método antes de entrar em um canal.

Valor de retorno

• 0: Sucesso.

• Diferente de zero: Falha.

Ativa a detecção do dispositivo de captura de áudio antes de uma chamada.

public abstract int startAudioCaptureTest();

Você pode usar este método para iniciar um teste de captura de áudio e verificar se o seu dispositivo local de captura de áudio está funcionando corretamente antes de uma chamada. Após chamar este método, o SDK relata as informações de volume do dispositivo de captura para você por meio do callback AliRtcAudioVolumeObserver::OnTestAudioVolume.

Quando chamar

Chame este método antes de entrar em um canal. Após a conclusão do teste, certifique-se de chamar stopAudioCaptureTest para interromper a detecção do dispositivo e evitar problemas causados pela ocupação do dispositivo.

Valor de retorno

• 0: Sucesso.

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

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

public abstract int stopAudioCaptureTest();

Este método interrompe a detecção do dispositivo de captura de áudio. Você deve chamar este método para interromper o teste após chamar startAudioCaptureTest.

Quando chamar

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

Valor de retorno

• 0: Sucesso.

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

Define o modo de efeito de modificador de voz.

public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);

Parâmetros

Valor de retorno

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

Define o parâmetro de mudança de tom.

public abstract int setAudioEffectPitchValue(double value);

Parâmetros

Valor de retorno

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

Define o modo de efeito de reverberação.

public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);

Parâmetros

Valor de retorno

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

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

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

Parâmetros

Valor de retorno

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

Define o modo de efeito de embelezamento de voz predefinido.

public abstract int setAudioEffectBeautifyMode(AliRtcAudioEffectBeautifyMode mode);

Este método define alguns modos predefinidos de embelezamento de voz no SDK. É adequado para cenários que precisam de embelezamento de voz, como transmissão ao vivo de voz, karaokê e redes sociais de voz. Ao selecionar diferentes modos de embelezamento, você pode alterar o efeito auditivo da voz humana, como aumentar o magnetismo ou melhorar a clareza, aprimorando assim a experiência de audição para usuários remotos.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

• 0: Sucesso.

• Diferente de zero: Falha.

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

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

Este método ajusta o equalizador gráfico para a voz humana ou sinais de áudio coletados localmente. Ao ajustar o ganho (em dB) de uma das 10 bandas de frequência fixas, você pode personalizar o timbre. É adequado para cenários como otimização de clareza de voz, aprimoramento de voz humana e assistência na redução de ruído.

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

Limites

• Você não pode usar o equalizador antes que o modo de embelezamento seja ativado. Você deve chamar esta interface após chamar setAudioEffectBeautifyMode.

Parâmetros

Valor de retorno

0: Sucesso.

Diferente de zero: Falha.

Adiciona um fluxo de áudio externo.

public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);

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

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

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 fluxo de áudio criado.

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

Para publicar áudio coletado de forma personalizada em um canal, consulte Custom audio collection.

Parâmetros

Valor de retorno

Um valor maior que 0 indica que a chamada do método foi bem-sucedida e corresponde ao ID do fluxo de áudio externo. Qualquer outro valor indica falha.

Insere dados no fluxo de áudio externo.

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

Este método insere dados em um fluxo de áudio especificado. As etapas são as seguintes:

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

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

Para publicar áudio coletado de forma personalizada em um canal, consulte Custom audio collection.

Quando chamar

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

Parâmetros

Valor de retorno

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

Define o volume de ingestão do fluxo de áudio externo.

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

Parâmetros

Valor de retorno

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

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

public abstract int getExternalAudioStreamPublishVolume(int streamId);

Parâmetros

Valor de retorno

[0, 100] Volume de ingestão. < 0: Falha.

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

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

Parâmetros

Valor de retorno

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

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

public abstract int getExternalAudioStreamPlayoutVolume(int streamId);

Parâmetros

Valor de retorno

[0, 100] Volume de reprodução. < 0 indica falha.

Exclui um fluxo de áudio externo.

public abstract int removeExternalAudioStream(int streamId);

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

Quando chamar

Se você quiser usar o recurso de entrada de áudio personalizada, precisará chamar o método addExternalAudioStream para adicionar um fluxo de áudio e obter o ID do fluxo de áudio externo. Em seguida, chame o método pushExternalAudioStreamRawData para inserir seus dados de áudio no SDK. Quando quiser interromper a entrada de áudio personalizada, chame este método para remover o fluxo de áudio externo correspondente e limpar os recursos.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

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

public abstract int getAudioFileInfo(String fileName);

Você pode chamar esta API assíncrona para obter as informações de duração de um arquivo. Você pode obter as informações do arquivo de áudio por meio de onAudioFileInfo.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

Inicia a mixagem de acompanhamento.

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

Este método reproduz um arquivo de acompanhamento local ou online. É um método assíncrono. Após chamar este método, você pode ouvir o status de reprodução do acompanhamento por meio de AliRtcEngineNotify#onAudioAccompanyStateChanged.

Quando chamar

Você pode chamar este método após entrar em um canal.

Limites

Diferente dos efeitos sonoros, apenas um acompanhamento pode ser reproduzido por vez. Chamadas repetidas substituirão a reprodução do acompanhamento anterior.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

Interrompe a mixagem de acompanhamento.

public abstract int stopAudioAccompany() ;

Este método corresponde a startAudioAccompany e interrompe a reprodução do acompanhamento.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Valor de retorno

• 0: Sucesso.

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

Define o volume do acompanhamento, incluindo o volume de reprodução local e o volume de ingestão.

public abstract int setAudioAccompanyVolume( int volume) ;

Este método define o volume do acompanhamento tanto para a reprodução local quanto para a ingestão de fluxo. Além disso, setAudioAccompanyPlayoutVolume e setAudioAccompanyPublishVolume definem apenas o volume de reprodução local e o volume de ingestão do fluxo de acompanhamento, respectivamente.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

Define o volume de ingestão do acompanhamento.

public abstract int setAudioAccompanyPublishVolume(int volume) ;

Parâmetros

Valor de retorno

• 0: Sucesso.

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

Obtém o volume de ingestão do acompanhamento.

public abstract int getAudioAccompanyPublishVolume() ;

Valor de retorno

O volume de ingestão da música de acompanhamento.

• [0-100]: Sucesso.

• Outro: Código de erro.

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

public abstract int setAudioAccompanyPlayoutVolume(int volume) ;

Parâmetros

Valor de retorno

• 0: Sucesso.

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

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

public abstract int getAudioAccompanyPlayoutVolume() ;

Valor de retorno

O volume de reprodução local da música de acompanhamento.

• [0-100]: Sucesso.

• Outro: Código de erro.

Pausa a mixagem de acompanhamento.

public abstract int pauseAudioAccompany();

Valor de retorno

• 0: Sucesso.

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

Retoma a mixagem de acompanhamento.

public abstract int resumeAudioAccompany();

Valor de retorno

• 0: Sucesso.

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

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

public abstract int getAudioAccompanyDuration();

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

Valor de retorno

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

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

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.

Valor de retorno

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

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

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

public abstract int setAudioAccompanyPosition(int posMs);

Este método define ativamente o progresso de reprodução do acompanhamento, para recursos como arrastar uma barra de progresso. Após a chamada bem-sucedida deste método, o arquivo de acompanhamento será reproduzido a partir da posição posMs correspondente.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

Pré-carrega um arquivo de efeito sonoro.

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

Parâmetros

Valor de retorno

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

Exclui um arquivo de efeito sonoro pré-carregado.

public abstract int unloadAudioEffect(int soundId);

Parâmetros

Valor de retorno

0 indica que a chamada do método 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

Valor de retorno

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

Interrompe a reprodução de um efeito sonoro.

public abstract int stopAudioEffect(int soundId);

Parâmetros

Valor de retorno

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

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

public abstract int stopAllAudioEffects();

Valor de retorno

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

Define o volume de mixagem de ingestão do efeito sonoro.

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

Parâmetros

Valor de retorno

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

Obtém o volume do efeito sonoro de ingestão.

public abstract int getAudioEffectPublishVolume(int soundId);

Parâmetros

Valor de retorno

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

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

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

Parâmetros

Valor de retorno

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

Obtém o volume de reprodução local para um efeito sonoro (Android e iOS).

public abstract int getAudioEffectPlayoutVolume(int soundId);

Parâmetros

Valor de retorno

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

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

public abstract int setAllAudioEffectsPublishVolume(int volume);

Parâmetros

Valor de retorno

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

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

public abstract int setAllAudioEffectsPlayoutVolume(int volume);

Parâmetros

Valor de retorno

0 indica que a chamada do método foi bem-sucedida. Qualquer outro valor indica uma 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

TRUE: Sucesso. Outro: Falha.

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

  public abstract void stopRecord();

Parâmetros

Nenhum.

Pausa um efeito sonoro.

public abstract int pauseAudioEffect(int soundId);

Parâmetros

Valor de retorno

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

Pausa todos os efeitos sonoros.

public abstract int pauseAllAudioEffects();

Valor de retorno

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

Retoma a reprodução de um efeito sonoro.

public abstract int resumeAudioEffect(int soundId);

Parâmetros

Valor de retorno

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

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

public abstract int resumeAllAudioEffects();

Valor de retorno

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

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

public abstract SophonSurfaceView createRenderSurfaceView(Context context);

Você deve chamar este método para exibir a visualização de vídeo, em vez de criar um SurfaceView diretamente. O método de chamada é o seguinte:

• Atribua o valor de retorno a AliRtcVideoCanvas#view.

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

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Limites

Chame este método 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 é usado para definir a visualização da pré-visualização local. Chamar este método anexa a janela de exibição (view) para o stream de vídeo local e define parâmetros para a visualização do usuário local, como o modo de renderização, modo de espelhamento e ângulo de rotação. Isso afeta apenas a tela de pré-visualização do usuário local e não afeta o stream de vídeo ingerido. Para definir a visualização da interface do usuário remoto, chame setRemoteViewConfig.

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Parâmetros

Valor de retorno

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

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

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

Este método anexa uma visualização de exibição a um stream de vídeo especificado de um usuário remoto e define as configurações de exibição para a visualização remota, como o modo de renderização, modo de espelhamento e ângulo de rotação. Isso afeta apenas a imagem de vídeo que o usuário local vê. Para definir a visualização da pré-visualização local, chame setLocalViewConfig.

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

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

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

Quando chamar

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

Parâmetros

Valor de retorno

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

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

public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);

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

Você deve definir isso antes de ligar a câmera. Por exemplo, chame-o antes das seguintes operações:

• startPreview (iniciar pré-visualização)

• joinChannel (entrar no canal)

Parâmetros

Valor de retorno

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

Desativa ou reativa a coleta de vídeo local.

public abstract int enableLocalVideo(boolean enable);

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

Quando chamar

Você pode chamar este método antes ou depois de entrar em um canal.

Callbacks relacionados

Após a chamada bem-sucedida deste método, o usuário remoto é notificado por meio do callback onUserVideoEnabled.

Parâmetros

Valor de retorno

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

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

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

Ao publicar um stream, você pode chamar este método para publicar quadros de vídeo totalmente pretos. A pré-visualização local permanece normal, e os módulos de coleta, codificação e envio continuam a funcionar, mas o conteúdo do vídeo são quadros pretos.

Parâmetros

Valor de retorno

0 indica que a chamada do método foi bem-sucedida.

Verifica se a câmera está ligada.

public abstract boolean isCameraOn();

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.

public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);

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

Quando chamar

Você pode chamar 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

Tanto o mirrorMode deste método quanto o setVideoMirrorMode podem definir o espelhamento de publicação de vídeo. Recomendamos usar apenas um. O uso de vários métodos ao mesmo tempo pode fazer com que os efeitos de espelhamento se acumulem, levando a uma configuração de espelhamento com falha ou incorreta.

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 as propriedades de decodificação do stream de vídeo.

Quando chamar

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 alterna entre as câmeras frontal e traseira. A câmera frontal é usada por padrão. Você pode alternar dinamicamente as câmeras durante a execução do aplicativo com base nas câmeras disponíveis, sem reiniciar o stream de vídeo ou reconfigurar a fonte de vídeo.

Quando chamar

Chame este método após a câmera ser ligada com sucesso.

Limites

Isso está disponível apenas no Android e iOS.

Valor de retorno

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

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

public abstract AliRTCCameraDirection getCurrentCameraDirection();

Valor de retorno

• Retorna CAMERA_REAR(0) para a câmera traseira.

• Retorna CAMERA_FRONT(1) para a câmera frontal.

• Retorna CAMERA_INVALID(-1) para inválido.

Inicia a pré-visualização local.

public abstract int startPreview();

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

Quando chamar

• Antes de chamar este método, você precisa definir a visualização para a pré-visualização local chamando setLocalViewConfig. Caso contrário, a pré-visualização não será exibida, mas isso não afetará a publicação.

• Se necessário, você pode chamar este método para iniciar a pré-visualização antes de entrar em um canal com joinChannel. A câmera será ligada automaticamente.

Valor de retorno

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

Interrompe a pré-visualização local.

public abstract int stopPreview();

Este método fecha a pré-visualização de vídeo local e desliga a câmera. Após interromper a pré-visualização, a extremidade local permanecerá no último quadro, o que não afeta a publicação.

Quando chamar

Para fechar a pré-visualização após iniciá-la, você pode chamar este método.

Valor de retorno

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

Define a taxa de zoom da câmera.

public abstract int setCameraZoom(float zoom);

Define a taxa de zoom da câmera.

Limites

Apenas iOS e Android fornecem esta interface.

Quando chamar

Esta configuração é efetiva apenas após a câmera ser ligada. O zoom é redefinido cada vez que a câmera é reiniciada.

Parâmetros

Valor de retorno

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

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

Obtém a taxa máxima de zoom suportada pela câmera.

public abstract float GetCameraMaxZoomFactor();

Valor de retorno

A taxa máxima de zoom suportada pela câmera do dispositivo.

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

public abstract float GetCurrentZoom();

Valor de retorno

A taxa de zoom atual da câmera do dispositivo.

Define a exposição da câmera.

public abstract int SetExposure(float exposure);

Quando a luz ambiente é insuficiente ou muito forte, isso afeta a qualidade da captura de vídeo. Para obter uma melhor qualidade de vídeo, você pode usar este método para ajustar a exposição da câmera em uso. Você pode obter o intervalo de exposição suportado pelo dispositivo atual chamando GetMinExposure e GetMaxExposure.

Parâmetros

Valor de retorno

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

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

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

public abstract float GetCurrentExposure();

Obtém a configuração de exposição da câmera atualmente em uso.

Valor de retorno

A exposição atual da câmera.

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

public abstract float GetMinExposure();

Valor de retorno

A exposição mínima da câmera.

Obtém a exposição máxima suportada pela câmera.

public abstract float GetMaxExposure();

Valor de retorno

A exposição máxima da câmera.

Define o flash da câmera como ligado ou desligado.

public abstract int setCameraFlash(boolean flash);

Liga ou desliga o flash.

Limites

Apenas iOS e Android fornecem esta interface.

Parâmetros

Valor de retorno

• 0: Sucesso.

• Diferente de zero: Falha.

Verifica se o dispositivo atual suporta foco manual.

public abstract boolean isCameraFocusPointSupported();

Verifica se a câmera atual pode definir um ponto de foco para suportar o recurso de foco manual.

Limites

Apenas iOS e Android fornecem esta interface.

Valor de retorno

• true: O dispositivo suporta o recurso de foco manual.

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

Verifica se a configuração do ponto de exposição da câmera é suportada.

public abstract boolean isCameraExposurePointSupported();

Verifica se o dispositivo atual oferece suporte à definição de um ponto de exposição.

Limites

Apenas iOS e Android oferecem essa interface.

Valor de retorno

• true: Há suporte para a definição do ponto de exposição da câmera.

• false: Não há suporte para a definição do ponto de exposição da câmera.

Define o ponto de foco manual da câmera.

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

Define o ponto de foco da câmera atual. Após chamar este método, a câmera realiza um ajuste único de exposição no ponto definido e, em seguida, mantém esse valor de foco. Antes de chamar este método, recomendamos chamar isCameraFocusPointSupported para verificar se o dispositivo oferece suporte ao recurso de foco manual.

Limites

Apenas iOS e Android oferecem essa interface.

Parâmetros

Valor de retorno

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

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

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

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

Define o ponto de exposição da câmera. Após a chamada deste método, a câmera realiza um ajuste único de exposição no ponto definido e mantém esse valor de exposição. Antes de chamar este método, recomendamos chamar isCameraExposurePointSupported para verificar se o dispositivo oferece suporte ao recurso de foco manual.

Limites

Apenas iOS e Android oferecem essa interface.

Parâmetros

Valor de retorno

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

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

Verifica se há suporte para o foco automático facial da câmera.

public abstract boolean isCameraAutoFocusFaceModeSupported();

Verifica se há suporte para o foco automático facial da câmera.

Quando chamar

Isso só é eficaz após a câmera ser ligada. Se a câmera não estiver ligada quando você chamar este método, ele retornará false por padrão. Se a câmera estiver ligada e oferecer suporte às funções de reconhecimento facial e foco, ele retornará true.

Limites

Apenas iOS e Android oferecem essa interface.

Valor de retorno

• true: Há suporte para o foco automático facial.

• false: Não há suporte para o foco automático facial.

Define o foco facial da câmera.

public abstract boolean setCameraAutoFocusFaceModeEnabled(boolean enable);

Chame este método para configurar a câmera para focar em rostos em tempo real. Antes de chamar este método, chame isCameraAutoFocusFaceModeSupported para verificar se o dispositivo oferece suporte a este recurso.

Limites

Apenas iOS e Android oferecem essa interface.

Parâmetros

Valor de retorno

• true: A chamada foi bem-sucedida.

• false: A chamada falhou.

Define a capacidade de espelhamento de vídeo para visualização e ingestão.

public abstract int setVideoMirrorMode(AliRtcVideoPipelineMirrorMode mirrorMode);

Define se o modo espelho será ativado para o vídeo de visualização local e para o stream de vídeo publicado.

Quando chamar

Você pode definir este método dinamicamente antes e depois de entrar em um canal. O SDK registra o status e executa a operação de vídeo quando pode operar na visualização e na codificação (publicação).

Limites

Este método se sobrepõe ao mirrorMode em setLocalViewConfig&setVideoEncoderConfiguration. Recomendamos usar apenas um método.

Parâmetros

Valor de retorno

• 0: Sucesso.

• <0: Falha.

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

Define o momento do dimensionamento da captura de vídeo.

public abstract void setCapturePipelineScaleMode(AliRtcCapturePipelineScaleMode mode);

Define se o dimensionamento da captura de dados de vídeo ocorre imediatamente após a captura ou apenas durante a codificação. Por exemplo, quando a resolução de captura e a resolução de codificação são inconsistentes, você pode definir o momento do dimensionamento para determinar se os dados de visualização e os dados publicados são consistentes.

Quando chamar

Chame este método antes de ligar a câmera, por exemplo, antes de iniciar uma visualização com startPreview ou entrar em um canal com joinChannel.

Parâmetros

Valor de retorno

Nenhum.

Ativa uma source de entrada de vídeo externa.

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

Parâmetros

Insere dados de vídeo.

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

Parâmetros

Valor de retorno

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

Inicia a transmissão ao vivo por bypass.

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

Parâmetros

Valor de retorno

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

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

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

Parâmetros

Valor de retorno

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

Interrompe a transmissão ao vivo por bypass.

public abstract int stopPublishLiveStream(String streamUrl);

Parâmetros

Valor de retorno

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

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

public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl);

Parâmetros

Valor de retorno

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

Inicia uma sondagem de qualidade de rede.

public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config);

Parâmetros

Valor de retorno

0: Sucesso. Outro: Falha.

Interrompe uma sondagem de qualidade de rede.

public abstract int stopNetworkQualityProbeTest();

Valor de retorno

0: Sucesso. Outro: Falha.

Envia uma mensagem de extensão de mídia.

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

O SDK oferece a funcionalidade de enviar e receber mensagens de extensão de mídia. Este método envia mensagens de extensão de mídia usando o protocolo de extensão SEI. Os receptores podem obter as mensagens ouvindo onMediaExtensionMsgReceived.

Os cenários comuns incluem o seguinte:

• Uso de mensagens de extensão de mídia para transmitir carimbos de data/hora a fim de calcular a latência de rede de ponta a ponta ou sincronizar dados com outros services de negócios.

• Uso de mensagens de extensão de mídia para transmitir informações descritivas. Atualmente, até 4 KB de dados podem ser transmitidos, o que pode ser usado para transferir pequenas quantidades de dados. Recomendamos usar JSON ou strings simples.

Quando chamar

Chame este método após iniciar a publicação de um stream.

Limites

Ao usar mensagens de extensão de mídia, os canais de dados de áudio e vídeo são reutilizados. Portanto, você deve controlar a frequência de envio e o comprimento dos dados da mensagem. Os limites são os seguintes:

• Você pode enviar no máximo fps mensagens por segundo, conforme definido no perfil. As informações SEI são transmitidas no stream H.264/H.265, e as informações de extensão só podem ser anexadas quando houver codificação de frame de vídeo.

• Para evitar afetar a qualidade da transmissão de dados de mídia, o corpo da mensagem personalizada é limitado a 4 KB. Pode ser usado para transmitir pequenas quantidades de informações.

• O parâmetro repeatCount na função sendMediaExtensionMsg é a redundância da mensagem personalizada. Se for maior que 1, a mensagem será enviada várias vezes.

• Para evitar a perda de mensagens devido à perda de pacotes de rede, outras pessoas no canal também receberão a mesma mensagem várias vezes e precisarão remover as duplicatas.

• Quando mensagens personalizadas são enviadas, os assinantes no canal também as receberão durante a transmissão ao vivo por bypass.

• Apenas um MediaExtensionMsg pode ser transmitido por vez. Se você chamar sendMediaExtensionMsg várias vezes, os novos dados substituirão os dados anteriores.

Callbacks relacionados

Após a extremidade de publicação enviar uma mensagem de extensão de mídia, a extremidade de recepção pode obter a mensagem ouvindo o callback onMediaExtensionMsgReceived.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

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

Envia uma mensagem de extensão de mídia.

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

O SDK oferece recursos para enviar e receber mensagens de extensão de mídia. Este método envia uma mensagem de extensão de mídia usando o protocolo de extensão SEI. O receptor pode obter a mensagem ouvindo onMediaExtensionMsgReceived. Quando payloadType é 5, isso equivale a usar o método sendMediaExtensionMsg.

Os cenários comuns incluem o seguinte:

• Uso de mensagens de extensão de mídia para transmitir carimbos de data/hora a fim de calcular a latência de rede de ponta a ponta ou sincronizar dados com outros services de negócios.

• Uso de mensagens de extensão de mídia para transmitir informações descritivas. Atualmente, até 4 KB de dados podem ser transmitidos, o que pode ser usado para transferir pequenas quantidades de dados. Recomendamos usar JSON ou strings simples.

Quando chamar

Chame este método após iniciar a publicação de um stream.

Limites

Ao usar mensagens de extensão de mídia, os canais de dados de áudio e vídeo são reutilizados. Portanto, você deve controlar a frequência de envio e o comprimento dos dados da mensagem. Os limites são os seguintes:

• Você pode enviar no máximo fps mensagens por segundo, conforme definido no perfil. As informações SEI são transmitidas no stream H.264/H.265, e as informações de extensão só podem ser anexadas quando houver codificação de frame de vídeo.

• Para evitar afetar a qualidade da transmissão de dados de mídia, o corpo da mensagem personalizada é limitado a 4 KB. Pode ser usado para transmitir pequenas quantidades de informações.

• O parâmetro repeatCount na função sendMediaExtensionMsg é a redundância da mensagem personalizada. Se for maior que 1, a mensagem será enviada várias vezes.

• Para evitar a perda de mensagens devido à perda de pacotes de rede, outras pessoas no canal também receberão a mesma mensagem várias vezes e precisarão remover as duplicatas.

• Quando mensagens personalizadas são enviadas, os assinantes no canal também as receberão durante a transmissão ao vivo por bypass.

• Apenas um MediaExtensionMsg pode ser transmitido por vez. Se você chamar sendMediaExtensionMsg várias vezes, os novos dados substituirão os dados anteriores.

Parâmetros

Valor de retorno

• 0: Sucesso.

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

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

Callback para alterações no status de conexão de rede. Você precisa lidar com este callback.

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

Parâmetros

Callback para exceções de dispositivo local. Você precisa lidar com este callback.

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

Parâmetros

Notificação de que as informações de autenticação do usuário estão prestes a expirar. A autenticação expira 30 segundos após o recebimento deste callback. Você precisa lidar com este callback.

public void onAuthInfoWillExpire();

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

• Chame <a baseurl="t2309760_v6_4_1.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#975b9af9ecq1a" id="8099ac5a509hn">refreshAuthInfo</a> e atualize 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.

Quando é acionado

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

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

public void onAuthInfoExpired();

Este callback indica que as informações de autenticação do usuário expiraram. Se você quiser continuar na sessão, gere um novo token no servidor e, em seguida, atualize as informações de autenticação da seguinte forma:

• 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 e, em seguida, chame joinChannel para entrar novamente no canal.

Quando é acionado

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

Callback para o resultado da entrada em um canal.

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

Parâmetros

Callback para o resultado da saída de um canal.

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

Condição de acionamento

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 para sair do canal, este callback é acionado e retorna o resultado da saída do canal e as estatísticas desta sessão do canal.

Parâmetros

Callback para quando um usuário remoto fica offline.

public void onRemoteUserOffLineNotify(String uid, AliRtcUserOfflineReason reason);

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

Condição de acionamento

• O callback é acionado quando um usuário remoto sai ativamente do canal.

• 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 para definir a função como AliRTCSdkLive), um callback é acionado.

• O callback é acionado quando nenhum dado é recebido do streamer remoto por um longo período e o usuário é considerado desconectado.

Parâmetros

Callback para quando um usuário remoto fica online.

public void onRemoteUserOnLineNotify(String uid, int elapsed);

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

Condição de acionamento

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

• Após o usuário atual entrar no canal, ele recebe um callback de entrada para os usuários que já estão no canal, que é usado para exibir os usuários que entraram anteriormente.

Parâmetros

Callback para quando o stream de áudio ou vídeo de um usuário remoto muda.

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

Este callback é acionado quando o status de publicação de um usuário remoto muda. Com este callback, você pode saber em tempo real se um usuário remoto está publicando streams de áudio e vídeo e exibir ou ocultar as informações de áudio e vídeo do usuário remoto na interface de acordo.

Condição de acionamento

Este callback é acionado nos seguintes cenários:

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

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

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

Tome o vídeo como exemplo. Suponha que o usuário remoto esteja definido para não publicar. Este callback não é acionado.

• Se um usuário remoto começar a enviar um stream de câmera (Status de ingestão de stream: sem stream de vídeo -> apenas stream de câmera), o callback no cliente local retorna AliRtcVideoTrackCamera para indicar que o stream de câmera do usuário remoto está disponível.

• Se o usuário remoto também enviar um stream de compartilhamento de tela (Status de ingestão de stream: Apenas stream de câmera -> Stream de câmera e stream de compartilhamento de tela), a extremidade local recebe o callback AliRtcVideoTrackBoth, indicando que tanto o stream de câmera quanto o de compartilhamento de tela do usuário remoto estão disponíveis.

• Se o usuário remoto parar de enviar o stream de câmera e mantiver apenas o stream de compartilhamento de tela (Estado de ingestão de stream: Streams de câmera e compartilhamento de tela -> Apenas stream de compartilhamento de tela), o cliente local recebe o callback AliRtcVideoTrackScreen, indicando que apenas o stream de compartilhamento de tela está disponível no momento.

• Se o usuário remoto também parar de enviar o stream de compartilhamento de tela (Status de ingestão de stream: Enviando apenas o stream de compartilhamento de tela -> Não enviando um stream de vídeo), o cliente local recebe o callback AliRtcVideoTrackNo, que indica que nenhum stream de vídeo está ativo no momento.

Parâmetros

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

public void onBye(int code);

Quando um usuário é desconectado por qualquer motivo ou a reunião termina, este callback é acionado, permitindo que você use o parâmetro code do callback para determinar o motivo da desconexão e tomar as medidas apropriadas.

Condição de acionamento

• O usuário atual é expulso do servidor.

• A sessão termina (o servidor remove ativamente o canal).

• Saída passiva. O cliente precisa tentar restaurar a sessão ou reconectar.

Parâmetros

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

public void onAudioPublishStateChanged(AliRtcEngine.AliRtcPublishState oldState , 
 AliRtcEngine.AliRtcPublishState newState,
 int elapseSinceLastState, String channel);

Este callback monitora as alterações no status de publicação de áudio do usuário local.

Condição de acionamento

Quando o status de publicação de áudio do usuário é alterado, por exemplo:

• A publicação é interrompida.

• Chame <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="e6c8edfc45xbw">setClientRole</a> para mudar para a função de espectador.

Parâmetros

Callback para alterações no estado de assinatura de áudio.

public void onAudioSubscribeStateChanged(String uid,
 AliRtcEngine.AliRtcSubscribeState oldState,
 AliRtcEngine.AliRtcSubscribeState newState,
 int elapseSinceLastState, String channel);

Este callback notifica o usuário local quando o status de assinatura do fluxo de áudio de um usuário remoto é alterado. Por meio deste callback, é possível obter informações sobre a alteração no status de assinatura do fluxo de áudio de um usuário remoto específico e o intervalo de tempo entre o estado anterior e o estado atual.

Parâmetros