Skip to main content

Referencia de la API del SDK web de AOQ

El SDK web de AOQ admite interacciones de audio, video y datos en tiempo real en navegadores. Esta referencia describe las API de administración del motor, captura y reproducción de audio y video, mensajes de datos y callbacks de eventos.

Instalar el SDK

El SDK web de AOQ se conecta al servidor mediante WebTransport (HTTP/3 / QUIC) e intercambia audio, video y mensajes de datos en un Worker. Requiere un navegador compatible con WebTransport y un contexto seguro HTTPS. Use AoqClientEngine.isAoqSupported() para comprobar las capacidades básicas del navegador. Instale el SDK mediante npm:
npm install aoq-web-sdk@1.0.1-60040320
También puede obtener el paquete de instalación en Descarga del SDK y ejecutar el siguiente comando en el directorio del proyecto. Sustituya la ruta del paquete por su ubicación real.
npm install ./aoq-web-sdk-1.0.1-60040320.tgz

Lista de API

Ciclo de vida del motor

APIDescripción
createEngineCrear un motor singleton
createAoqClientEngineFunción de fábrica con nombre equivalente
destroyDestruir el motor
getVersionObtener la versión del SDK
isAoqSupportedComprobar capacidades del navegador
connectIniciar una conexión
disconnectDesconectar

Administración de dispositivos de audio

APIDescripción
startAudioCaptureIniciar captura de audio
stopAudioCaptureDetener captura de audio
muteAudioCaptureSilenciar captura de audio
startAudioPlayerIniciar reproducción de audio
stopAudioPlayerDetener reproducción de audio
pauseAudioPlayerPausar reproducción con atenuación de salida
resumeAudioPlayerReanudar reproducción con atenuación de entrada predeterminada
interruptAudioPlayerInterrumpir reproducción

Configuración de codificación de audio

APIDescripción
setAudioEncoderConfigEstablecer parámetros de codificación de audio
setAudioDecoderConfigEstablecer parámetros de decodificación de audio

Indicación de volumen local

APIDescripción
enableLocalAudioVolumeIndicationActivar indicación de volumen local

Administración de dispositivos de video

APIDescripción
startVideoCaptureIniciar captura de video
getCamerasEnumerar cámaras
switchCameraCambiar de cámara según orientación preferida o ID del dispositivo
stopVideoCaptureDetener captura de video
setLocalViewEstablecer contenedor de video local
setRemoteViewEstablecer contenedor de video remoto

Configuración de codificación de video

APIDescripción
setVideoEncoderConfigEstablecer parámetros de codificación de video
setVideoDecoderConfigEstablecer parámetros de decodificación de video

Control de transmisión de flujos multimedia

APIDescripción
enableSendMediaStreamActivar o desactivar transmisión de flujos multimedia

Mensajes en tiempo real

APIDescripción
sendDataMsgEnviar un mensaje de datos

Callbacks de eventos

APIDescripción
onErrorCallback de error
onWarningCallback de advertencia
onConnectionStatusChangeCambios de estado de conexión
onStatsEstadísticas
onAudioDeviceStateChangedCambios de estado del dispositivo de audio
onAudioDeviceRouteChangedCambios de ruta de audio
onAudioFileStateEvento reservado de estado de archivo de audio; actualmente no se emite
onLocalAudioVolumeIndicationIndicación de volumen local
onVideoDeviceStateChangedCambios de estado del dispositivo de video
onDataMsgMensajes de datos

Detalles de API

Ciclo de vida del motor

createEngine

Crea un motor singleton. Las llamadas repetidas devuelven la instancia existente.
static createEngine(config: AoqCreateConfig): AoqClientEngine | null
ParámetroTipoDescripción
configAoqCreateConfigConfiguración de creación del motor
Devuelve una instancia de AoqClientEngine si tiene éxito, o null si falla. Devuelve el singleton inicializado sin aplicar de nuevo la configuración. Destrúyalo antes de crear un motor con una configuración nueva.

createAoqClientEngine

Fábrica con nombre exportada por el paquete, equivalente a AoqClientEngine.createEngine(config). No es un método de instancia y no requiere inicialización adicional.
function createAoqClientEngine(config: AoqCreateConfig): AoqClientEngine | null
ParámetroTipoDescripción
configAoqCreateConfigObligatorio; {} es válido. La creación repetida no aplica de nuevo la configuración.
Devuelve el motor singleton si tiene éxito, o null si falla.
import { createAoqClientEngine } from 'aoq-web-sdk';

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

destroy

Destruye el motor, inicia la liberación de recursos y elimina todos los listeners de eventos.
static destroy(): number
Devuelve 0 si tiene éxito, o AoqECStateInvalid(2) si no existe una instancia. El método devuelve de forma síncrona. Guardar registros y exportar dumps opcionales son tareas asíncronas y pueden seguir ejecutándose. Cree un motor nuevo con createEngine antes de volver a usar el SDK; no reutilice la instancia destruida.

getVersion

Obtiene la versión del SDK.
static getVersion(): string
Devuelve como cadena la versión del paquete instalado, no la revisión del documento ni el ID de commit del código fuente.

isAoqSupported

Comprueba las capacidades básicas del navegador necesarias para una conexión AOQ.
static isAoqSupported(): Promise<AoqSupportResult>
Devuelve Promise<AoqSupportResult> con el resultado y las capacidades faltantes. La comprobación prueba WebTransport en un Worker con un tiempo de espera de 5 segundos. No comprueba acceso de red, configuración del servidor, autenticación, permisos de dispositivos ni configuraciones multimedia específicas. supported: true no garantiza una conexión o llamada correcta.

connect

Inicia una conexión con el servidor.
connect(config: AoqConnectConfig): number
ParámetroTipoDescripción
configAoqConnectConfigCredenciales de conexión, incluidos token, ID de sesión y endpoints de relay
Devuelve 0 cuando se acepta la solicitud. Llame después de crear el motor, registrar eventos y configurar códecs. La conexión normalmente parte de Disconnected; también se permite reintentar desde Failed. Otros estados devuelven AoqECStateInvalid(2). Parámetros de pista, medios o conexión no válidos, o seleccionar Opus sin las capacidades WebCodecs necesarias, pueden devolver AoqECParamInvalid(1). Un Network Worker no disponible devuelve AoqECStateInvalid(2). El resultado se comunica de forma asíncrona mediante onConnectionStatusChange. Connected indica que MEDIA_SETUP terminó y las pistas están vinculadas. Configure la sesión según el protocolo de datos del modelo y confirme que la aplicación está lista antes de activar el envío de audio o video.

