Skip to main content

Referência da API do AOQ Web SDK

O AOQ Web SDK oferece interação de áudio, vídeo e dados em tempo real em navegadores. Esta referência apresenta as APIs de gerenciamento do mecanismo, captura e reprodução de áudio e vídeo, mensagens de dados e callbacks de eventos.

Instalar o SDK

O AOQ Web SDK se conecta ao servidor usando WebTransport (HTTP/3 / QUIC) e troca áudio, vídeo e mensagens de dados em um Worker. É necessário um navegador com suporte a WebTransport e um contexto seguro HTTPS. Use AoqClientEngine.isAoqSupported() para verificar os recursos básicos do navegador. Instale o SDK usando npm:
npm install aoq-web-sdk@1.0.1-60040320
Como alternativa, obtenha o pacote de instalação em Download do SDK e execute o comando a seguir no diretório do projeto. Substitua o caminho do pacote pelo local real.
npm install ./aoq-web-sdk-1.0.1-60040320.tgz

Lista de APIs

Ciclo de vida do mecanismo

APIDescrição
createEngineCriar um mecanismo singleton
createAoqClientEngineFunção de fábrica nomeada equivalente
destroyDestruir o mecanismo
getVersionObter a versão do SDK
isAoqSupportedVerificar recursos do navegador
connectIniciar uma conexão
disconnectDesconectar

Gerenciamento de dispositivos de áudio

APIDescrição
startAudioCaptureIniciar captura de áudio
stopAudioCaptureParar captura de áudio
muteAudioCaptureSilenciar captura de áudio
startAudioPlayerIniciar reprodução de áudio
stopAudioPlayerParar reprodução de áudio
pauseAudioPlayerPausar reprodução com fade-out
resumeAudioPlayerRetomar reprodução com fade-in padrão
interruptAudioPlayerInterromper reprodução

Configuração de codificação de áudio

APIDescrição
setAudioEncoderConfigDefinir parâmetros de codificação de áudio
setAudioDecoderConfigDefinir parâmetros de decodificação de áudio

Indicação de volume local

APIDescrição
enableLocalAudioVolumeIndicationAtivar indicação de volume local

Gerenciamento de dispositivos de vídeo

APIDescrição
startVideoCaptureIniciar captura de vídeo
getCamerasEnumerar câmeras
switchCameraTrocar câmera por preferência de direção ou ID do dispositivo
stopVideoCaptureParar captura de vídeo
setLocalViewDefinir contêiner de vídeo local
setRemoteViewDefinir contêiner de vídeo remoto

Configuração de codificação de vídeo

APIDescrição
setVideoEncoderConfigDefinir parâmetros de codificação de vídeo
setVideoDecoderConfigDefinir parâmetros de decodificação de vídeo

Controle de transmissão de fluxos de mídia

APIDescrição
enableSendMediaStreamAtivar ou desativar transmissão de fluxos de mídia

Mensagens em tempo real

APIDescrição
sendDataMsgEnviar uma mensagem de dados

Callbacks de eventos

APIDescrição
onErrorCallback de erro
onWarningCallback de aviso
onConnectionStatusChangeAlterações no status da conexão
onStatsEstatísticas
onAudioDeviceStateChangedAlterações no estado do dispositivo de áudio
onAudioDeviceRouteChangedAlterações na rota de áudio
onAudioFileStateEvento reservado de estado de arquivo de áudio; não é emitido atualmente
onLocalAudioVolumeIndicationIndicação de volume local
onVideoDeviceStateChangedAlterações no estado do dispositivo de vídeo
onDataMsgMensagens de dados

Detalhes das APIs

Ciclo de vida do mecanismo

createEngine

Cria um mecanismo singleton. Chamadas repetidas retornam a instância existente.
static createEngine(config: AoqCreateConfig): AoqClientEngine | null
ParâmetroTipoDescrição
configAoqCreateConfigConfiguração de criação do mecanismo
Retorna uma instância de AoqClientEngine em caso de sucesso ou null em caso de falha. Um singleton inicializado é retornado sem reaplicar a configuração. Destrua-o antes de criar um mecanismo com uma nova configuração.

createAoqClientEngine

Fábrica nomeada exportada pelo pacote, equivalente a AoqClientEngine.createEngine(config). Não é um método de instância e não requer inicialização adicional.
function createAoqClientEngine(config: AoqCreateConfig): AoqClientEngine | null
ParâmetroTipoDescrição
configAoqCreateConfigObrigatório; {} é válido. A criação repetida não reaplica a configuração.
Retorna o mecanismo singleton em caso de sucesso ou null em caso de falha.
import { createAoqClientEngine } from 'aoq-web-sdk';

const engine = createAoqClientEngine({});
if (!engine) throw new Error('创建引擎失败');

destroy

Destrói o mecanismo, inicia a liberação de recursos e remove todos os listeners de eventos.
static destroy(): number
Retorna 0 em caso de sucesso ou AoqECStateInvalid(2) se não houver instância. O método retorna de forma síncrona. O salvamento de logs e a exportação opcional de dumps são assíncronos e podem não ter terminado no retorno. Crie um novo mecanismo com createEngine para voltar a usar o SDK; a instância destruída não pode ser reutilizada.

getVersion

Obtém a versão do SDK.
static getVersion(): string
Retorna a versão do pacote instalado como string, não a revisão do documento nem o ID de commit do código-fonte.

isAoqSupported

Verifica os recursos básicos do navegador necessários para uma conexão AOQ.
static isAoqSupported(): Promise<AoqSupportResult>
Retorna Promise<AoqSupportResult> com o resultado e os recursos ausentes. A verificação testa o WebTransport em um Worker com timeout de 5 segundos. Não verifica acessibilidade da rede, configuração do servidor, autenticação, permissões de dispositivos nem configurações específicas de mídia. supported: true não garante conexão ou chamada bem-sucedida.

connect

Inicia uma conexão com o servidor.
connect(config: AoqConnectConfig): number
ParâmetroTipoDescrição
configAoqConnectConfigCredenciais de conexão, incluindo token, ID da sessão e endpoints de relay
Retorna 0 quando a solicitação é aceita. Chame após criar o mecanismo, registrar eventos e configurar codecs. Normalmente a conexão parte de Disconnected; uma nova tentativa em Failed também é permitida. Outros estados retornam AoqECStateInvalid(2). Parâmetros inválidos de track, mídia ou conexão, ou Opus sem os recursos WebCodecs necessários, podem retornar AoqECParamInvalid(1). Network Worker indisponível retorna AoqECStateInvalid(2). O resultado é informado de forma assíncrona por onConnectionStatusChange. Connected indica que MEDIA_SETUP foi concluído e os tracks estão vinculados. Configure a sessão conforme o protocolo de dados do modelo e confirme que a aplicação está pronta antes de ativar a transmissão de áudio ou vídeo.

