índice API

#SDK Android

Referência da API AOQ Android SDK

Referência completa da API Java para o SDK do cliente AOQ no Android, abrangendo o ciclo de vida do mecanismo, captura e reprodução de áudio/vídeo, configuração de codec, mensagens em tempo real e retornos de chamada de quadro.

índice API

Ciclo de vida do motor

Gerenciamento de dispositivos de áudio

Configuração do codec de áudio

Gerenciamento de dispositivos de vídeo

Codificação de vídeo e entrada externa

Controle de fluxo de mídia/mensagens em tempo real

Reprodução de arquivo de áudio

Fluxos de áudio externos

Retornos de chamada de quadro de áudio/vídeo

Retornos de chamada AoqClientListener

Detalhes da API

Requisitos de entrada de vídeo externa

pushExternalVideoCapturedFrame suporta vídeo e tela. Habilite primeiro a captura externa na trilha correspondente; caso contrário, ele retorna AoqECVideoExternalCaptureNotEnabled (211).

Captura de tela

public abstract int startScreenCapture(@NonNull AoqScreenCaptureConfig config)
public abstract int stopScreenCapture()

trackType suporta AoqTrackTypeAudio, AoqTrackTypeVideoe AoqTrackTypeScreen.

config especifica configurações de captura de tela. O conteúdo da tela é enviado no AoqTrackTypeScreen pista.

Para começar, 0 significa que a solicitação foi aceita; onScreenCaptureStateChanged relata o resultado de forma assíncrona. Um retorno diferente de zero rejeita a solicitação de forma síncrona. Stop retorna 0 em caso de sucesso ou um valor diferente de zero em caso de falha e relata o estado interrompido por meio desse retorno de chamada.

Com isExternal=false, o SDK captura por meio do MediaProjection. Iniciar a captura novamente enquanto ela está ativa retorna AoqECStateInvalid; parar é idempotente.

Para quadros brutos externos, defina isExternal=true e fornecer molduras de tela brutas através pushExternalVideoCapturedFrame para codificação SDK. Para quadros codificados externos, configure a trilha Screen para codificação externa com setVideoEncoderConfig, então ligue pushExternalVideoEncodedFrame; startScreenCapture não é obrigatório.

onScreenCaptureStateChanged

public void onScreenCaptureStateChanged(@NonNull AoqScreenCaptureState state) {}

state contém o estado da captura de tela. Iniciado significa que a captura ou entrada externa está pronta, e não que a mídia foi enviada. Falhas de captura de tela também não são relatadas por meio de onError. Fail e Stopped são estados terminais emitidos após a limpeza.

###setVideoDecoderConfig

public abstract int setVideoDecoderConfig(@NonNull AoqVideoCodecConfig config)

config especifica configurações de decodificação de vídeo. Somente os seguintes campos terão efeito: trackType, codecType, width, height, fps, bitrate. Outros campos aplicam-se apenas à codificação.

A tela não suporta decodificação downstream. Se config.trackType é Tela, o método retorna AoqECUnSupport sem aplicar a configuração.

Retorna 0 em caso de sucesso ou um valor diferente de zero em caso de falha.

enableLocalAudioVolumeIndication

public abstract int enableLocalAudioVolumeIndication(@NonNull AoqAudioVolumeIndicationConfig config)

config especifica configurações de indicação de volume. Os retornos de chamada são emitidos em config.interval. Chame esse método depois startAudioCapture.

Retorna 0 em caso de sucesso ou um valor diferente de zero em caso de falha.

public void onLocalAudioVolumeIndication(@NonNull AoqAudioVolume volume) {}

O volume argumento de retorno de chamada contém o volume de captura local.

Ciclo de vida do motor

criarEngine

Crie a instância do mecanismo. O SDK mantém o mecanismo como um singleton global; chamar esse método novamente retorna a instância existente.

@NonNull
public static AoqClientEngine createEngine(
    @NonNull Context context,
    @NonNull AoqCreateConfig config,
    @NonNull AoqClientListener listener)

Retorna: instância AoqClientEngine; nunca nulo.

destruir

Destrua a instância do mecanismo e libere todos os recursos.

public static int destroy()

Retorna: 0 em caso de sucesso; diferente de zero em caso de falha.

obter versão

@NonNull
public static String getVersion()

Retorna: String de versão, por exemplo "1.0.0".

conectar

Conecte-se ao servidor de retransmissão. Os parâmetros de conexão são alocados pelo servidor de aplicação via /api/v1/allocate e entregue ao cliente.

public abstract int connect(@NonNull AoqConnectConfig config)