disconnect

Desconecta del servidor.
disconnect(): number
Devuelve 0 cuando se acepta la solicitud. El resultado se comunica mediante onConnectionStatusChange. Espere AoqConnectionStatusDisconnected antes de modificar códecs y reconectar. Llamar cuando ya está desconectado devuelve AoqECStateInvalid(2). Desconectar no detiene dispositivos; llame también a los métodos para detener captura y reproducción al finalizar una llamada.

Administración de dispositivos de audio

startAudioCapture

Inicia la captura del micrófono y solicita permiso de forma asíncrona.
startAudioCapture(config: AoqAudioCaptureConfig): Promise<number>
ParámetroTipoDescripción
configAoqAudioCaptureConfigConfiguración de captura de audio
Devuelve Promise<number>; 0 indica éxito. El navegador puede solicitar permiso de micrófono al primer uso o si aún no se ha concedido. Los cambios de estado se notifican mediante onAudioDeviceStateChanged. Durante congestión, se descarta el audio ascendente que espera aproximadamente 100 ms en la cola de envío para evitar acumular latencia. No se retira el audio cuyo envío ya comenzó. Este umbral no es un límite de latencia de extremo a extremo.

stopAudioCapture

Detiene la captura de audio.
stopAudioCapture(): number
Devuelve 0 si tiene éxito. Devuelve AoqECStateInvalid(2) si el dispositivo no se ha iniciado o ya se detuvo.

muteAudioCapture

Silencia o reactiva la captura de audio. La captura continúa silenciada, pero se envían tramas de silencio.
muteAudioCapture(mute: boolean): number
ParámetroTipoDescripción
mutebooleantrue: silenciar; false: reactivar
Devuelve 0 si tiene éxito.

startAudioPlayer

Inicia el reproductor de audio e inicializa la salida de forma asíncrona.
startAudioPlayer(config: AoqAudioPlaybackConfig): Promise<number>
ParámetroTipoDescripción
configAoqAudioPlaybackConfigConfiguración de reproducción de audio
Devuelve Promise<number>; 0 indica éxito. Los cambios de estado de reproducción se notifican mediante onAudioDeviceStateChanged. Llame desde un controlador de clic del usuario y gestione las restricciones de reproducción automática. Llamar durante el inicio o cuando el reproductor ya está iniciado devuelve AoqECStateInvalid(2). En modo Realtime (trackMode de audio descendente igual a Stream), el audio recibido antes de iniciar el reproductor se consume continuamente sin acumularse. Cada inicio, incluido el primero, borra el audio anterior y solo reproduce audio nuevo. El modo Segment conserva el audio pendiente.

stopAudioPlayer

Detiene el reproductor de audio.
stopAudioPlayer(): number
Devuelve 0 si tiene éxito. Devuelve AoqECStateInvalid(2) si el dispositivo no se ha iniciado o ya se detuvo. En modo Realtime, el audio entrante sigue consumiéndose después de detener la salida y el video continúa. Reiniciar solo reproduce audio nuevo. Los estados de pausa o interrupción se conservan al reiniciar. El modo Segment conserva el audio pendiente.

pauseAudioPlayer

Pausa la reproducción después de la atenuación de salida. Llame a resumeAudioPlayer para reanudar.
pauseAudioPlayer(fadeMs: number): number
ParámetroTipoDescripción
fadeMsnumberDuración de atenuación de salida en ms, redondeada a muestras con la frecuencia real del dispositivo. 0 la desactiva; valores negativos o no finitos usan 100 ms.
Devuelve 0 al aceptar la solicitud. La atenuación puede no haber terminado, y el reproductor podría no estar reproduciendo. El modo Segment conserva el audio pendiente y la posición de lectura, y continúa desde allí. El modo Realtime descarta el audio en cola y sigue consumiendo el recibido durante la pausa; reanuda desde la posición actual en vivo sin reproducir ese intervalo.

resumeAudioPlayer

Reanuda reproducción pausada o interrumpida con atenuación de entrada predeterminada: 2 ms en Segment y 100 ms en Realtime.
resumeAudioPlayer(fadeMs: number): number
ParámetroTipoDescripción
fadeMsnumberReservado y actualmente ignorado. Se usa la atenuación predeterminada; pasar 0 no la desactiva.
Devuelve 0 al aceptar la solicitud; la reanudación podría no haber terminado.

interruptAudioPlayer

Interrumpe la reproducción y descarta el audio pendiente después de la atenuación. A diferencia de una pausa en Segment, el audio descartado no vuelve a reproducirse al reanudar.
interruptAudioPlayer(trackType: AoqTrackType, fadeMs: number): number
ParámetroTipoDescripción
trackTypeAoqTrackTypeParámetro de compatibilidad. Use Audio. Actualmente no selecciona el flujo de reproducción.
fadeMsnumberDuración de atenuación de salida en ms, redondeada a muestras con la frecuencia real del dispositivo. 0 la desactiva; valores negativos o no finitos usan 100 ms.
Devuelve 0 al aceptar la solicitud. La interrupción podría no haber terminado, y el reproductor podría no estar reproduciendo. La reproducción se reanuda automáticamente cuando el servidor envía audio de una nueva ronda. También puede llamar a resumeAudioPlayer. Las solicitudes de interrupción durante una pausa se ignoran, pero pueden devolver 0. El modo Segment reanuda el audio conservado antes de pausar. Pausar y luego interrumpir no vacía la cola.

Configuración de codificación de audio

setAudioEncoderConfig

Establece parámetros de codificación de audio.
setAudioEncoderConfig(config: AoqAudioCodecConfig): number
ParámetroTipoDescripción
configAoqAudioCodecConfigConfiguración de codificación de audio
Devuelve 0 si tiene éxito. Llame antes de connect() con el motor en Disconnected. Modificar durante la conexión o estando conectado devuelve AoqECStateInvalid(2). Desconecte, espere Disconnected, configure y reconecte. El retorno 0 indica que se aceptó la configuración. El formato se valida otra vez al conectar. Opus también requiere WebCodecs en el navegador.

setAudioDecoderConfig

Establece parámetros de decodificación de audio.
setAudioDecoderConfig(config: AoqAudioCodecConfig): number
ParámetroTipoDescripción
configAoqAudioCodecConfigConfiguración de decodificación de audio
Devuelve 0 si tiene éxito. Llame antes de connect() con el motor en Disconnected. Modificar durante la conexión o estando conectado devuelve AoqECStateInvalid(2).