disconnect

Desconecta do servidor.
disconnect(): number
Retorna 0 quando a solicitação é aceita. O resultado é informado por onConnectionStatusChange. Aguarde AoqConnectionStatusDisconnected antes de alterar os codecs e reconectar. Chamar quando já desconectado retorna AoqECStateInvalid(2). Desconectar não para os dispositivos; chame também os métodos de parada de captura e reprodução ao encerrar uma chamada.

Gerenciamento de dispositivos de áudio

startAudioCapture

Inicia a captura do microfone e solicita permissão de forma assíncrona.
startAudioCapture(config: AoqAudioCaptureConfig): Promise<number>
ParâmetroTipoDescrição
configAoqAudioCaptureConfigConfiguração de captura de áudio
Retorna Promise<number>; 0 indica sucesso. O navegador pode solicitar permissão do microfone no primeiro uso ou quando ainda não autorizada. Mudanças no estado de captura são informadas por onAudioDeviceStateChanged. Em congestionamentos, o áudio de uplink que aguarda cerca de 100 ms na fila de envio é descartado para evitar acúmulo de latência. Áudio cujo envio já começou não é retirado. Esse limite não é uma latência máxima de ponta a ponta.

stopAudioCapture

Para a captura de áudio.
stopAudioCapture(): number
Retorna 0 em caso de sucesso. Retorna AoqECStateInvalid(2) se o dispositivo não tiver iniciado ou já tiver parado.

muteAudioCapture

Silencia ou reativa a captura de áudio. A captura continua quando silenciada, mas são enviados quadros silenciosos.
muteAudioCapture(mute: boolean): number
ParâmetroTipoDescrição
mutebooleantrue: silenciar; false: reativar
Retorna 0 em caso de sucesso.

startAudioPlayer

Inicia o reprodutor e inicializa o dispositivo de saída de forma assíncrona.
startAudioPlayer(config: AoqAudioPlaybackConfig): Promise<number>
ParâmetroTipoDescrição
configAoqAudioPlaybackConfigConfiguração de reprodução de áudio
Retorna Promise<number>; 0 indica sucesso. Mudanças no estado de reprodução são informadas por onAudioDeviceStateChanged. Chame a partir de um clique do usuário e trate as restrições de reprodução automática. Chamadas durante a inicialização ou com o reprodutor já iniciado retornam AoqECStateInvalid(2). No modo Realtime (trackMode de downlink de áudio é Stream), o áudio recebido antes de iniciar o reprodutor é consumido continuamente sem se acumular. Cada início, inclusive o primeiro, limpa o áudio anterior e reproduz apenas áudio novo. O modo Segment preserva áudio ainda não reproduzido.

stopAudioPlayer

Para o reprodutor de áudio.
stopAudioPlayer(): number
Retorna 0 em caso de sucesso. Retorna AoqECStateInvalid(2) se o dispositivo não tiver iniciado ou já tiver parado. No modo Realtime, o áudio recebido continua sendo consumido após a saída parar, e o vídeo continua. Reiniciar reproduz apenas áudio novo. Os estados de pausa ou interrupção são preservados no reinício. O modo Segment preserva áudio ainda não reproduzido.

pauseAudioPlayer

Pausa a reprodução após o fade-out. Chame resumeAudioPlayer para retomar.
pauseAudioPlayer(fadeMs: number): number
ParâmetroTipoDescrição
fadeMsnumberDuração do fade-out em ms, arredondada para amostras na taxa real do dispositivo. 0 desativa o fade; valores negativos ou não finitos usam 100 ms.
Retorna 0 quando a solicitação de controle é aceita. O fade-out pode não ter terminado, e o reprodutor pode não estar reproduzindo. O modo Segment preserva o áudio restante e a posição de leitura, retomando dessa posição. O modo Realtime descarta o áudio da fila e continua consumindo o áudio recebido durante a pausa, retomando da posição ao vivo atual sem reproduzir o áudio desse intervalo.

resumeAudioPlayer

Retoma a reprodução pausada ou interrompida com fade-in padrão: 2 ms no modo Segment e 100 ms no modo Realtime.
resumeAudioPlayer(fadeMs: number): number
ParâmetroTipoDescrição
fadeMsnumberReservado e atualmente ignorado. O fade-in padrão é usado; passar 0 não o desativa.
Retorna 0 quando a solicitação de controle é aceita; a retomada pode não ter terminado.

interruptAudioPlayer

Interrompe a reprodução e descarta o áudio restante após o fade-out. Ao contrário da pausa em Segment, o áudio descartado não é reproduzido ao retomar.
interruptAudioPlayer(trackType: AoqTrackType, fadeMs: number): number
ParâmetroTipoDescrição
trackTypeAoqTrackTypeParâmetro de compatibilidade. Use Audio. Atualmente, não seleciona um fluxo de reprodução.
fadeMsnumberDuração do fade-out em ms, arredondada para amostras na taxa real do dispositivo. 0 desativa o fade; valores negativos ou não finitos usam 100 ms.
Retorna 0 quando a solicitação é aceita. A interrupção pode não ter terminado, e o reprodutor pode não estar reproduzindo. A reprodução é retomada automaticamente quando o servidor envia áudio de uma nova rodada. Também é possível chamar resumeAudioPlayer. Solicitações de interrupção durante uma pausa são ignoradas, mas ainda podem retornar 0. O modo Segment retoma o áudio preservado antes da pausa. Pausar e depois interromper não limpa a fila de reprodução.

Configuração de codificação de áudio

setAudioEncoderConfig

Define parâmetros de codificação de áudio.
setAudioEncoderConfig(config: AoqAudioCodecConfig): number
ParâmetroTipoDescrição
configAoqAudioCodecConfigConfiguração de codificação de áudio
Retorna 0 em caso de sucesso. Chame antes de connect() com o mecanismo em Disconnected. Alterações durante a conexão ou quando conectado retornam AoqECStateInvalid(2). Desconecte, aguarde Disconnected, configure e reconecte. O retorno 0 indica que a solicitação de configuração foi aceita. O formato é validado novamente ao conectar. Opus também depende de WebCodecs no navegador.

setAudioDecoderConfig

Define parâmetros de decodificação de áudio.
setAudioDecoderConfig(config: AoqAudioCodecConfig): number
ParâmetroTipoDescrição
configAoqAudioCodecConfigConfiguração de decodificação de áudio
Retorna 0 em caso de sucesso. Chame antes de connect() com o mecanismo em Disconnected. Alterações durante a conexão ou quando conectado retornam AoqECStateInvalid(2).