Retorna: 0 se a chamada foi despachada (assíncrona); diferente de zero se a validação do parâmetro falhou.

desconectar

public abstract int disconnect()

Retorna: 0 se a chamada foi despachada (assíncrona); diferente de zero em caso de falha.

Gerenciamento de dispositivos de áudio

public abstract int startAudioCapture(@NonNull AoqAudioCaptureConfig config)
public abstract int stopAudioCapture()
public abstract int muteAudioCapture(boolean mute)
public abstract int startAudioPlayer(@NonNull AoqAudioPlaybackConfig config)
public abstract int stopAudioPlayer()
public abstract int pauseAudioPlayer(int fadeMs)
public abstract int resumeAudioPlayer(int fadeMs)
public abstract int interruptAudioPlayer(@NonNull AoqTrackType trackType, int fadeMs)
public abstract int enableSpeakerphone(boolean enable)
public abstract boolean isSpeakerphoneEnabled()

fadeMs: duração do fade-out/fade-in em milissegundos; 0 significa imediato.

Configuração do codec de áudio

public abstract int setAudioEncoderConfig(@NonNull AoqAudioCodecConfig config)
public abstract int setAudioDecoderConfig(@NonNull AoqAudioCodecConfig config)

Gerenciamento de dispositivos de vídeo

public abstract int startVideoCapture(@NonNull AoqVideoCaptureConfig config)
public abstract int stopVideoCapture()
public abstract int switchCamera(@NonNull AoqCameraDirection direction)
public abstract int setLocalView(@NonNull AoqTrackType trackType, @Nullable AoqVideoCanvas canvas)
public abstract int setRemoteView(@NonNull AoqTrackType trackType, @Nullable AoqVideoCanvas canvas)

Passe AoqTrackTypeVideo como o trackType parâmetro para setLocalView e setRemoteView.

Codificação de vídeo e entrada externa

public abstract int setVideoEncoderConfig(@NonNull AoqVideoCodecConfig config)
public abstract int pushExternalVideoCapturedFrame(@NonNull AoqTrackType trackType, @NonNull AoqVideoFrame frame)
public abstract int pushExternalVideoEncodedFrame(@NonNull AoqTrackType trackType, @NonNull AoqVideoEncodedFrame frame)

pushExternalVideoCapturedFrame consome quadros de vídeo depois startVideoCapture(isExternal=true) e quadros de tela depois startScreenCapture(isExternal=true). Se o buffer interno estiver cheio, o método retornará AoqECVideoExternalBufferFull (210).

Controle de fluxo de mídia

public abstract int enableSendMediaStream(@NonNull AoqTrackType trackType, boolean enable)

Padrão recomendado: chamada enableSendMediaStream(false) após a inicialização, ative uma vez onConnectionStatusChange relatórios Connected.

Reprodução de arquivo de áudio

public abstract int startAudioFile(@NonNull String fileId, @NonNull AoqAudioFileMixConfig config)
public abstract int stopAudioFile(@NonNull String fileId)
public abstract int pauseAudioFile(@NonNull String fileId)
public abstract int resumeAudioFile(@NonNull String fileId)
public abstract long getAudioFileDuration(@NonNull String fileId)
public abstract long getAudioFileCurrentPosition(@NonNull String fileId)
public abstract int setAudioFilePositionMillis(@NonNull String fileId, long positionMillis)
public abstract int setAudioFileVolume(@NonNull String fileId, @NonNull AoqAudioStreamDirection type, int volume)
public abstract int getAudioFileVolume(@NonNull String fileId, @NonNull AoqAudioStreamDirection type)

Fluxos de áudio externos

public abstract int addAudioExternalStream(@NonNull String streamId, @NonNull AoqAudioExternalStreamConfig config)
public abstract int removeAudioExternalStream(@NonNull String streamId)
public abstract int pushAudioExternalStreamData(@NonNull String streamId, @NonNull AoqAudioFrameData data)
public abstract int setAudioExternalStreamVolume(@NonNull String streamId, @NonNull AoqAudioStreamDirection type, int volume)
public abstract int getAudioExternalStreamVolume(@NonNull String streamId, @NonNull AoqAudioStreamDirection type)
public abstract void clearAudioExternalStreamBuffer(@NonNull String streamId, int fadeoutMs)

Quando pushAudioExternalStreamData retorna AoqErrorCodeAudioExternalBufferFull (110), o buffer interno está cheio. Aguarde 30 ms e tente novamente.

Mensagens em tempo real

public abstract int sendDataMsg(@NonNull AoqDataMsg msg)