Indicación de volumen local

enableLocalAudioVolumeIndication

Activa o desactiva notificaciones periódicas del volumen local mediante onLocalAudioVolumeIndication.
enableLocalAudioVolumeIndication(config: AoqAudioVolumeIndicationConfig): number
ParámetroTipoDescripción
configAoqAudioVolumeIndicationConfigConfiguración de indicación de volumen
Devuelve 0 si tiene éxito. Establezca interval en 0 o un valor negativo para desactivar los callbacks.

Administración de dispositivos de video

startVideoCapture

Inicia la captura de la cámara.
startVideoCapture(config: AoqVideoCaptureConfig): number
ParámetroTipoDescripción
configAoqVideoCaptureConfigConfiguración de captura de video
Devuelve 0 si tiene éxito. El retorno 0 indica que se aceptó la solicitud asíncrona. El éxito o error se notifica mediante onVideoDeviceStateChanged; la cámara podría no estar activa aún. cameraPreference acepta un enum de orientación o ID de dispositivo. Si se omite, el navegador elige. Si no se puede satisfacer la preferencia, puede usar otra cámara disponible.

getCameras

getCameras(): Promise<MediaDeviceInfo[]>
Enumera dispositivos videoinput visibles sin abrir la cámara ni solicitar permisos. Los nombres o IDs pueden estar incompletos antes de autorizar. Enumere otra vez tras autorizar o cambiar dispositivos. La Promise se rechaza si el motor no está inicializado o falla la enumeración.

switchCamera

switchCamera(cameraPreference?: AoqCameraDirection | string): number
ParámetroTipoObligatorioDescripción
cameraPreferenceAoqCameraDirection | stringNoOrientación o ID preferido. Omita para borrar la preferencia anterior y permitir que el navegador elija de nuevo.
La orientación y el ID usan restricciones ideal y permiten otra cámara como alternativa. 0 indica aceptación. El estado se notifica mediante onVideoDeviceStateChanged, los errores por onError. Devuelve AoqECStateInvalid(2) sin captura activa, al iniciar o al cambiar; una orientación no válida o ID vacío devuelve AoqECParamInvalid(1). El cambio libera el dispositivo anterior, abre el destino y espera su primera imagen. Si la pista anterior se transfirió a un Worker, incluso si después regresó al hilo principal, se espera confirmación de liberación hasta 2 segundos. Si vence, se informa un error sin abrir ni restaurar dispositivos. Cada intento dura como máximo 15 segundos. En caso de error se intenta restaurar una vez con la preferencia original; aunque se restaure, se informa que el cambio falló. Éxito: CaptureStarted(reason=0); error con restauración: CaptureStarted(reason=código de error); sin restauración: CaptureFail(reason=código de error). Si el destino explícito ya se cumple, CaptureStarted se emite asíncronamente sin reabrir. El callback no incluye el ID real. El cambio conserva envío, códecs y vínculo de vista previa. Detener captura cancela el cambio; destruir el motor evita nuevos callbacks. El cambio puede interrumpir brevemente el video. La línea temporal sigue continua, sin garantizar sincronización de audio/video a nivel hardware. El navegador selecciona el dispositivo real; no muestre la preferencia solicitada como dispositivo confirmado.

stopVideoCapture

Detiene la captura de video.
stopVideoCapture(): number
Devuelve 0 si tiene éxito. Devuelve AoqECStateInvalid(2) si el dispositivo no se ha iniciado o ya se detuvo.

setLocalView

Establece el contenedor de video local. El SDK crea los elementos de renderizado dentro.
setLocalView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParámetroTipoDescripción
trackTypeAoqTrackTypeSolo admite AoqTrackTypeVideo. Otros tipos devuelven AoqECUnSupport(3).
canvasAoqVideoCanvas | nullConfiguración del contenedor. Pase null para desvincular.
Devuelve 0 si tiene éxito. Defina dimensiones explícitas para el contenedor. El SDK crea sus elementos de renderizado dentro. Use un contenedor DOM normal de dimensiones explícitas, como div. No pase directamente video, audio, canvas, img ni elementos vacíos. Contenedor no válido, ID inexistente o renderMode no válido devuelve AoqECParamInvalid(1) y conserva el vínculo anterior. 0 indica aceptación; la primera imagen podría no estar renderizada.

setRemoteView

Establece el contenedor de video remoto. El SDK crea los elementos de renderizado dentro.
setRemoteView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParámetroTipoDescripción
trackTypeAoqTrackTypeSolo admite AoqTrackTypeVideo. Otros tipos devuelven AoqECUnSupport(3).
canvasAoqVideoCanvas | nullConfiguración del contenedor. Pase null para desvincular.
Devuelve 0 si tiene éxito. Use un contenedor DOM normal de dimensiones explícitas, como div. No pase directamente video, audio, canvas, img ni elementos vacíos. Contenedor no válido, ID inexistente o renderMode no válido devuelve AoqECParamInvalid(1) y conserva el vínculo anterior. 0 indica aceptación; la primera imagen podría no estar renderizada.

Configuración de codificación de video

setVideoEncoderConfig

Establece parámetros de codificación de video.
setVideoEncoderConfig(config: AoqVideoCodecConfig): number
ParámetroTipoDescripción
configAoqVideoCodecConfigConfiguración de codificación de video
Devuelve 0 si tiene éxito. Llame con el motor en Disconnected. Durante la conexión o estando conectado devuelve AoqECStateInvalid(2). Configure antes de la primera conexión y captura de video. La configuración se combina y almacena para flujos posteriores; las capturas o codificadores existentes no se reconfiguran de inmediato.

setVideoDecoderConfig

Establece parámetros de decodificación de video.
setVideoDecoderConfig(config: AoqVideoCodecConfig): number
ParámetroTipoDescripción
configAoqVideoCodecConfigConfiguración de decodificación de video
Devuelve 0 si tiene éxito. Llame antes de connect() con el motor en Disconnected. Modificar durante la conexión o estando conectado devuelve AoqECStateInvalid(2).

Control de transmisión de flujos multimedia

enableSendMediaStream

Activa o desactiva la transmisión de pistas de audio o video.
enableSendMediaStream(trackType: AoqTrackType, enable: boolean): number
ParámetroTipoDescripción
trackTypeAoqTrackTypeTipo de pista multimedia
enablebooleantrue: activar transmisión; false: desactivar transmisión
Devuelve 0 si tiene éxito. Solo controla Audio y Video, no Data. Otros valores pueden devolver 0 sin efecto. Desactivar envío no detiene la captura; use el método stop...Capture() correspondiente.