Indicação de volume local

enableLocalAudioVolumeIndication

Ativa ou desativa notificações periódicas de volume da captura local por onLocalAudioVolumeIndication.
enableLocalAudioVolumeIndication(config: AoqAudioVolumeIndicationConfig): number
ParâmetroTipoDescrição
configAoqAudioVolumeIndicationConfigConfiguração de indicação de volume
Retorna 0 em caso de sucesso. Defina interval como 0 ou um valor negativo para desativar os callbacks.

Gerenciamento de dispositivos de vídeo

startVideoCapture

Inicia a captura da câmera.
startVideoCapture(config: AoqVideoCaptureConfig): number
ParâmetroTipoDescrição
configAoqVideoCaptureConfigConfiguração de captura de vídeo
Retorna 0 em caso de sucesso. O retorno 0 indica que a solicitação assíncrona foi aceita. O sucesso ou a falha é informado por onVideoDeviceStateChanged; a câmera pode ainda não estar ativa. cameraPreference aceita um enum de direção ou ID de dispositivo. Se omitido, o navegador escolhe. Se a preferência não puder ser atendida, o navegador pode usar outra câmera disponível.

getCameras

getCameras(): Promise<MediaDeviceInfo[]>
Enumera dispositivos videoinput visíveis ao navegador sem abrir câmeras nem solicitar permissão. Nomes ou IDs podem estar incompletos antes da autorização. Enumere novamente após autorizar ou alterar dispositivos. A Promise é rejeitada se o mecanismo não estiver inicializado ou a enumeração falhar.

switchCamera

switchCamera(cameraPreference?: AoqCameraDirection | string): number
ParâmetroTipoObrigatórioDescrição
cameraPreferenceAoqCameraDirection | stringNãoDireção ou ID preferido. Omita para limpar a preferência anterior e permitir nova escolha pelo navegador.
Direção e ID usam restrições ideal, permitindo outra câmera. 0 indica aceitação; o estado é informado por onVideoDeviceStateChanged, e falhas por onError. Retorna AoqECStateInvalid(2) sem captura ativa, durante início ou troca; direção inválida ou ID em branco retorna AoqECParamInvalid(1). A troca libera o dispositivo anterior, abre o destino e aguarda o primeiro quadro. Se o track anterior foi transferido a um Worker, inclusive com posterior retorno à thread principal, a liberação é confirmada em até 2 segundos. Timeout dessa confirmação informa falha sem abrir ou restaurar dispositivo. Cada tentativa leva no máximo 15 segundos. Em falha, uma tentativa restaura a captura usando a preferência anterior; mesmo que restaure, a troca é informada como falha. Sucesso: CaptureStarted(reason=0); falha com captura restaurada: CaptureStarted(reason=código de erro); restauração sem sucesso: CaptureFail(reason=código de erro). Se o destino explícito já estiver atendido, CaptureStarted é emitido de forma assíncrona sem reabertura. O callback não informa o ID real. A troca preserva o controle de transmissão, codecs e vínculo da prévia. Parar a captura cancela a troca; destruir o mecanismo impede novos callbacks. A troca pode interromper brevemente o vídeo. A linha de tempo da captura permanece contínua, mas a sincronização de áudio/vídeo em hardware não é garantida. O navegador escolhe o dispositivo real; não apresente a preferência solicitada como dispositivo confirmado.

stopVideoCapture

Para a captura de vídeo.
stopVideoCapture(): number
Retorna 0 em caso de sucesso. Retorna AoqECStateInvalid(2) se o dispositivo não tiver iniciado ou já tiver parado.

setLocalView

Define o contêiner de vídeo local. O SDK cria elementos de renderização dentro dele.
setLocalView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParâmetroTipoDescrição
trackTypeAoqTrackTypeSomente AoqTrackTypeVideo é aceito. Outros tipos retornam AoqECUnSupport(3).
canvasAoqVideoCanvas | nullConfiguração do contêiner de renderização. Passe null para desvincular.
Retorna 0 em caso de sucesso. Defina dimensões explícitas para o contêiner. O SDK cria elementos de renderização dentro dele. Use um contêiner DOM comum de dimensões explícitas, como div. Não passe diretamente video, audio, canvas, img ou elementos vazios. Contêiner inválido, ID inexistente ou renderMode inválido retorna AoqECParamInvalid(1), preservando o vínculo anterior. 0 indica aceitação; o primeiro quadro pode ainda não ter sido renderizado.

setRemoteView

Define o contêiner de vídeo remoto. O SDK cria elementos de renderização dentro dele.
setRemoteView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParâmetroTipoDescrição
trackTypeAoqTrackTypeSomente AoqTrackTypeVideo é aceito. Outros tipos retornam AoqECUnSupport(3).
canvasAoqVideoCanvas | nullConfiguração do contêiner de renderização. Passe null para desvincular.
Retorna 0 em caso de sucesso. Use um contêiner DOM comum de dimensões explícitas, como div. Não passe diretamente video, audio, canvas, img ou elementos vazios. Contêiner inválido, ID inexistente ou renderMode inválido retorna AoqECParamInvalid(1), preservando o vínculo anterior. 0 indica aceitação; o primeiro quadro pode ainda não ter sido renderizado.

Configuração de codificação de vídeo

setVideoEncoderConfig

Define parâmetros de codificação de vídeo.
setVideoEncoderConfig(config: AoqVideoCodecConfig): number
ParâmetroTipoDescrição
configAoqVideoCodecConfigConfiguração de codificação de vídeo
Retorna 0 em caso de sucesso. Chame com o mecanismo em Disconnected. Durante a conexão ou quando conectado, retorna AoqECStateInvalid(2). Configure antes da primeira conexão e captura de vídeo. A configuração é mesclada e armazenada para fluxos futuros; capturas ou codificadores existentes não são reconfigurados imediatamente.

setVideoDecoderConfig

Define parâmetros de decodificação de vídeo.
setVideoDecoderConfig(config: AoqVideoCodecConfig): number
ParâmetroTipoDescrição
configAoqVideoCodecConfigConfiguração de decodificação de vídeo
Retorna 0 em caso de sucesso. Chame antes de connect() com o mecanismo em Disconnected. Alterações durante a conexão ou quando conectado retornam AoqECStateInvalid(2).

Controle de transmissão de fluxos de mídia

enableSendMediaStream