Retornos de chamada de quadro de áudio

public abstract int setAudioFrameObserver(@Nullable AoqClientListener.AoqAudioFrameListener listener)
public abstract int enableAudioFrameObserver(boolean enabled, @NonNull AoqAudioSource audioSource, @NonNull AoqAudioObserverConfig config)

Retornos de chamada de quadro de vídeo

public abstract int setVideoFrameObserver(@Nullable AoqClientListener.AoqVideoFrameListener listener)
public abstract int enableVideoFrameObserver(boolean enabled, @NonNull AoqVideoSource videoSource, @NonNull AoqVideoObserverConfig config)

Retornos de chamada AoqClientListener

AoqClientListener é o ponto de entrega unificado para todos os eventos assíncronos do SDK. Todos os métodos de retorno de chamada têm uma implementação vazia padrão, portanto, você só precisa substituir aqueles de seu interesse.

public void onError(int code, String message)
public void onWarning(int code, String message)
public void onConnectionStatusChange(@NonNull AoqConnectionStatus status)
public void onStats(@NonNull AoqStats stats)
public void onAudioDeviceStateChanged(@NonNull AoqAudioDeviceState state)
public void onAudioDeviceRouteChanged(int routeType)
public void onAudioDeviceInterrupted(boolean interrupt)
public void onVideoDeviceStateChanged(@NonNull AoqVideoDeviceState state)
public void onAudioDeviceFocusChanged(int audioFocus)
public void onAudioFileState(@NonNull AoqAudioFileState state)
public void onDataMsg(@NonNull AoqDataMsg msg)

Transições de estado de conexão: Desconectado → Conectando → Conectado/Falha → Desconectado.

AoqAudioFrameListener

public interface AoqAudioFrameListener {
    default void onCapturedAudioFrame(@NonNull AoqAudioFrameData frame) {}
    default void onProcessCapturedAudioFrame(@NonNull AoqAudioFrameData frame) {}
    default void onPublishAudioFrame(@NonNull AoqTrackType trackType, @NonNull AoqAudioFrameData frame) {}
    default void onPlaybackAudioFrame(@NonNull AoqAudioFrameData frame) {}
}

AoqVideoFrameListener

public interface AoqVideoFrameListener {
    default boolean onCapturedVideoFrame(@NonNull AoqTrackType trackType, @NonNull AoqVideoFrameData frame) { return false; }
    default boolean onPreEncodeVideoFrame(@NonNull AoqTrackType trackType, @NonNull AoqVideoFrameData frame) { return false; }
    default boolean onRemoteVideoFrame(@NonNull AoqTrackType trackType, @NonNull AoqVideoFrameData frame) { return false; }
}

Retorno true para indicar que você modificou os dados do quadro e want o SDK para lê-lo (o write-back só entra em vigor no formato I420). O ByteBuffer e textureId em frame são válidos apenas durante o retorno de chamada; copie-os antes de qualquer uso assíncrono.

Tipos de dados e enumerações

AoqScreenCaptureState

AoqScreenCaptureStateCode

AoqScreenShareNotificationFactory

public interface AoqScreenShareNotificationFactory {
    @Nullable Notification createNotification(@NonNull Context serviceContext);
}

Retorne null para usar a notificação padrão. Crie o NotificationChannel com createNotificationChannel antes de retornar uma notificação personalizada; caso contrário, o serviço em primeiro plano não será iniciado.

AoqScreenCaptureConfig

AoqAudioVolume

AoqAudioVolumeIndicaçãoConfig

AoqTrackParam.trackMode

Modo AoqTrack

Tipos gerais

AoqCreateConfig

AoqConnectConfig

subscribeTracks não deve incluir AoqTrackTypeScreen; caso contrário, connect retorna AoqECUnSupport sem iniciar uma conexão. setRemoteView também retorna AoqECUnSupport para tela.

| vazio | Faixas locais para publicar |

| inscrever-seFaixas | Lista
| vazio | Faixas remotas para assinar |

Tipos de estatísticas

AoqNetworkStats

Enumerações

AoqErrorCode

Código de aviso Aoq

AoqTrackType

AoqEncoderType

AoqConnectionStatus

Tipos de áudio

AoqAudioCaptureConfig

AoqAudioPlaybackConfig

AoqAudioCodecConfig

Tipos de vídeo

AoqVideoCaptureConfig

AoqVideoCodecConfig

AoqVideoPixelFormat

Tipos de fluxo de áudio externo

AoqAudioExternalStreamConfig

AoqAudioStreamDirection

Tipos de mensagens de dados

AoqDataMsg