Mensajes en tiempo real

sendDataMsg

Envía texto UTF-8 en un Uint8Array al par, por ejemplo JSON de aplicación. La ruta WT actual no admite cargas binarias arbitrarias ni mensajes de control internos del SDK por este método.
sendDataMsg(msg: AoqDataMsg): number
ParámetroTipoDescripción
msgAoqDataMsgObjeto mensaje; msg.data debe contener bytes UTF-8 no vacíos
Devuelve 0 si tiene éxito. Requiere motor conectado, pistas listas y Data en publishTracks. Un mensaje ausente o msg.data distinto de Uint8Array devuelve AoqECParamInvalid(1). Una conexión no lista devuelve AoqECStateInvalid(2). Flujo de envío inactivo o mensaje vacío devuelve actualmente -1. 0 indica aceptación local, no confirmación de recepción del par. La validación UTF-8 o el envío posterior aún puede fallar mediante onError. El ArrayBuffer de msg.data puede transferirse y separarse, afectando otras vistas que comparten el búfer. Pase una copia data.slice() para conservar el original. No envíe claves API ni credenciales temporales en mensajes frontend o registros.
const data = new TextEncoder().encode(JSON.stringify({ type: 'user_message', text: '你好' }));
const code = engine.sendDataMsg({ data });
if (code !== 0) console.error('消息未受理', code);
El JSON solo ilustra la codificación. Siga el protocolo de mensajes del modelo para los campos reales y la preparación de la aplicación.

Callbacks de eventos

Suscríbase con engine.on('eventName', callback), escuche una vez con engine.once(...) y cancele con engine.off('eventName', callback) usando la misma referencia de función. Destruir el motor elimina todos los listeners. Registre antes de conectar o iniciar dispositivos y mantenga los callbacks ligeros.
import { AoqConnectionStatus } from 'aoq-web-sdk';

const handleStatus = (status: AoqConnectionStatus) => console.log('连接状态', status);
engine.on('onConnectionStatusChange', handleStatus);
engine.off('onConnectionStatusChange', handleStatus);
EventoFirma del callbackDescripción
onError(code: number, message: string) => voidCallback de error
onWarning(code: number, message: string) => voidCallback de advertencia
onConnectionStatusChange(status: AoqConnectionStatus) => voidCambios de estado de conexión
onStats(stats: AoqStats) => voidEstadísticas
onAudioDeviceStateChanged(state: AoqAudioDeviceState) => voidCambios de estado del dispositivo de audio
onAudioDeviceRouteChanged(routeType: AoqAudioDeviceRouteType) => voidCambios de ruta de audio
onAudioFileState(state: AoqAudioFileState) => voidReservado; actualmente no se emite
onLocalAudioVolumeIndication(volume: AoqAudioVolume) => voidIndicación de volumen local
onVideoDeviceStateChanged(state: AoqVideoDeviceState) => voidCambios de estado del dispositivo de video
onDataMsg(msg: AoqDataMsg) => voidMensajes de datos

onError