Ativa ou desativa a transmissão de tracks de áudio ou vídeo.
enableSendMediaStream(trackType: AoqTrackType, enable: boolean): number
ParâmetroTipoDescrição
trackTypeAoqTrackTypeTipo de track de mídia
enablebooleantrue: ativar transmissão; false: desativar transmissão
Retorna 0 em caso de sucesso. Controla somente Audio e Video, não Data. Outros valores podem retornar 0 sem efeito. Desativar a transmissão não para dispositivos de captura; use o método stop...Capture() correspondente.

Mensagens em tempo real

sendDataMsg

Envia texto UTF-8 em um Uint8Array ao peer, como JSON da aplicação. O caminho WT atual não aceita payloads binários arbitrários nem mensagens internas de controle do SDK por este método.
sendDataMsg(msg: AoqDataMsg): number
ParâmetroTipoDescrição
msgAoqDataMsgObjeto de mensagem; msg.data deve conter bytes UTF-8 não vazios
Retorna 0 em caso de sucesso. Requer mecanismo conectado, tracks prontos e Data em publishTracks. Mensagem ausente ou msg.data que não seja Uint8Array retorna AoqECParamInvalid(1). Conexão não pronta retorna AoqECStateInvalid(2). Fluxo de envio inativo ou mensagem vazia retorna atualmente -1. 0 indica aceitação local, não recebimento confirmado pelo peer. Validação UTF-8 ou envio posterior ainda pode falhar por onError. O ArrayBuffer subjacente de msg.data pode ser transferido e desanexado, afetando outras views que compartilhem o buffer. Passe uma cópia data.slice() para preservar o original. Não envie API keys nem credenciais temporárias em mensagens frontend ou logs.
const data = new TextEncoder().encode(JSON.stringify({ type: 'user_message', text: '你好' }));
const code = engine.sendDataMsg({ data });
if (code !== 0) console.error('消息未受理', code);
O JSON demonstra apenas a codificação. Siga o protocolo de mensagens de dados do modelo para os campos reais e a prontidão da aplicação.

Callbacks de eventos

Registre com engine.on('eventName', callback), escute uma vez com engine.once(...) e remova com engine.off('eventName', callback) usando a mesma referência de função. Destruir o mecanismo remove todos os listeners. Registre antes de conectar ou iniciar dispositivos e mantenha os callbacks leves.
import { AoqConnectionStatus } from 'aoq-web-sdk';

const handleStatus = (status: AoqConnectionStatus) => console.log('连接状态', status);
engine.on('onConnectionStatusChange', handleStatus);
engine.off('onConnectionStatusChange', handleStatus);
EventoAssinatura do callbackDescrição
onError(code: number, message: string) => voidCallback de erro
onWarning(code: number, message: string) => voidCallback de aviso
onConnectionStatusChange(status: AoqConnectionStatus) => voidAlterações no status da conexão
onStats(stats: AoqStats) => voidEstatísticas
onAudioDeviceStateChanged(state: AoqAudioDeviceState) => voidAlterações no estado do dispositivo de áudio
onAudioDeviceRouteChanged(routeType: AoqAudioDeviceRouteType) => voidAlterações na rota de áudio
onAudioFileState(state: AoqAudioFileState) => voidReservado; não é emitido atualmente
onLocalAudioVolumeIndication(volume: AoqAudioVolume) => voidIndicação de volume local
onVideoDeviceStateChanged(state: AoqVideoDeviceState) => voidAlterações no estado do dispositivo de vídeo
onDataMsg(msg: AoqDataMsg) => voidMensagens de dados

onError

