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:
Lista de APIs
Ciclo de vida do mecanismo
| API | Descrição |
|---|---|
| createEngine | Criar um mecanismo singleton |
| createAoqClientEngine | Função de fábrica nomeada equivalente |
| destroy | Destruir o mecanismo |
| getVersion | Obter a versão do SDK |
| isAoqSupported | Verificar recursos do navegador |
| connect | Iniciar uma conexão |
| disconnect | Desconectar |
Gerenciamento de dispositivos de áudio
| API | Descrição |
|---|---|
| startAudioCapture | Iniciar captura de áudio |
| stopAudioCapture | Parar captura de áudio |
| muteAudioCapture | Silenciar captura de áudio |
| startAudioPlayer | Iniciar reprodução de áudio |
| stopAudioPlayer | Parar reprodução de áudio |
| pauseAudioPlayer | Pausar reprodução com fade-out |
| resumeAudioPlayer | Retomar reprodução com fade-in padrão |
| interruptAudioPlayer | Interromper reprodução |
Configuração de codificação de áudio
| API | Descrição |
|---|---|
| setAudioEncoderConfig | Definir parâmetros de codificação de áudio |
| setAudioDecoderConfig | Definir parâmetros de decodificação de áudio |
Indicação de volume local
| API | Descrição |
|---|---|
| enableLocalAudioVolumeIndication | Ativar indicação de volume local |
Gerenciamento de dispositivos de vídeo
| API | Descrição |
|---|---|
| startVideoCapture | Iniciar captura de vídeo |
| getCameras | Enumerar câmeras |
| switchCamera | Trocar câmera por preferência de direção ou ID do dispositivo |
| stopVideoCapture | Parar captura de vídeo |
| setLocalView | Definir contêiner de vídeo local |
| setRemoteView | Definir contêiner de vídeo remoto |
Configuração de codificação de vídeo
| API | Descrição |
|---|---|
| setVideoEncoderConfig | Definir parâmetros de codificação de vídeo |
| setVideoDecoderConfig | Definir parâmetros de decodificação de vídeo |
Controle de transmissão de fluxos de mídia
| API | Descrição |
|---|---|
| enableSendMediaStream | Ativar ou desativar transmissão de fluxos de mídia |
Mensagens em tempo real
| API | Descrição |
|---|---|
| sendDataMsg | Enviar uma mensagem de dados |
Callbacks de eventos
| API | Descrição |
|---|---|
| onError | Callback de erro |
| onWarning | Callback de aviso |
| onConnectionStatusChange | Alterações no status da conexão |
| onStats | Estatísticas |
| onAudioDeviceStateChanged | Alterações no estado do dispositivo de áudio |
| onAudioDeviceRouteChanged | Alterações na rota de áudio |
| onAudioFileState | Evento reservado de estado de arquivo de áudio; não é emitido atualmente |
| onLocalAudioVolumeIndication | Indicação de volume local |
| onVideoDeviceStateChanged | Alterações no estado do dispositivo de vídeo |
| onDataMsg | Mensagens de dados |
Detalhes das APIs
Ciclo de vida do mecanismo
createEngine
Cria um mecanismo singleton. Chamadas repetidas retornam a instância existente.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqCreateConfig | Configuração de criação do mecanismo |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqCreateConfig | Obrigatório; {} é válido. A criação repetida não reaplica a configuração. |
null em caso de falha.
destroy
Destrói o mecanismo, inicia a liberação de recursos e remove todos os listeners de eventos.
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.
isAoqSupported
Verifica os recursos básicos do navegador necessários para uma conexão AOQ.
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqConnectConfig | Credenciais de conexão, incluindo token, ID da sessão e endpoints de relay |
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.
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqAudioCaptureConfig | Configuração de captura de áudio |
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.
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
mute | boolean | true: silenciar; false: reativar |
0 em caso de sucesso.
startAudioPlayer
Inicia o reprodutor e inicializa o dispositivo de saída de forma assíncrona.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqAudioPlaybackConfig | Configuração de reprodução de áudio |
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.
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
fadeMs | number | Duraçã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. |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
fadeMs | number | Reservado e atualmente ignorado. O fade-in padrão é usado; passar 0 não o desativa. |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
trackType | AoqTrackType | Parâmetro de compatibilidade. Use Audio. Atualmente, não seleciona um fluxo de reprodução. |
fadeMs | number | Duraçã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. |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqAudioCodecConfig | Configuração de codificação de áudio |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqAudioCodecConfig | Configuração de decodificação de áudio |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqAudioVolumeIndicationConfig | Configuração de indicação de volume |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqVideoCaptureConfig | Configuração de captura de vídeo |
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
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
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cameraPreference | AoqCameraDirection | string | Não | Direção ou ID preferido. Omita para limpar a preferência anterior e permitir nova escolha pelo navegador. |
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.
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
trackType | AoqTrackType | Somente AoqTrackTypeVideo é aceito. Outros tipos retornam AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Configuração do contêiner de renderização. Passe null para desvincular. |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
trackType | AoqTrackType | Somente AoqTrackTypeVideo é aceito. Outros tipos retornam AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Configuração do contêiner de renderização. Passe null para desvincular. |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqVideoCodecConfig | Configuração de codificação de vídeo |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
config | AoqVideoCodecConfig | Configuração de decodificação de vídeo |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
trackType | AoqTrackType | Tipo de track de mídia |
enable | boolean | true: ativar transmissão; false: desativar transmissão |
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
msg | AoqDataMsg | Objeto de mensagem; msg.data deve conter bytes UTF-8 não vazios |
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.
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.
| Evento | Assinatura do callback | Descrição |
|---|---|---|
onError | (code: number, message: string) => void | Callback de erro |
onWarning | (code: number, message: string) => void | Callback de aviso |
onConnectionStatusChange | (status: AoqConnectionStatus) => void | Alterações no status da conexão |
onStats | (stats: AoqStats) => void | Estatísticas |
onAudioDeviceStateChanged | (state: AoqAudioDeviceState) => void | Alterações no estado do dispositivo de áudio |
onAudioDeviceRouteChanged | (routeType: AoqAudioDeviceRouteType) => void | Alterações na rota de áudio |
onAudioFileState | (state: AoqAudioFileState) => void | Reservado; não é emitido atualmente |
onLocalAudioVolumeIndication | (volume: AoqAudioVolume) => void | Indicação de volume local |
onVideoDeviceStateChanged | (state: AoqVideoDeviceState) => void | Alterações no estado do dispositivo de vídeo |
onDataMsg | (msg: AoqDataMsg) => void | Mensagens 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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
code | number | Código de erro; consulte AoqErrorCode |
message | string | Descrição do erro |
onWarning
Informa avisos do mecanismo sobre condições não fatais que exigem atenção.
| Parâmetro | Tipo | Descrição |
|---|---|---|
code | number | Código de aviso; consulte AoqWarningCode |
message | string | Descrição do aviso |
onConnectionStatusChange
Informa alterações no status da conexão.
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | AoqConnectionStatus | Status 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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
stats | AoqStats | Objeto de estatísticas |
onAudioDeviceStateChanged
Informa mudanças no estado das operações de captura e reprodução de áudio.
| Parâmetro | Tipo | Descrição |
|---|---|---|
state | AoqAudioDeviceState | Estado 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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
routeType | AoqAudioDeviceRouteType | Rota 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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
state | AoqAudioFileState | Estado do arquivo de áudio |
onLocalAudioVolumeIndication
Informa o volume da captura local. Ative primeiro com enableLocalAudioVolumeIndication.
| Parâmetro | Tipo | Descrição |
|---|---|---|
volume | AoqAudioVolume | Informações de volume |
onVideoDeviceStateChanged
Informa mudanças no estado das operações do dispositivo de captura de vídeo.
| Parâmetro | Tipo | Descrição |
|---|---|---|
state | AoqVideoDeviceState | Estado do dispositivo de vídeo |
onDataMsg
Informa mensagens de dados recebidas.
| Parâmetro | Tipo | Descrição |
|---|---|---|
msg | AoqDataMsg | Objeto de mensagem recebido. Use TextDecoder para ler o texto UTF-8 de msg.data. |
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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
workDir | string | Não | — | Reservado; o Web SDK não usa este campo para selecionar o diretório de armazenamento |
enableDumpAudio | boolean | Não | false | Salva áudio de depuração. Obtenha autorização e controle o acesso ao áudio do usuário. |
enableDumpExport | boolean | Não | false | Válido somente com enableDumpAudio=true. Exporta um ZIP de dump e remove os arquivos OPFS correspondentes de forma assíncrona na destruição. |
maxEncodedVideoFrameBytes | number | Não | 194560 (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. |
enableDropOversizedVideoFrame | boolean | Não | false | Descarta 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. |
extras | string | Não | — | String de objeto JSON. JSON inválido, valor não objeto ou política remota inválida faz createEngine retornar null. |
extras aceitos:
| Campo JSON | Tipo | Padrão | Descriçã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_sync | boolean | true | Ativar sincronização de áudio/vídeo. Use um booleano JSON. |
user_specified_audio_playback_transport | 'message-port' | Automático | Força reprodução por MessagePort. Se omitido, seleciona memória compartilhada ou MessagePort conforme o ambiente. |
AoqConnectConfig
Configuração de autenticação da conexão.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
token | string | Sim | — | Token temporário não vazio do cliente, correspondente a aoqTokenForClient, não uma API key |
sid | string | Sim | — | ID de sessão não vazio. Use a string sid completa da resposta de autenticação. |
wtBaseUrl | string | Não | Derivado do Relay | URL HTTPS WT preferida para rota única. Ignorada com múltiplas rotas, que se conectam a /aoq em cada host e porta. |
signedSid | string | Sim (em execução) | — | SID assinado completo, normalmente o sid completo da autenticação. Opcional no TypeScript, mas obrigatório no fluxo WT atual. |
certFingerprint | string | string[] | Condicional | — | Impressão digital SHA-256 compartilhada do certificado WT. Rotas sem valor próprio devem poder usar esse valor. |
workspaceIdHash | string | Não | — | Corresponde a extraInfo.workspaceIdHash. Não substitua pelo Workspace ID original. |
relayEndpoints | AoqRelayEndpoint[] | Sim | — | Lista completa de endpoints com ao menos uma entrada |
publishTracks | AoqTrackParam[] | Sim | — | Tracks de uplink. Pode ser vazio, mas não junto com subscribeTracks. |
subscribeTracks | AoqTrackParam[] | Sim | — | Tracks de downlink. Pode ser vazio. Tracks duplicados na mesma direção e Screen não são aceitos. |
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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
routeIndex | number | Sim (em execução) | — | Inteiro único entre 0 e 2147483647. O menor índice é escolhido inicialmente. Opcional no TypeScript. |
certFingerprint | string | string[] | Condicional | Impressão digital compartilhada | Valor não vazio da rota substitui o compartilhado. Obrigatório se não houver impressão digital compartilhada. |
endpoint | string | Sim | — | Host ou IP WT sem esquema, caminho, espaços, dados de usuário nem query string. Suporta IPv6. |
port | number | Sim | — | Porta WT, inteiro entre 1 e 65535 |
AoqTrackParam
Propriedades do track.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
trackType | AoqTrackType | Sim | — | Audio, Video ou Data. Sem duplicatas na mesma direção. Screen ainda não é aceito. |
trackMode | AoqTrackMode | Não | Segment para áudio de downlink | Controla 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.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
supported | boolean | — | Se o ambiente oferece os recursos básicos de conexão AOQ |
missingFeatures | AoqMissingFeature[] | — | 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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
channel | number | Não | 1 | Canais solicitados: 1 (mono) ou 2 (estéreo). Os valores reais podem depender do track do dispositivo. |
AoqAudioPlaybackConfig
Configuração de reprodução de áudio.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
channel | number | Não | 1 | Canais solicitados: 1 ou 2. A saída usa a taxa de amostragem real do AudioContext. |
playOnlyAndIgnoreMute | boolean | Não | false | Para 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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
trackType | AoqTrackType | Não | — | Reservado; não seleciona um fluxo de áudio atualmente |
codecType | AoqEncoderType | Não | AoqEncoderTypeAudioPCM | PCM / Opus. Deve corresponder à configuração negociada com o peer. |
sampleRate | number | Não | 48000 | Taxa em Hz. Valores negociados: 8000, 12000, 16000, 24000, 32000, 44100, 48000. O navegador também deve oferecer suporte à codificação escolhida. |
channel | number | Não | 1 | Quantidade de canais: 1 ou 2 |
bitrate | number | Não | 32000 (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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
interval | number | Não | 0 | Intervalo de callback em ms. Valores <=0 desativam; valores positivos inferiores a 10 são tratados como 10. |
smooth | number | Não | 3 | Fator de suavização de volume, 0..10. Valores maiores suavizam mais. |
reportSpeech | boolean | Não | false | Informar atividade de voz (VAD) |
AoqAudioVolume
Informações de volume local.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
volume | number | — | Volume instantâneo suavizado, intervalo [0-255] |
isSpeech | boolean | — | 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.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
state | AoqAudioDeviceStateCode | — | Código de estado do dispositivo de áudio |
reason | number | — | 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.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
fileId | string | — | ID do arquivo de áudio |
stateCode | AoqAudioFileStateCode | — | Código de estado de reprodução do arquivo |
errorCode | number | — | Código de erro |
Tipos de vídeo
AoqVideoCaptureConfig
Configuração de captura de vídeo.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
width | number | Não | 1280 | Largura de captura solicitada em pixels, restrição ideal. O navegador/dispositivo determina o valor real. |
height | number | Não | 720 | Altura de captura solicitada em pixels, restrição ideal. O navegador/dispositivo determina o valor real. |
fps | number | Não | 15 | Taxa de quadros solicitada, restrições ideal e max |
cameraPreference | AoqCameraDirection | string | Não | Escolha do navegador | Preferê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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
trackType | AoqTrackType | Não | — | Reservado; não seleciona um fluxo de vídeo atualmente |
codecType | AoqEncoderType | Não | AoqEncoderTypeVideoH264 | H.264 / JPEG. Deve corresponder à configuração negociada com o peer. |
width | number | Não | 540 | Largura alvo de codificação ou negociada no downlink, em pixels. Deve ser inteiro positivo ao conectar. |
height | number | Não | 960 | Altura alvo de codificação ou negociada no downlink, em pixels. Deve ser inteiro positivo ao conectar. |
fps | number | Não | 5 | Taxa de quadros de codificação ou negociada no downlink. Deve ser inteiro positivo ao conectar. |
bitrate | number | Não | 500000 (codificação) | Bitrate alvo positivo de codificação em bps. Não usado na decodificação. |
minBitrate | number | Não | 128000 | Bitrate 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. |
keyframeInterval | number | Não | 2 | Intervalo 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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
view | HTMLElement | string | Sim | — | Contêiner comum ou seu ID DOM sem #. Não use diretamente video, audio, canvas, img nem elementos vazios. |
renderMode | AoqRenderMode | Não | AoqRenderModeAuto(0) | Modo de ajuste do vídeo |
AoqVideoDeviceState
Dados do callback de estado do dispositivo de vídeo.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
state | AoqVideoDeviceStateCode | — | Código de estado do dispositivo de vídeo |
reason | number | — | 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.
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
data | Uint8Array | Sim | — | 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.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
audioPublishStats | AoqAudioPublishStats[] | — | Estatísticas de publicação de áudio |
audioSubscribeStats | AoqAudioSubscribeStats[] | — | Estatísticas de assinatura de áudio |
videoPublishStats | AoqVideoPublishStats[] | — | Estatísticas de publicação de vídeo |
videoSubscribeStats | AoqVideoSubscribeStats[] | — | Estatísticas de assinatura de vídeo |
dataMsgPublishStats | AoqDataMsgPublishStats[] | — | Estatísticas de publicação de mensagens de dados |
dataMsgSubscribeStats | AoqDataMsgSubscribeStats[] | — | Estatísticas de assinatura de mensagens de dados |
networkStats | AoqNetworkStats | — | Estatísticas de rede |
AoqAudioPublishStats
Estatísticas de publicação de áudio.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de track |
bitrate | number | — | Bitrate total de aplicação no uplink da conexão, em bps, não apenas áudio |
bytes | number | — | Bytes totais de aplicação no uplink da conexão, não apenas áudio |
encodeVolume | number | 0 | Valor de preenchimento. Use onLocalAudioVolumeIndication para volume de captura. |
AoqAudioSubscribeStats
Estatísticas de assinatura de áudio.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de track |
bitrate | number | — | Bitrate total de aplicação no downlink da conexão, em bps, não apenas áudio |
bytes | number | — | Bytes totais de aplicação no downlink da conexão, não apenas áudio |
playVolume | number | 0 | Valor de preenchimento; não indica se a reprodução está silenciada |
AoqVideoPublishStats
Estatísticas de publicação de vídeo.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de track |
bitrate | number | 0 | Valor de preenchimento; bitrate de vídeo isolado ainda não informado |
bytes | number | 0 | Valor de preenchimento; contagem de bytes de vídeo isolada ainda não informada |
encodeFps | number | — | Taxa de quadros de codificação |
AoqVideoSubscribeStats
Estatísticas de assinatura de vídeo.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de track |
bitrate | number | 0 | Valor de preenchimento; bitrate de vídeo isolado ainda não informado |
bytes | number | 0 | Valor de preenchimento; contagem de bytes de vídeo isolada ainda não informada |
decodeFps | number | — | Taxa de quadros de decodificação |
renderFps | number | — | Taxa de quadros de renderização |
AoqDataMsgPublishStats
Estatísticas de publicação de mensagens de dados.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de track |
bitrate | number | — | Bitrate atual em bps |
bytes | number | — | Bytes enviados acumulados |
AoqDataMsgSubscribeStats
Estatísticas de assinatura de mensagens de dados.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de track |
bitrate | number | — | Bitrate atual em bps |
bytes | number | — | Bytes recebidos acumulados |
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.
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
sendBitrate | number | — | Bitrate de uplink em bps |
sendBytes | number | — | Bytes de uplink acumulados |
recvBitrate | number | — | Bitrate de downlink em bps |
recvBytes | number | — | Bytes de downlink acumulados |
loss | number | — | 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. |
rtt | number | — | Tempo de ida e volta opcional em ms; omitido se desconhecido |
bwe | number | — | Orçamento efetivo opcional de envio da aplicação Client→Relay, em bps; omitido se desconhecido ou desatualizado |
audioReserveBps | number | — | 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 enum | Valor | Descrição |
|---|---|---|
AoqTrackTypeAudio | 0 | Áudio |
AoqTrackTypeVideo | 1 | Vídeo |
AoqTrackTypeData | 2 | Mensagens de dados |
AoqTrackTypeScreen | 3 | Reservado; não aceito no fluxo de conexão atual |
AoqTrackMode
Modo de transporte de áudio.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqTrackModeSegment | 0 | Modo Segment |
AoqTrackModeStream | 1 | Modo de fluxo Realtime |
AoqEncoderType
Formato de mídia do track.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqEncoderTypeUnknown | 0 | Desconhecido |
AoqEncoderTypeAudioPCM | 1 | Áudio PCM |
AoqEncoderTypeAudioOpus | 2 | Áudio Opus |
AoqEncoderTypeVideoH264 | 3 | Vídeo H.264 |
AoqEncoderTypeVideoJpeg | 4 | Vídeo JPEG |
AoqEncoderTypeDataText | 5 | Dados de texto |
AoqConnectionStatus
Status de conexão do mecanismo.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqConnectionStatusDisconnected | 0 | Desconectado |
AoqConnectionStatusConnecting | 1 | Conectando |
AoqConnectionStatusConnected | 2 | Conectado |
AoqConnectionStatusFailed | 3 | Falha na conexão |
AoqErrorCode
Códigos de erro.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqECOK | 0 | Sucesso |
AoqECParamInvalid | 1 | Parâmetro inválido |
AoqECStateInvalid | 2 | Estado inválido |
AoqECUnSupport | 3 | Não implementado para a plataforma/modo atual |
AoqECAudio | 100 | Erro geral de áudio |
AoqECAudioExternalBufferFull | 110 | Buffer de áudio externo cheio |
AoqECAudioDevice | 120 | Erro geral do dispositivo de áudio |
AoqECAudioDeviceRecordingAuthFailed | 121 | Permissão do microfone negada |
AoqECAudioDeviceRecordingOccupied | 122 | Microfone em uso |
AoqECAudioDeviceRecordingBackgroundStart | 123 | Captura iniciada em segundo plano |
AoqECAudioDeviceRecordingStartFail | 124 | Falha ao iniciar captura |
AoqECAudioDevicePlayoutOccupied | 125 | Dispositivo de reprodução em uso |
AoqECAudioDevicePlayoutBackgroundStart | 126 | Reprodução iniciada em segundo plano |
AoqECAudioDevicePlayoutStartFail | 127 | Falha ao iniciar reprodução |
AoqECAudioDeviceEarpieceRequiresVoipMode | 128 | Fone de ouvido requer modo VoIP |
AoqECVideo | 200 | Erro geral de vídeo |
AoqECVideoExternalBufferFull | 210 | Buffer de vídeo externo cheio |
AoqECVideoExternalCaptureNotEnabled | 211 | Captura de vídeo externa não ativada |
AoqECVideoExternalEncoderNotEnabled | 212 | Codificador de vídeo externo não ativado |
AoqECVideoDevice | 220 | Erro geral do dispositivo de vídeo |
AoqECVideoDeviceCameraOpenFail | 221 | Falha ao abrir câmera |
AoqECVideoDeviceCameraAuthFailed | 222 | Permissão da câmera negada |
AoqECVideoDeviceCameraOccupied | 223 | Câmera em uso |
AoqECVideoDeviceCameraRunningError | 224 | Erro de execução da câmera |
AoqECVideoCodec | 230 | Erro geral de codec de vídeo |
AoqECVideoCodecEncoderInitFail | 231 | Falha na inicialização do codificador de vídeo |
AoqECVideoRender | 240 | Erro geral de renderização de vídeo |
AoqECVideoRenderCreateFail | 241 | Falha ao criar renderizador |
AoqECVideoRenderDrawError | 242 | Erro de desenho na renderização |
AoqWarningCode
Códigos de aviso.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqWCOK | 0 | Normal |
AoqWCAudio | 100 | Aviso geral de áudio |
AoqWCAudioHowling | 101 | Realimentação acústica detectada |
AoqWCAudioDevice | 120 | Aviso geral do dispositivo de áudio |
AoqWCAudioDeviceMicEnumerateError | 121 | Erro de enumeração de microfones |
AoqWCAudioDeviceMicStartTimeout | 122 | Timeout ao iniciar microfone |
AoqWCAudioDeviceRecordingError | 123 | Erro de captura |
AoqWCAudioDeviceSpeakerEnumerateError | 124 | Erro de enumeração de alto-falantes |
AoqWCAudioDeviceSpeakerStartTimeout | 125 | Timeout ao iniciar alto-falante |
AoqWCAudioDevicePlayoutError | 126 | Erro de reprodução |
AoqWCAudioDeviceSilentMode | 127 | Dispositivo em modo silencioso |
AoqWCVideo | 200 | Aviso geral de vídeo |
AoqWCVideoCameraEnumerateError | 201 | Erro de enumeração de câmeras |
AoqWCVideoEncoderSwitched | 202 | Codificador de vídeo trocado |
AoqWCVideoRenderDowngrade | 203 | Renderização alternativa |
AoqAudioDeviceStateCode
Códigos de estado do dispositivo de áudio.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqAudioDeviceNone | 0 | Sem estado |
AoqAudioDeviceRecordStarting | 1 | Iniciando captura |
AoqAudioDeviceRecordStarted | 2 | Captura iniciada |
AoqAudioDeviceRecordStopping | 3 | Parando captura |
AoqAudioDeviceRecordStopped | 4 | Captura parada |
AoqAudioDeviceRecordFail | 5 | Falha na captura |
AoqAudioDevicePlayStarting | 6 | Iniciando reprodução |
AoqAudioDevicePlayStarted | 7 | Reprodução iniciada |
AoqAudioDevicePlayStopping | 8 | Parando reprodução |
AoqAudioDevicePlayStopped | 9 | Reprodução parada |
AoqAudioDevicePlayFail | 10 | Falha na reprodução |
AoqAudioDeviceRouteType
Tipos de rota do dispositivo de áudio.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqAudioDeviceRouteDefault | 0 | Rota padrão |
AoqAudioDeviceRouteHeadset | 1 | Headset |
AoqAudioDeviceRouteSpeakerPhone | 4 | Alto-falante integrado |
AoqAudioDeviceRouteUsb | 5 | Dispositivo USB |
AoqAudioDeviceRouteBluetooth | 6 | Dispositivo Bluetooth |
AoqAudioFileStateCode
Códigos de estado de reprodução de arquivos de áudio.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqAudioFileNone | 0 | Sem estado |
AoqAudioFileStarted | 1 | Reprodução iniciada |
AoqAudioFileStopped | 2 | Reprodução parada |
AoqAudioFilePaused | 3 | Reprodução pausada |
AoqAudioFileResumed | 4 | Reprodução retomada |
AoqAudioFileEnded | 5 | Reprodução encerrada |
AoqAudioFileBuffering | 6 | Armazenando em buffer |
AoqAudioFileBufferingEnd | 7 | Armazenamento em buffer concluído |
AoqAudioFileFailed | 8 | Falha na reprodução |
AoqCameraDirection
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqCameraDirectionFront | 0 | Preferir câmera frontal |
AoqCameraDirectionBack | 1 | Preferir câmera traseira |
AoqVideoDeviceStateCode
Códigos de estado do dispositivo de vídeo.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqVideoDeviceNone | 0 | Sem estado |
AoqVideoDeviceCaptureStarting | 1 | Iniciando captura |
AoqVideoDeviceCaptureStarted | 2 | Captura iniciada |
AoqVideoDeviceCaptureStopping | 3 | Parando captura |
AoqVideoDeviceCaptureStopped | 4 | Captura parada |
AoqVideoDeviceCaptureFail | 5 | Falha na captura |
AoqMirrorMode
Enum reservado de espelhamento. O Web SDK não possui configuração ou API que o utilize.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqMirrorModeDisabled | 0 | Espelhamento desativado |
AoqMirrorModeEnabled | 1 | Espelhamento ativado |
AoqOrientationMode
Enum reservado de orientação. O Web SDK não possui configuração ou API que o utilize.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqOrientationModeAuto | 0 | Automático |
AoqOrientationModePortrait | 1 | Retrato |
AoqOrientationModeLandscape | 2 | Paisagem |
AoqRenderMode
Modos de ajuste do vídeo.
| Membro do enum | Valor | Descrição |
|---|---|---|
AoqRenderModeAuto | 0 | Padrão: imagem completa mantendo a proporção |
AoqRenderModeStretch | 1 | Esticar para preencher o contêiner |
AoqRenderModeFill | 2 | Imagem completa mantendo a proporção, com barras pretas se necessário |
AoqRenderModeCrop | 3 | Preencher 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.
| Categoria | Declarações públicas | Escopo atual |
|---|---|---|
| Mixagem de arquivos de áudio | AoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCode | Sem controle de reprodução ou mixagem de arquivos; eventos de estado de arquivo não são emitidos |
| Áudio externo e observadores | AoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirection | Sem métodos de entrada de áudio externo ou registro de observadores de quadros de áudio |
| Vídeo externo e observadores | AoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecType | Sem 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ção | AoqMirrorMode, AoqOrientationMode | Sem campos de configuração ou métodos correspondentes. O espelhamento da prévia local é automático. |
| Dispositivos de áudio de baixo nível | AoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCode | Declaraçõ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.