Informa errores asíncronos o de ejecución además de los retornos síncronos. Use code, message y estados de conexión y dispositivos para diagnosticar. Un error no termina necesariamente la conexión. Los errores de red pueden usar códigos generales; el número solo no identifica la etapa del fallo.
engine.on('onError', (code: number, message: string) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
codenumberCódigo de error; consulte AoqErrorCode
messagestringDescripción del error

onWarning

Informa advertencias del motor sobre condiciones no fatales que requieren atención.
engine.on('onWarning', (code: number, message: string) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
codenumberCódigo de advertencia; consulte AoqWarningCode
messagestringDescripción de la advertencia

onConnectionStatusChange

Informa cambios de estado de conexión.
engine.on('onConnectionStatusChange', (status: AoqConnectionStatus) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
statusAoqConnectionStatusEstado actual de conexión

onStats

Informa estadísticas aproximadamente cada segundo en Connected y deja de hacerlo al salir. Consulte AoqStats para la disponibilidad de campos. Los valores de relleno no son mediciones.
engine.on('onStats', (stats: AoqStats) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
statsAoqStatsObjeto de estadísticas

onAudioDeviceStateChanged

Informa cambios de estado de operaciones de captura y reproducción de audio.
engine.on('onAudioDeviceStateChanged', (state: AoqAudioDeviceState) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
stateAoqAudioDeviceStateEstado del dispositivo de audio

onAudioDeviceRouteChanged

Al cambiar la lista de salidas, el SDK intenta inferir la ruta a partir de etiquetas del navegador. Puede equivocarse u omitir cambios; no confirma la ruta real. Puede devolver el tipo predeterminado antes de autorizar o si la información está incompleta.
engine.on('onAudioDeviceRouteChanged', (routeType: AoqAudioDeviceRouteType) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
routeTypeAoqAudioDeviceRouteTypeRuta inferida por etiquetas, no confirmación del dispositivo de salida real

onAudioFileState

Callback reservado de estado de archivo de audio. AoqClientEngine no ofrece actualmente controles de reproducción de archivos ni emite este evento.
engine.on('onAudioFileState', (state: AoqAudioFileState) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
stateAoqAudioFileStateEstado del archivo de audio

onLocalAudioVolumeIndication

Informa el volumen de captura local. Active primero enableLocalAudioVolumeIndication.
engine.on('onLocalAudioVolumeIndication', (volume: AoqAudioVolume) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
volumeAoqAudioVolumeInformación de volumen

onVideoDeviceStateChanged

Informa cambios de estado de operaciones de captura de video.
engine.on('onVideoDeviceStateChanged', (state: AoqVideoDeviceState) => { /* 在此处理回调 */ });
ParámetroTipoDescripción
stateAoqVideoDeviceStateEstado del dispositivo de video

onDataMsg

Informa mensajes de datos recibidos.
engine.on('onDataMsg', (msg: AoqDataMsg) => { /* 使用 msg.data 读取消息数据 */ });
ParámetroTipoDescripción
msgAoqDataMsgObjeto mensaje recibido. Use TextDecoder para leer el texto UTF-8 de msg.data.
Incluya Data en subscribeTracks para recibir mensajes. El callback recibe un objeto, no un Uint8Array directamente. La aplicación debe analizar y validar el JSON.

Tipos de datos y enumeraciones

Tipos comunes

AoqCreateConfig

Configuración de creación del motor.
CampoTipoObligatorioPredeterminadoDescripción
workDirstringNo—Reservado; el SDK web no utiliza este campo para seleccionar el directorio de almacenamiento
enableDumpAudiobooleanNofalseGuardar audio de depuración. Obtenga autorización y controle el acceso al audio del usuario.
enableDumpExportbooleanNofalseSolo se aplica con enableDumpAudio=true. Exporta un ZIP de dump y elimina los archivos OPFS asociados de forma asíncrona al destruir.
maxEncodedVideoFrameBytesnumberNo194560 (190×1024)Tamaño máximo objetivo de imagen JPEG en bytes. 0 desactiva el límite. Si se supera, reduce la calidad; valores no válidos usan el predeterminado.
enableDropOversizedVideoFramebooleanNofalseDescartar JPEG que aún superen el límite con calidad mínima. Con false pueden enviarse imágenes sobredimensionadas. No descarta por esta razón si el límite es 0.
extrasstringNo—Cadena de objeto JSON. JSON no válido, valor no objeto o política de renderizado no válida hace que createEngine devuelva null.
Campos extras admitidos:
Campo JSONTipoPredeterminadoDescripción
remoteVideoRenderer'auto' | 'video' | 'canvas''auto'Política de renderizado remoto. auto prefiere video y usa canvas cuando es necesario.
user_specified_enable_av_syncbooleantrueActivar sincronización de audio/video. Use un booleano JSON.
user_specified_audio_playback_transport'message-port'AutomáticoFuerza reproducción con MessagePort. Si se omite, selecciona memoria compartida o MessagePort según el entorno.
Estos campos no modifican encabezados de respuesta HTTP ni activan API públicas de diagnóstico.

AoqConnectConfig

Configuración de autenticación de conexión.
CampoTipoObligatorioPredeterminadoDescripción
tokenstringSí—Token temporal de cliente no vacío, correspondiente a aoqTokenForClient, no una clave API
sidstringSí—ID de sesión no vacío. Use la cadena sid completa de la respuesta de autenticación.
wtBaseUrlstringNoDerivada de RelayURL HTTPS WT preferida con una sola ruta. Se ignora con varias rutas, que conectan a /aoq en cada host y puerto.
signedSidstringSí (en ejecución)—SID firmado completo, normalmente el sid completo de autenticación. Opcional en TypeScript, obligatorio en el flujo WT actual.
certFingerprintstring | string[]Condicional—Huella SHA-256 compartida del certificado WT. Las rutas sin huella propia deben poder utilizarla.
workspaceIdHashstringNo—Corresponde a extraInfo.workspaceIdHash. No lo sustituya por el Workspace ID original.
relayEndpointsAoqRelayEndpoint[]Sí—Lista completa de endpoints con al menos una entrada
publishTracksAoqTrackParam[]Sí—Pistas ascendentes. Puede estar vacía, pero no junto con subscribeTracks.
subscribeTracksAoqTrackParam[]Sí—Pistas descendentes. Puede estar vacía. No admite pistas duplicadas en la misma dirección ni Screen.
El backend debe devolver credenciales completas y válidas. Convierta clientRelayEndpoints[].route_index en routeIndex en el adaptador. No invente SID, endpoints, índices ni huellas. Las huellas WT deben corresponder al certificado real del endpoint WebTransport. Para sha256/<hex>, quite el prefijo y valide 64 dígitos hexadecimales. Huellas compartidas y por ruta aceptan cadena o arreglo; todas las entradas deben ser válidas y basta una coincidencia. Una huella de ruta no vacía sustituye la compartida; un arreglo vacío se trata como no configurado. No existe huella universal ni opción para omitir validación. La ausencia de signedSid o huellas válidas puede provocar un fallo asíncrono aunque connect() devuelva 0. Gestione eventos de estado y onError.

AoqRelayEndpoint

Endpoint Relay.
CampoTipoObligatorioPredeterminadoDescripción
routeIndexnumberSí (en ejecución)—Entero único entre 0 y 2147483647. Inicialmente se usa el menor índice. Opcional en TypeScript.
certFingerprintstring | string[]CondicionalHuella compartidaLa huella no vacía de la ruta sustituye la compartida. Obligatoria si no hay huella compartida.
endpointstringSí—Host o IP WT sin esquema, ruta, espacios, información de usuario ni consulta. Admite IPv6.
portnumberSí—Puerto WT, entero entre 1 y 65535

AoqTrackParam

Propiedades de pista.
CampoTipoObligatorioPredeterminadoDescripción
trackTypeAoqTrackTypeSí—Audio, Video o Data. Sin duplicados en una dirección. Screen aún no se admite.
trackModeAoqTrackModeNoSegment para audio descendenteSolo controla el audio descendente. PCM / Opus usan Segment por defecto; elija Stream para Realtime. El audio ascendente siempre usa Realtime. Ascendente, video y datos ignoran este campo.

AoqSupportResult

Resultado de comprobación de capacidades del navegador.
CampoTipoPredeterminadoDescripción
supportedboolean—Si el entorno tiene capacidades básicas de conexión AOQ
missingFeaturesAoqMissingFeature[]—Fallos observados en la comprobación previa, que pueden incluir 'secure-context', 'worker' y 'web-transport'

AoqMissingFeature

Fallos básicos: 'secure-context' | 'worker' | 'web-transport'. worker también puede indicar bloqueo por políticas de implementación, fallo de inicio/ejecución o timeout, no solo ausencia de Worker. La lista no evalúa todas las capacidades multimedia.

Tipos de audio

AoqAudioCaptureConfig

Configuración de captura de audio.
CampoTipoObligatorioPredeterminadoDescripción
channelnumberNo1Canales solicitados: 1 (mono) o 2 (estéreo). La configuración real puede depender de la pista del dispositivo.

AoqAudioPlaybackConfig

Configuración de reproducción de audio.
CampoTipoObligatorioPredeterminadoDescripción
channelnumberNo1Canales solicitados: 1 o 2. La salida usa la frecuencia real de AudioContext.
playOnlyAndIgnoreMutebooleanNofalseSolo para reproducción. Establece audioSession en playback cuando se admite, evitando el interruptor de silencio de iOS. Mantenga false si necesita micrófono. Ignorar el silencio no se garantiza sin compatibilidad del navegador.

AoqAudioCodecConfig

Configuración del códec de audio.
CampoTipoObligatorioPredeterminadoDescripción
trackTypeAoqTrackTypeNo—Reservado; actualmente no selecciona el flujo de audio
codecTypeAoqEncoderTypeNoAoqEncoderTypeAudioPCMPCM / Opus. Debe coincidir con la configuración negociada con el par.
sampleRatenumberNo48000Frecuencia en Hz. Valores negociados: 8000, 12000, 16000, 24000, 32000, 44100, 48000. El navegador también debe admitir la codificación elegida.
channelnumberNo1Número de canales: 1 o 2
bitratenumberNo32000 (codificación Opus)En bps, solo para codificación Opus. La tasa PCM depende de frecuencia, canales y profundidad de bits. No se usa en decodificación.

AoqAudioVolumeIndicationConfig

Configuración de indicación de volumen local.
CampoTipoObligatorioPredeterminadoDescripción
intervalnumberNo0Intervalo de callback en ms. Valores <=0 desactivan; valores positivos menores de 10 se tratan como 10.
smoothnumberNo3Factor de suavizado, 0..10. Los valores mayores suavizan más.
reportSpeechbooleanNofalseInformar actividad de voz (VAD)

AoqAudioVolume

Información de volumen local.
CampoTipoPredeterminadoDescripción
volumenumber—Volumen instantáneo suavizado, rango [0-255]
isSpeechboolean—Indicador opcional de actividad de voz, válido solo con reportSpeech=true. Gestione valores ausentes.

AoqAudioDeviceState

Datos de callback de estado del dispositivo de audio.
CampoTipoPredeterminadoDescripción
stateAoqAudioDeviceStateCode—Código de estado del dispositivo de audio
reasonnumber—Código de motivo; consulte AoqErrorCode

AoqAudioFileState

Estructura reservada de estado de reproducción de archivo; el SDK web no emite aún el evento asociado.
CampoTipoPredeterminadoDescripción
fileIdstring—ID de archivo de audio
stateCodeAoqAudioFileStateCode—Código de estado de reproducción del archivo
errorCodenumber—Código de error

Tipos de video

AoqVideoCaptureConfig

Configuración de captura de video.
CampoTipoObligatorioPredeterminadoDescripción
widthnumberNo1280Ancho solicitado en píxeles con restricción ideal. El navegador/dispositivo elige el valor real.
heightnumberNo720Alto solicitado en píxeles con restricción ideal. El navegador/dispositivo elige el valor real.
fpsnumberNo15Frecuencia de captura solicitada con restricciones ideal y max
cameraPreferenceAoqCameraDirection | stringNoSelección del navegadorOrientación o ID de cámara preferido con restricción ideal. Permite alternativas; cadenas en blanco no válidas.

AoqVideoCodecConfig

Configuración del códec de video.
CampoTipoObligatorioPredeterminadoDescripción
trackTypeAoqTrackTypeNo—Reservado; actualmente no selecciona el flujo de video
codecTypeAoqEncoderTypeNoAoqEncoderTypeVideoH264H.264 / JPEG. Debe coincidir con la configuración negociada con el par.
widthnumberNo540Ancho objetivo de codificación o negociado en bajada, en píxeles. Entero positivo obligatorio al conectar.
heightnumberNo960Alto objetivo de codificación o negociado en bajada, en píxeles. Entero positivo obligatorio al conectar.
fpsnumberNo5Frecuencia de codificación o negociada en bajada. Entero positivo obligatorio al conectar.
bitratenumberNo500000 (codificación)Tasa objetivo positiva de codificación en bps. No se usa en decodificación.
minBitratenumberNo128000Tasa mínima objetivo en bps. Omitir o usar 0 aplica 128000, sin superar el objetivo del usuario. H.264 no se pausa cuando el presupuesto BWE llega a 0. No se usa en decodificación.
keyframeIntervalnumberNo2Intervalo de fotogramas clave H.264 en segundos, al menos 1 segundo al codificar. No se usa para JPEG ni decodificación.

AoqVideoCanvas

Configuración del contenedor de renderizado de video.
CampoTipoObligatorioPredeterminadoDescripción
viewHTMLElement | stringSí—Contenedor normal o su ID DOM sin #. No use directamente video, audio, canvas, img ni elementos vacíos.
renderModeAoqRenderModeNoAoqRenderModeAuto(0)Modo de ajuste de video
La vista previa local se refleja automáticamente mediante CSS si la pista real es frontal; no se refleja si la orientación se desconoce. Los píxeles codificados no cambian. No hay configuración separada de reflejo u orientación. Una sustitución no válida conserva el vínculo. Desvincular con null elimina solo nodos del SDK y conserva los de la aplicación.

AoqVideoDeviceState

Datos de callback de estado del dispositivo de video.
CampoTipoPredeterminadoDescripción
stateAoqVideoDeviceStateCode—Código de estado del dispositivo de video
reasonnumber—Motivo: 0 para detención explícita; AoqECVideoDevice(220) para final inesperado de pista web

Tipos de mensajes de datos

AoqDataMsg

Estructura compartida por sendDataMsg y onDataMsg públicos. No aceptan directamente cadenas ni Uint8Array. La ruta WT transporta texto UTF-8 en un arreglo de bytes.
CampoTipoObligatorioPredeterminadoDescripción
dataUint8ArraySí—UTF-8 válido y no vacío al enviar. Lea msg.data al recibir.

Tipos de estadísticas

AoqStats

Resumen de estadísticas del motor. Todos estos campos son opcionales en la definición; gestione su ausencia.
CampoTipoPredeterminadoDescripción
audioPublishStatsAoqAudioPublishStats[]—Estadísticas de publicación de audio
audioSubscribeStatsAoqAudioSubscribeStats[]—Estadísticas de suscripción de audio
videoPublishStatsAoqVideoPublishStats[]—Estadísticas de publicación de video
videoSubscribeStatsAoqVideoSubscribeStats[]—Estadísticas de suscripción de video
dataMsgPublishStatsAoqDataMsgPublishStats[]—Estadísticas de publicación de mensajes de datos
dataMsgSubscribeStatsAoqDataMsgSubscribeStats[]—Estadísticas de suscripción de mensajes de datos
networkStatsAoqNetworkStats—Estadísticas de red
onStats aún no completa dataMsgPublishStats ni dataMsgSubscribeStats. bitrate / bytes de audio son totales de conexión, no tráfico de audio aislado; encodeVolume / playVolume valen 0. bitrate / bytes de video también valen 0; solo las frecuencias provienen del motor de video. Use networkStats para tráfico total y onLocalAudioVolumeIndication para volumen de captura.

AoqAudioPublishStats

Estadísticas de publicación de audio.
CampoTipoPredeterminadoDescripción
trackTypeAoqTrackType—Tipo de pista
bitratenumber—Tasa total ascendente de aplicación de la conexión en bps, no solo audio
bytesnumber—Bytes totales ascendentes de aplicación de la conexión, no solo audio
encodeVolumenumber0Valor de relleno. Use onLocalAudioVolumeIndication para volumen de captura.

AoqAudioSubscribeStats

Estadísticas de suscripción de audio.
CampoTipoPredeterminadoDescripción
trackTypeAoqTrackType—Tipo de pista
bitratenumber—Tasa total descendente de aplicación de la conexión en bps, no solo audio
bytesnumber—Bytes totales descendentes de aplicación de la conexión, no solo audio
playVolumenumber0Valor de relleno; no indica si la reproducción está silenciada

AoqVideoPublishStats

Estadísticas de publicación de video.
CampoTipoPredeterminadoDescripción
trackTypeAoqTrackType—Tipo de pista
bitratenumber0Valor de relleno; no se informa la tasa de video aislada
bytesnumber0Valor de relleno; no se informa el número de bytes de video aislado
encodeFpsnumber—Frecuencia de fotogramas codificados

AoqVideoSubscribeStats

Estadísticas de suscripción de video.
CampoTipoPredeterminadoDescripción
trackTypeAoqTrackType—Tipo de pista
bitratenumber0Valor de relleno; no se informa la tasa de video aislada
bytesnumber0Valor de relleno; no se informa el número de bytes de video aislado
decodeFpsnumber—Frecuencia de fotogramas decodificados
renderFpsnumber—Frecuencia de fotogramas renderizados

AoqDataMsgPublishStats

Estadísticas de publicación de mensajes de datos.
CampoTipoPredeterminadoDescripción
trackTypeAoqTrackType—Tipo de pista
bitratenumber—Tasa actual en bps
bytesnumber—Bytes enviados acumulados
El tipo está definido, pero onStats aún no completa este arreglo.

AoqDataMsgSubscribeStats

Estadísticas de suscripción de mensajes de datos.
CampoTipoPredeterminadoDescripción
trackTypeAoqTrackType—Tipo de pista
bitratenumber—Tasa actual en bps
bytesnumber—Bytes recibidos acumulados
El tipo está definido, pero onStats aún no completa este arreglo.

AoqNetworkStats

Estadísticas de red. Las tasas miden bits/s de carga útil de aplicación; los acumulados usan la misma base en bytes. Excluyen sondeos y sobrecarga del protocolo de transporte.
CampoTipoPredeterminadoDescripción
sendBitratenumber—Tasa ascendente en bps
sendBytesnumber—Bytes ascendentes acumulados
recvBitratenumber—Tasa descendente en bps
recvBytesnumber—Bytes descendentes acumulados
lossnumber—Proporción opcional de pérdida ascendente (0–1). Prefiere observaciones QUIC del navegador; en su defecto usa una estimación Relay Datagram. Se omite si se desconoce.
rttnumber—Tiempo de ida y vuelta opcional en ms; se omite si se desconoce
bwenumber—Presupuesto efectivo opcional de envío de aplicación Client→Relay en bps; se omite si se desconoce o caducó
audioReserveBpsnumber—Tasa opcional reservada para la carga útil del audio codificado actual en bps. Excluye redundancia RED y sobrecarga de transporte; no es el tráfico de audio real.

Enumeraciones

AoqTrackType

Tipo multimedia de la pista.
Miembro de enumValorDescripción
AoqTrackTypeAudio0Audio
AoqTrackTypeVideo1Video
AoqTrackTypeData2Mensajes de datos
AoqTrackTypeScreen3Reservado; no admitido en el flujo de conexión actual

AoqTrackMode

Modo de transporte de audio.
Miembro de enumValorDescripción
AoqTrackModeSegment0Modo Segment
AoqTrackModeStream1Modo de flujo Realtime

AoqEncoderType

Formato multimedia de la pista.
Miembro de enumValorDescripción
AoqEncoderTypeUnknown0Desconocido
AoqEncoderTypeAudioPCM1Audio PCM
AoqEncoderTypeAudioOpus2Audio Opus
AoqEncoderTypeVideoH2643Video H.264
AoqEncoderTypeVideoJpeg4Video JPEG
AoqEncoderTypeDataText5Datos de texto

AoqConnectionStatus

Estado de conexión del motor.
Miembro de enumValorDescripción
AoqConnectionStatusDisconnected0Desconectado
AoqConnectionStatusConnecting1Conectando
AoqConnectionStatusConnected2Conectado
AoqConnectionStatusFailed3Conexión fallida

AoqErrorCode

Códigos de error.
Miembro de enumValorDescripción
AoqECOK0Éxito
AoqECParamInvalid1Parámetro no válido
AoqECStateInvalid2Estado no válido
AoqECUnSupport3No implementado en la plataforma/modo actual
AoqECAudio100Error general de audio
AoqECAudioExternalBufferFull110Búfer de audio externo lleno
AoqECAudioDevice120Error general del dispositivo de audio
AoqECAudioDeviceRecordingAuthFailed121Permiso de micrófono denegado
AoqECAudioDeviceRecordingOccupied122Micrófono en uso
AoqECAudioDeviceRecordingBackgroundStart123Captura iniciada en segundo plano
AoqECAudioDeviceRecordingStartFail124Error al iniciar captura
AoqECAudioDevicePlayoutOccupied125Dispositivo de reproducción en uso
AoqECAudioDevicePlayoutBackgroundStart126Reproducción iniciada en segundo plano
AoqECAudioDevicePlayoutStartFail127Error al iniciar reproducción
AoqECAudioDeviceEarpieceRequiresVoipMode128Auricular requiere modo VoIP
AoqECVideo200Error general de video
AoqECVideoExternalBufferFull210Búfer de video externo lleno
AoqECVideoExternalCaptureNotEnabled211Captura de video externa no activada
AoqECVideoExternalEncoderNotEnabled212Codificador de video externo no activado
AoqECVideoDevice220Error general del dispositivo de video
AoqECVideoDeviceCameraOpenFail221Error al abrir cámara
AoqECVideoDeviceCameraAuthFailed222Permiso de cámara denegado
AoqECVideoDeviceCameraOccupied223Cámara en uso
AoqECVideoDeviceCameraRunningError224Error de ejecución de la cámara
AoqECVideoCodec230Error general del códec de video
AoqECVideoCodecEncoderInitFail231Error de inicialización del codificador de video
AoqECVideoRender240Error general de renderizado de video
AoqECVideoRenderCreateFail241Error al crear renderizador
AoqECVideoRenderDrawError242Error de dibujo en el renderizado

AoqWarningCode

Códigos de advertencia.
Miembro de enumValorDescripción
AoqWCOK0Normal
AoqWCAudio100Advertencia general de audio
AoqWCAudioHowling101Retroalimentación acústica detectada
AoqWCAudioDevice120Advertencia general del dispositivo de audio
AoqWCAudioDeviceMicEnumerateError121Error al enumerar micrófonos
AoqWCAudioDeviceMicStartTimeout122Tiempo de espera de inicio del micrófono agotado
AoqWCAudioDeviceRecordingError123Error de captura
AoqWCAudioDeviceSpeakerEnumerateError124Error al enumerar altavoces
AoqWCAudioDeviceSpeakerStartTimeout125Tiempo de espera de inicio del altavoz agotado
AoqWCAudioDevicePlayoutError126Error de reproducción
AoqWCAudioDeviceSilentMode127Dispositivo en modo silencioso
AoqWCVideo200Advertencia general de video
AoqWCVideoCameraEnumerateError201Error al enumerar cámaras
AoqWCVideoEncoderSwitched202Codificador de video cambiado
AoqWCVideoRenderDowngrade203Renderizado alternativo

AoqAudioDeviceStateCode

Códigos de estado del dispositivo de audio.
Miembro de enumValorDescripción
AoqAudioDeviceNone0Sin estado
AoqAudioDeviceRecordStarting1Iniciando captura
AoqAudioDeviceRecordStarted2Captura iniciada
AoqAudioDeviceRecordStopping3Deteniendo captura
AoqAudioDeviceRecordStopped4Captura detenida
AoqAudioDeviceRecordFail5Captura fallida
AoqAudioDevicePlayStarting6Iniciando reproducción
AoqAudioDevicePlayStarted7Reproducción iniciada
AoqAudioDevicePlayStopping8Deteniendo reproducción
AoqAudioDevicePlayStopped9Reproducción detenida
AoqAudioDevicePlayFail10Reproducción fallida

AoqAudioDeviceRouteType

Tipos de ruta del dispositivo de audio.
Miembro de enumValorDescripción
AoqAudioDeviceRouteDefault0Ruta predeterminada
AoqAudioDeviceRouteHeadset1Auriculares
AoqAudioDeviceRouteSpeakerPhone4Altavoz integrado
AoqAudioDeviceRouteUsb5Dispositivo USB
AoqAudioDeviceRouteBluetooth6Dispositivo Bluetooth

AoqAudioFileStateCode

Códigos de estado de reproducción de archivos de audio.
Miembro de enumValorDescripción
AoqAudioFileNone0Sin estado
AoqAudioFileStarted1Reproducción iniciada
AoqAudioFileStopped2Reproducción detenida
AoqAudioFilePaused3Reproducción pausada
AoqAudioFileResumed4Reproducción reanudada
AoqAudioFileEnded5Reproducción finalizada
AoqAudioFileBuffering6Almacenando en búfer
AoqAudioFileBufferingEnd7Almacenamiento en búfer terminado
AoqAudioFileFailed8Reproducción fallida

AoqCameraDirection

Miembro de enumValorDescripción
AoqCameraDirectionFront0Preferir cámara frontal
AoqCameraDirectionBack1Preferir cámara trasera

AoqVideoDeviceStateCode

Códigos de estado del dispositivo de video.
Miembro de enumValorDescripción
AoqVideoDeviceNone0Sin estado
AoqVideoDeviceCaptureStarting1Iniciando captura
AoqVideoDeviceCaptureStarted2Captura iniciada
AoqVideoDeviceCaptureStopping3Deteniendo captura
AoqVideoDeviceCaptureStopped4Captura detenida
AoqVideoDeviceCaptureFail5Captura fallida

AoqMirrorMode

Enum de reflejo reservado. El SDK web no tiene configuración ni API que lo utilice.
Miembro de enumValorDescripción
AoqMirrorModeDisabled0Reflejo desactivado
AoqMirrorModeEnabled1Reflejo activado

AoqOrientationMode

Enum de orientación reservado. El SDK web no tiene configuración ni API que lo utilice.
Miembro de enumValorDescripción
AoqOrientationModeAuto0Automático
AoqOrientationModePortrait1Vertical
AoqOrientationModeLandscape2Horizontal

AoqRenderMode

Modos de ajuste de video.
Miembro de enumValorDescripción
AoqRenderModeAuto0Predeterminado: mostrar imagen completa conservando proporciones
AoqRenderModeStretch1Estirar para llenar el contenedor
AoqRenderModeFill2Mostrar imagen completa conservando proporciones, permitiendo barras negras
AoqRenderModeCrop3Llenar conservando proporciones y recortar el excedente

Otras declaraciones públicas

IAoqEngineEvents define las 10 firmas de callbacks de eventos, incluido el reservado onAudioFileState. Suscribirse por nombre proporciona inferencia de parámetros TypeScript. Estos tipos y enums se exportan, pero el motor web actual no ofrece API correspondientes de control u observación. Las declaraciones con el mismo nombre en otras plataformas no implican compatibilidad web.
CategoríaDeclaraciones públicasCompatibilidad actual
Mezcla de archivos de audioAoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCodeSin controles de reproducción o mezcla de archivos; no se emiten eventos de estado de archivo
Audio externo y observadoresAoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirectionSin métodos de entrada de audio externo ni registro de observadores de tramas de audio
Video externo y observadoresAoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecTypeSin entrada de fotogramas externos ni registro de observadores de video. La configuración del códec utiliza AoqEncoderType.
Reflejo y orientaciónAoqMirrorMode, AoqOrientationModeSin campos ni métodos correspondientes. El reflejo de vista previa local es automático.
Dispositivos de audio de bajo nivelAoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCodeDeclaraciones de dispositivos de bajo nivel, no eventos adicionales ni contrato completo de códigos de retorno del motor
AOQ_TRACK_AUDIO y AOQ_TRACK_DATA son las constantes de cadena 'aoq_track_audio' y 'aoq_track_data'. No seleccionan pistas para métodos de conexión o vista; use AoqTrackType en esas API. Los enums de error y advertencia conservan valores multiplataforma. El SDK web no necesariamente produce todos los valores. Consulte los métodos y condiciones documentados aquí para determinar su disponibilidad.