Informa erros assíncronos ou de execução além dos retornos síncronos. Use code e message junto com os estados de conexão e dispositivos para diagnóstico. Um erro não implica encerramento da conexão. Erros de rede podem usar códigos gerais de estado; o número isolado não identifica a etapa da falha.
engine.on('onError', (code: number, message: string) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
codenumberCódigo de erro; consulte AoqErrorCode
messagestringDescrição do erro

onWarning

Informa avisos do mecanismo sobre condições não fatais que exigem atenção.
engine.on('onWarning', (code: number, message: string) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
codenumberCódigo de aviso; consulte AoqWarningCode
messagestringDescrição do aviso

onConnectionStatusChange

Informa alterações no status da conexão.
engine.on('onConnectionStatusChange', (status: AoqConnectionStatus) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
statusAoqConnectionStatusStatus atual da conexão

onStats

Informa estatísticas aproximadamente a cada segundo enquanto Connected e para ao sair desse estado. Consulte AoqStats para disponibilidade dos campos. Valores de preenchimento não são medições.
engine.on('onStats', (stats: AoqStats) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
statsAoqStatsObjeto de estatísticas

onAudioDeviceStateChanged

Informa mudanças no estado das operações de captura e reprodução de áudio.
engine.on('onAudioDeviceStateChanged', (state: AoqAudioDeviceState) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
stateAoqAudioDeviceStateEstado do dispositivo de áudio

onAudioDeviceRouteChanged

Quando a lista de dispositivos de saída muda, o SDK tenta inferir a rota pelos rótulos do navegador. Pode identificar incorretamente ou omitir mudanças; não confirma a rota real. Pode retornar o tipo padrão antes da autorização ou com informações incompletas.
engine.on('onAudioDeviceRouteChanged', (routeType: AoqAudioDeviceRouteType) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
routeTypeAoqAudioDeviceRouteTypeRota inferida por rótulos; não confirma o dispositivo de saída real

onAudioFileState

Callback reservado de estado de arquivo de áudio. O AoqClientEngine atual não oferece controles de reprodução de arquivos nem emite este evento.
engine.on('onAudioFileState', (state: AoqAudioFileState) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
stateAoqAudioFileStateEstado do arquivo de áudio

onLocalAudioVolumeIndication

Informa o volume da captura local. Ative primeiro com enableLocalAudioVolumeIndication.
engine.on('onLocalAudioVolumeIndication', (volume: AoqAudioVolume) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
volumeAoqAudioVolumeInformações de volume

onVideoDeviceStateChanged

Informa mudanças no estado das operações do dispositivo de captura de vídeo.
engine.on('onVideoDeviceStateChanged', (state: AoqVideoDeviceState) => { /* 在此处理回调 */ });
ParâmetroTipoDescrição
stateAoqVideoDeviceStateEstado do dispositivo de vídeo

onDataMsg

Informa mensagens de dados recebidas.
engine.on('onDataMsg', (msg: AoqDataMsg) => { /* 使用 msg.data 读取消息数据 */ });
ParâmetroTipoDescrição
msgAoqDataMsgObjeto de mensagem recebido. Use TextDecoder para ler o texto UTF-8 de msg.data.
Inclua Data em subscribeTracks para receber mensagens. O callback recebe um objeto, não um Uint8Array diretamente. A aplicação deve analisar e validar o JSON.

Tipos de dados e enums

Tipos comuns

AoqCreateConfig

Configuração de criação do mecanismo.
CampoTipoObrigatórioPadrãoDescrição
workDirstringNão—Reservado; o Web SDK não usa este campo para selecionar o diretório de armazenamento
enableDumpAudiobooleanNãofalseSalva áudio de depuração. Obtenha autorização e controle o acesso ao áudio do usuário.
enableDumpExportbooleanNãofalseVálido somente com enableDumpAudio=true. Exporta um ZIP de dump e remove os arquivos OPFS correspondentes de forma assíncrona na destruição.
maxEncodedVideoFrameBytesnumberNão194560 (190×1024)Tamanho máximo desejado de quadro JPEG em bytes. 0 desativa o limite. Quadros maiores têm a qualidade reduzida; valores inválidos usam o padrão.
enableDropOversizedVideoFramebooleanNãofalseDescarta JPEG ainda acima do limite na qualidade mínima. Com false, quadros maiores podem ser enviados. Não descarta por esse motivo quando o limite é 0.
extrasstringNão—String de objeto JSON. JSON inválido, valor não objeto ou política remota inválida faz createEngine retornar null.
Campos extras aceitos:
Campo JSONTipoPadrãoDescrição
remoteVideoRenderer'auto' | 'video' | 'canvas''auto'Política de renderização remota. auto prefere video e usa canvas se necessário.
user_specified_enable_av_syncbooleantrueAtivar sincronização de áudio/vídeo. Use um booleano JSON.
user_specified_audio_playback_transport'message-port'AutomáticoForça reprodução por MessagePort. Se omitido, seleciona memória compartilhada ou MessagePort conforme o ambiente.
Esses campos não alteram cabeçalhos de resposta HTTP nem ativam APIs públicas de diagnóstico.

AoqConnectConfig

Configuração de autenticação da conexão.
CampoTipoObrigatórioPadrãoDescrição
tokenstringSim—Token temporário não vazio do cliente, correspondente a aoqTokenForClient, não uma API key
sidstringSim—ID de sessão não vazio. Use a string sid completa da resposta de autenticação.
wtBaseUrlstringNãoDerivado do RelayURL HTTPS WT preferida para rota única. Ignorada com múltiplas rotas, que se conectam a /aoq em cada host e porta.
signedSidstringSim (em execução)—SID assinado completo, normalmente o sid completo da autenticação. Opcional no TypeScript, mas obrigatório no fluxo WT atual.
certFingerprintstring | string[]Condicional—Impressão digital SHA-256 compartilhada do certificado WT. Rotas sem valor próprio devem poder usar esse valor.
workspaceIdHashstringNão—Corresponde a extraInfo.workspaceIdHash. Não substitua pelo Workspace ID original.
relayEndpointsAoqRelayEndpoint[]Sim—Lista completa de endpoints com ao menos uma entrada
publishTracksAoqTrackParam[]Sim—Tracks de uplink. Pode ser vazio, mas não junto com subscribeTracks.
subscribeTracksAoqTrackParam[]Sim—Tracks de downlink. Pode ser vazio. Tracks duplicados na mesma direção e Screen não são aceitos.
O backend deve retornar credenciais completas e válidas. Mapeie clientRelayEndpoints[].route_index para routeIndex no adaptador. Não invente SIDs, endpoints, índices nem impressões digitais. As impressões digitais WT devem corresponder ao certificado do endpoint WebTransport real. Para sha256/<hex>, remova o prefixo e valide 64 dígitos hexadecimais. Valores compartilhados e por rota aceitam string ou array; todos os itens devem ser válidos, e basta corresponder a um. Valores não vazios por rota substituem os compartilhados; array vazio é tratado como não configurado. Não há impressão digital universal nem opção para ignorar a validação. A ausência de signedSid ou impressões digitais válidas pode causar falha assíncrona mesmo após connect() retornar 0. Trate eventos de status e onError.

AoqRelayEndpoint

Endpoint Relay.
CampoTipoObrigatórioPadrãoDescrição
routeIndexnumberSim (em execução)—Inteiro único entre 0 e 2147483647. O menor índice é escolhido inicialmente. Opcional no TypeScript.
certFingerprintstring | string[]CondicionalImpressão digital compartilhadaValor não vazio da rota substitui o compartilhado. Obrigatório se não houver impressão digital compartilhada.
endpointstringSim—Host ou IP WT sem esquema, caminho, espaços, dados de usuário nem query string. Suporta IPv6.
portnumberSim—Porta WT, inteiro entre 1 e 65535

AoqTrackParam

Propriedades do track.
CampoTipoObrigatórioPadrãoDescrição
trackTypeAoqTrackTypeSim—Audio, Video ou Data. Sem duplicatas na mesma direção. Screen ainda não é aceito.
trackModeAoqTrackModeNãoSegment para áudio de downlinkControla apenas o áudio de downlink. PCM / Opus usam Segment por padrão; selecione Stream explicitamente para Realtime. Uplink de áudio sempre usa Realtime. Uplink, vídeo e dados ignoram este campo.

AoqSupportResult

Resultado da verificação de recursos do navegador.
CampoTipoPadrãoDescrição
supportedboolean—Se o ambiente oferece os recursos básicos de conexão AOQ
missingFeaturesAoqMissingFeature[]—Falhas observadas na pré-verificação, incluindo potencialmente 'secure-context', 'worker' e 'web-transport'

AoqMissingFeature

Falhas básicas: 'secure-context' | 'worker' | 'web-transport'. worker também pode indicar bloqueio por política de implantação, falha de início/execução ou timeout, não apenas ausência da API Worker. A lista não avalia todos os recursos de mídia.

Tipos de áudio

AoqAudioCaptureConfig

Configuração de captura de áudio.
CampoTipoObrigatórioPadrãoDescrição
channelnumberNão1Canais solicitados: 1 (mono) ou 2 (estéreo). Os valores reais podem depender do track do dispositivo.

AoqAudioPlaybackConfig

Configuração de reprodução de áudio.
CampoTipoObrigatórioPadrãoDescrição
channelnumberNão1Canais solicitados: 1 ou 2. A saída usa a taxa de amostragem real do AudioContext.
playOnlyAndIgnoreMutebooleanNãofalsePara uso apenas de reprodução. Define audioSession como playback quando compatível, evitando o botão de silêncio do iOS. Mantenha false para capturar microfone. Ignorar o silêncio não é garantido sem suporte do navegador.

AoqAudioCodecConfig

Configuração de codec de áudio.
CampoTipoObrigatórioPadrãoDescrição
trackTypeAoqTrackTypeNão—Reservado; não seleciona um fluxo de áudio atualmente
codecTypeAoqEncoderTypeNãoAoqEncoderTypeAudioPCMPCM / Opus. Deve corresponder à configuração negociada com o peer.
sampleRatenumberNão48000Taxa em Hz. Valores negociados: 8000, 12000, 16000, 24000, 32000, 44100, 48000. O navegador também deve oferecer suporte à codificação escolhida.
channelnumberNão1Quantidade de canais: 1 ou 2
bitratenumberNão32000 (codificação Opus)Em bps, somente para codificação Opus. O bitrate PCM depende da amostragem, canais e profundidade de bits. Não usado na decodificação.

AoqAudioVolumeIndicationConfig

Configuração de indicação de volume local.
CampoTipoObrigatórioPadrãoDescrição
intervalnumberNão0Intervalo de callback em ms. Valores <=0 desativam; valores positivos inferiores a 10 são tratados como 10.
smoothnumberNão3Fator de suavização de volume, 0..10. Valores maiores suavizam mais.
reportSpeechbooleanNãofalseInformar atividade de voz (VAD)

AoqAudioVolume

Informações de volume local.
CampoTipoPadrãoDescrição
volumenumber—Volume instantâneo suavizado, intervalo [0-255]
isSpeechboolean—Indicador opcional de atividade de voz, válido somente com reportSpeech=true. Trate valores ausentes.

AoqAudioDeviceState

Dados do callback de estado do dispositivo de áudio.
CampoTipoPadrãoDescrição
stateAoqAudioDeviceStateCode—Código de estado do dispositivo de áudio
reasonnumber—Código de motivo; consulte AoqErrorCode

AoqAudioFileState

Estrutura reservada de estado de reprodução de arquivos. O Web SDK não emite o evento correspondente atualmente.
CampoTipoPadrãoDescrição
fileIdstring—ID do arquivo de áudio
stateCodeAoqAudioFileStateCode—Código de estado de reprodução do arquivo
errorCodenumber—Código de erro

Tipos de vídeo

AoqVideoCaptureConfig

Configuração de captura de vídeo.
CampoTipoObrigatórioPadrãoDescrição
widthnumberNão1280Largura de captura solicitada em pixels, restrição ideal. O navegador/dispositivo determina o valor real.
heightnumberNão720Altura de captura solicitada em pixels, restrição ideal. O navegador/dispositivo determina o valor real.
fpsnumberNão15Taxa de quadros solicitada, restrições ideal e max
cameraPreferenceAoqCameraDirection | stringNãoEscolha do navegadorPreferência de direção ou ID da câmera com restrição ideal. Alternativas são permitidas; strings em branco são inválidas.

AoqVideoCodecConfig

Configuração de codec de vídeo.
CampoTipoObrigatórioPadrãoDescrição
trackTypeAoqTrackTypeNão—Reservado; não seleciona um fluxo de vídeo atualmente
codecTypeAoqEncoderTypeNãoAoqEncoderTypeVideoH264H.264 / JPEG. Deve corresponder à configuração negociada com o peer.
widthnumberNão540Largura alvo de codificação ou negociada no downlink, em pixels. Deve ser inteiro positivo ao conectar.
heightnumberNão960Altura alvo de codificação ou negociada no downlink, em pixels. Deve ser inteiro positivo ao conectar.
fpsnumberNão5Taxa de quadros de codificação ou negociada no downlink. Deve ser inteiro positivo ao conectar.
bitratenumberNão500000 (codificação)Bitrate alvo positivo de codificação em bps. Não usado na decodificação.
minBitratenumberNão128000Bitrate mínimo alvo em bps. Omitido ou 0 usa 128000, limitado ao alvo do usuário. A codificação H.264 não pausa quando o orçamento BWE chega a 0. Não usado na decodificação.
keyframeIntervalnumberNão2Intervalo de quadros-chave H.264 em segundos, no mínimo 1 segundo na codificação. Não usado em JPEG ou decodificação.

AoqVideoCanvas

Configuração do contêiner de renderização de vídeo.
CampoTipoObrigatórioPadrãoDescrição
viewHTMLElement | stringSim—Contêiner comum ou seu ID DOM sem #. Não use diretamente video, audio, canvas, img nem elementos vazios.
renderModeAoqRenderModeNãoAoqRenderModeAuto(0)Modo de ajuste do vídeo
A prévia local é espelhada automaticamente por CSS quando o track real é frontal; direção desconhecida não é espelhada. Os pixels codificados não mudam. Não há configuração separada de espelhamento ou orientação. Substituições inválidas preservam o vínculo anterior. Desvincular com null remove apenas nós do SDK, preservando os da aplicação.

AoqVideoDeviceState

Dados do callback de estado do dispositivo de vídeo.
CampoTipoPadrãoDescrição
stateAoqVideoDeviceStateCode—Código de estado do dispositivo de vídeo
reasonnumber—Motivo: 0 para parada explícita; AoqECVideoDevice(220) para término inesperado do track Web

Tipos de mensagens de dados

AoqDataMsg

Estrutura compartilhada por sendDataMsg e onDataMsg públicos. As APIs não aceitam string ou Uint8Array diretamente. O caminho WT transporta texto UTF-8 em um array de bytes.
CampoTipoObrigatórioPadrãoDescrição
dataUint8ArraySim—UTF-8 válido e não vazio no envio. Leia msg.data na recepção.

Tipos de estatísticas

AoqStats

Resumo de estatísticas do mecanismo. Todos os campos abaixo são opcionais na definição; trate valores ausentes.
CampoTipoPadrãoDescrição
audioPublishStatsAoqAudioPublishStats[]—Estatísticas de publicação de áudio
audioSubscribeStatsAoqAudioSubscribeStats[]—Estatísticas de assinatura de áudio
videoPublishStatsAoqVideoPublishStats[]—Estatísticas de publicação de vídeo
videoSubscribeStatsAoqVideoSubscribeStats[]—Estatísticas de assinatura de vídeo
dataMsgPublishStatsAoqDataMsgPublishStats[]—Estatísticas de publicação de mensagens de dados
dataMsgSubscribeStatsAoqDataMsgSubscribeStats[]—Estatísticas de assinatura de mensagens de dados
networkStatsAoqNetworkStats—Estatísticas de rede
onStats não preenche dataMsgPublishStats nem dataMsgSubscribeStats atualmente. bitrate / bytes de áudio contêm totais da conexão, não tráfego de áudio isolado; encodeVolume / playVolume ficam em 0. bitrate / bytes de vídeo também ficam em 0; apenas taxas de quadros vêm do mecanismo de vídeo. Use networkStats para tráfego total e onLocalAudioVolumeIndication para volume de captura.

AoqAudioPublishStats

Estatísticas de publicação de áudio.
CampoTipoPadrãoDescrição
trackTypeAoqTrackType—Tipo de track
bitratenumber—Bitrate total de aplicação no uplink da conexão, em bps, não apenas áudio
bytesnumber—Bytes totais de aplicação no uplink da conexão, não apenas áudio
encodeVolumenumber0Valor de preenchimento. Use onLocalAudioVolumeIndication para volume de captura.

AoqAudioSubscribeStats

Estatísticas de assinatura de áudio.
CampoTipoPadrãoDescrição
trackTypeAoqTrackType—Tipo de track
bitratenumber—Bitrate total de aplicação no downlink da conexão, em bps, não apenas áudio
bytesnumber—Bytes totais de aplicação no downlink da conexão, não apenas áudio
playVolumenumber0Valor de preenchimento; não indica se a reprodução está silenciada

AoqVideoPublishStats

Estatísticas de publicação de vídeo.
CampoTipoPadrãoDescrição
trackTypeAoqTrackType—Tipo de track
bitratenumber0Valor de preenchimento; bitrate de vídeo isolado ainda não informado
bytesnumber0Valor de preenchimento; contagem de bytes de vídeo isolada ainda não informada
encodeFpsnumber—Taxa de quadros de codificação

AoqVideoSubscribeStats

Estatísticas de assinatura de vídeo.
CampoTipoPadrãoDescrição
trackTypeAoqTrackType—Tipo de track
bitratenumber0Valor de preenchimento; bitrate de vídeo isolado ainda não informado
bytesnumber0Valor de preenchimento; contagem de bytes de vídeo isolada ainda não informada
decodeFpsnumber—Taxa de quadros de decodificação
renderFpsnumber—Taxa de quadros de renderização

AoqDataMsgPublishStats

Estatísticas de publicação de mensagens de dados.
CampoTipoPadrãoDescrição
trackTypeAoqTrackType—Tipo de track
bitratenumber—Bitrate atual em bps
bytesnumber—Bytes enviados acumulados
O tipo está definido, mas onStats ainda não preenche esse array.

AoqDataMsgSubscribeStats

Estatísticas de assinatura de mensagens de dados.
CampoTipoPadrãoDescrição
trackTypeAoqTrackType—Tipo de track
bitratenumber—Bitrate atual em bps
bytesnumber—Bytes recebidos acumulados
O tipo está definido, mas onStats ainda não preenche esse array.

AoqNetworkStats

Estatísticas de rede. Os bitrates medem bits/s do payload da aplicação; os totais usam a mesma base em bytes. Excluem sondagens e overhead do protocolo de transporte.
CampoTipoPadrãoDescrição
sendBitratenumber—Bitrate de uplink em bps
sendBytesnumber—Bytes de uplink acumulados
recvBitratenumber—Bitrate de downlink em bps
recvBytesnumber—Bytes de downlink acumulados
lossnumber—Proporção opcional de perda no uplink (0–1). Prioriza observações QUIC do navegador; caso contrário, usa estimativa Relay Datagram. Omitida se desconhecida.
rttnumber—Tempo de ida e volta opcional em ms; omitido se desconhecido
bwenumber—Orçamento efetivo opcional de envio da aplicação Client→Relay, em bps; omitido se desconhecido ou desatualizado
audioReserveBpsnumber—Bitrate opcional reservado ao payload do áudio codificado atual, em bps. Exclui redundância RED e overhead de transporte; não é tráfego real de áudio.

Enums

AoqTrackType

Tipo de mídia do track.
Membro do enumValorDescrição
AoqTrackTypeAudio0Áudio
AoqTrackTypeVideo1Vídeo
AoqTrackTypeData2Mensagens de dados
AoqTrackTypeScreen3Reservado; não aceito no fluxo de conexão atual

AoqTrackMode

Modo de transporte de áudio.
Membro do enumValorDescrição
AoqTrackModeSegment0Modo Segment
AoqTrackModeStream1Modo de fluxo Realtime

AoqEncoderType

Formato de mídia do track.
Membro do enumValorDescrição
AoqEncoderTypeUnknown0Desconhecido
AoqEncoderTypeAudioPCM1Áudio PCM
AoqEncoderTypeAudioOpus2Áudio Opus
AoqEncoderTypeVideoH2643Vídeo H.264
AoqEncoderTypeVideoJpeg4Vídeo JPEG
AoqEncoderTypeDataText5Dados de texto

AoqConnectionStatus

Status de conexão do mecanismo.
Membro do enumValorDescrição
AoqConnectionStatusDisconnected0Desconectado
AoqConnectionStatusConnecting1Conectando
AoqConnectionStatusConnected2Conectado
AoqConnectionStatusFailed3Falha na conexão

AoqErrorCode

Códigos de erro.
Membro do enumValorDescrição
AoqECOK0Sucesso
AoqECParamInvalid1Parâmetro inválido
AoqECStateInvalid2Estado inválido
AoqECUnSupport3Não implementado para a plataforma/modo atual
AoqECAudio100Erro geral de áudio
AoqECAudioExternalBufferFull110Buffer de áudio externo cheio
AoqECAudioDevice120Erro geral do dispositivo de áudio
AoqECAudioDeviceRecordingAuthFailed121Permissão do microfone negada
AoqECAudioDeviceRecordingOccupied122Microfone em uso
AoqECAudioDeviceRecordingBackgroundStart123Captura iniciada em segundo plano
AoqECAudioDeviceRecordingStartFail124Falha ao iniciar captura
AoqECAudioDevicePlayoutOccupied125Dispositivo de reprodução em uso
AoqECAudioDevicePlayoutBackgroundStart126Reprodução iniciada em segundo plano
AoqECAudioDevicePlayoutStartFail127Falha ao iniciar reprodução
AoqECAudioDeviceEarpieceRequiresVoipMode128Fone de ouvido requer modo VoIP
AoqECVideo200Erro geral de vídeo
AoqECVideoExternalBufferFull210Buffer de vídeo externo cheio
AoqECVideoExternalCaptureNotEnabled211Captura de vídeo externa não ativada
AoqECVideoExternalEncoderNotEnabled212Codificador de vídeo externo não ativado
AoqECVideoDevice220Erro geral do dispositivo de vídeo
AoqECVideoDeviceCameraOpenFail221Falha ao abrir câmera
AoqECVideoDeviceCameraAuthFailed222Permissão da câmera negada
AoqECVideoDeviceCameraOccupied223Câmera em uso
AoqECVideoDeviceCameraRunningError224Erro de execução da câmera
AoqECVideoCodec230Erro geral de codec de vídeo
AoqECVideoCodecEncoderInitFail231Falha na inicialização do codificador de vídeo
AoqECVideoRender240Erro geral de renderização de vídeo
AoqECVideoRenderCreateFail241Falha ao criar renderizador
AoqECVideoRenderDrawError242Erro de desenho na renderização

AoqWarningCode

Códigos de aviso.
Membro do enumValorDescrição
AoqWCOK0Normal
AoqWCAudio100Aviso geral de áudio
AoqWCAudioHowling101Realimentação acústica detectada
AoqWCAudioDevice120Aviso geral do dispositivo de áudio
AoqWCAudioDeviceMicEnumerateError121Erro de enumeração de microfones
AoqWCAudioDeviceMicStartTimeout122Timeout ao iniciar microfone
AoqWCAudioDeviceRecordingError123Erro de captura
AoqWCAudioDeviceSpeakerEnumerateError124Erro de enumeração de alto-falantes
AoqWCAudioDeviceSpeakerStartTimeout125Timeout ao iniciar alto-falante
AoqWCAudioDevicePlayoutError126Erro de reprodução
AoqWCAudioDeviceSilentMode127Dispositivo em modo silencioso
AoqWCVideo200Aviso geral de vídeo
AoqWCVideoCameraEnumerateError201Erro de enumeração de câmeras
AoqWCVideoEncoderSwitched202Codificador de vídeo trocado
AoqWCVideoRenderDowngrade203Renderização alternativa

AoqAudioDeviceStateCode

Códigos de estado do dispositivo de áudio.
Membro do enumValorDescrição
AoqAudioDeviceNone0Sem estado
AoqAudioDeviceRecordStarting1Iniciando captura
AoqAudioDeviceRecordStarted2Captura iniciada
AoqAudioDeviceRecordStopping3Parando captura
AoqAudioDeviceRecordStopped4Captura parada
AoqAudioDeviceRecordFail5Falha na captura
AoqAudioDevicePlayStarting6Iniciando reprodução
AoqAudioDevicePlayStarted7Reprodução iniciada
AoqAudioDevicePlayStopping8Parando reprodução
AoqAudioDevicePlayStopped9Reprodução parada
AoqAudioDevicePlayFail10Falha na reprodução

AoqAudioDeviceRouteType

Tipos de rota do dispositivo de áudio.
Membro do enumValorDescrição
AoqAudioDeviceRouteDefault0Rota padrão
AoqAudioDeviceRouteHeadset1Headset
AoqAudioDeviceRouteSpeakerPhone4Alto-falante integrado
AoqAudioDeviceRouteUsb5Dispositivo USB
AoqAudioDeviceRouteBluetooth6Dispositivo Bluetooth

AoqAudioFileStateCode

Códigos de estado de reprodução de arquivos de áudio.
Membro do enumValorDescrição
AoqAudioFileNone0Sem estado
AoqAudioFileStarted1Reprodução iniciada
AoqAudioFileStopped2Reprodução parada
AoqAudioFilePaused3Reprodução pausada
AoqAudioFileResumed4Reprodução retomada
AoqAudioFileEnded5Reprodução encerrada
AoqAudioFileBuffering6Armazenando em buffer
AoqAudioFileBufferingEnd7Armazenamento em buffer concluído
AoqAudioFileFailed8Falha na reprodução

AoqCameraDirection

Membro do enumValorDescrição
AoqCameraDirectionFront0Preferir câmera frontal
AoqCameraDirectionBack1Preferir câmera traseira

AoqVideoDeviceStateCode

Códigos de estado do dispositivo de vídeo.
Membro do enumValorDescrição
AoqVideoDeviceNone0Sem estado
AoqVideoDeviceCaptureStarting1Iniciando captura
AoqVideoDeviceCaptureStarted2Captura iniciada
AoqVideoDeviceCaptureStopping3Parando captura
AoqVideoDeviceCaptureStopped4Captura parada
AoqVideoDeviceCaptureFail5Falha na captura

AoqMirrorMode

Enum reservado de espelhamento. O Web SDK não possui configuração ou API que o utilize.
Membro do enumValorDescrição
AoqMirrorModeDisabled0Espelhamento desativado
AoqMirrorModeEnabled1Espelhamento ativado

AoqOrientationMode

Enum reservado de orientação. O Web SDK não possui configuração ou API que o utilize.
Membro do enumValorDescrição
AoqOrientationModeAuto0Automático
AoqOrientationModePortrait1Retrato
AoqOrientationModeLandscape2Paisagem

AoqRenderMode

Modos de ajuste do vídeo.
Membro do enumValorDescrição
AoqRenderModeAuto0Padrão: imagem completa mantendo a proporção
AoqRenderModeStretch1Esticar para preencher o contêiner
AoqRenderModeFill2Imagem completa mantendo a proporção, com barras pretas se necessário
AoqRenderModeCrop3Preencher mantendo a proporção e recortar o excedente

Outras declarações públicas

IAoqEngineEvents define as 10 assinaturas de callbacks de eventos, incluindo o reservado onAudioFileState. Assinar pelo nome do evento fornece inferência de parâmetros TypeScript. Os tipos e enums abaixo são exportados, mas o mecanismo Web atual não oferece APIs correspondentes de controle ou observação. Declarações de mesmo nome em outras plataformas não implicam suporte Web.
CategoriaDeclarações públicasEscopo atual
Mixagem de arquivos de áudioAoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCodeSem controle de reprodução ou mixagem de arquivos; eventos de estado de arquivo não são emitidos
Áudio externo e observadoresAoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirectionSem métodos de entrada de áudio externo ou registro de observadores de quadros de áudio
Vídeo externo e observadoresAoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecTypeSem métodos de entrada de quadros de vídeo externos ou registro de observadores de vídeo. A configuração de codec usa AoqEncoderType.
Espelhamento e orientaçãoAoqMirrorMode, AoqOrientationModeSem campos de configuração ou métodos correspondentes. O espelhamento da prévia local é automático.
Dispositivos de áudio de baixo nívelAoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCodeDeclarações de dispositivo de baixo nível, não eventos adicionais nem contrato completo de códigos de retorno do mecanismo
AOQ_TRACK_AUDIO e AOQ_TRACK_DATA são as constantes string 'aoq_track_audio' e 'aoq_track_data'. Não selecionam tracks nos métodos de conexão ou visualização; use AoqTrackType nessas APIs. Enums de erro e aviso preservam valores multiplataforma. Nem todos são necessariamente produzidos pelo Web SDK. Consulte os métodos e condições documentados aqui para determinar a disponibilidade.