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:
Lista de API
Ciclo de vida del motor
| API | Descripción |
|---|---|
| createEngine | Crear un motor singleton |
| createAoqClientEngine | Función de fábrica con nombre equivalente |
| destroy | Destruir el motor |
| getVersion | Obtener la versión del SDK |
| isAoqSupported | Comprobar capacidades del navegador |
| connect | Iniciar una conexión |
| disconnect | Desconectar |
Administración de dispositivos de audio
| API | Descripción |
|---|---|
| startAudioCapture | Iniciar captura de audio |
| stopAudioCapture | Detener captura de audio |
| muteAudioCapture | Silenciar captura de audio |
| startAudioPlayer | Iniciar reproducción de audio |
| stopAudioPlayer | Detener reproducción de audio |
| pauseAudioPlayer | Pausar reproducción con atenuación de salida |
| resumeAudioPlayer | Reanudar reproducción con atenuación de entrada predeterminada |
| interruptAudioPlayer | Interrumpir reproducción |
Configuración de codificación de audio
| API | Descripción |
|---|---|
| setAudioEncoderConfig | Establecer parámetros de codificación de audio |
| setAudioDecoderConfig | Establecer parámetros de decodificación de audio |
Indicación de volumen local
| API | Descripción |
|---|---|
| enableLocalAudioVolumeIndication | Activar indicación de volumen local |
Administración de dispositivos de video
| API | Descripción |
|---|---|
| startVideoCapture | Iniciar captura de video |
| getCameras | Enumerar cámaras |
| switchCamera | Cambiar de cámara según orientación preferida o ID del dispositivo |
| stopVideoCapture | Detener captura de video |
| setLocalView | Establecer contenedor de video local |
| setRemoteView | Establecer contenedor de video remoto |
Configuración de codificación de video
| API | Descripción |
|---|---|
| setVideoEncoderConfig | Establecer parámetros de codificación de video |
| setVideoDecoderConfig | Establecer parámetros de decodificación de video |
Control de transmisión de flujos multimedia
| API | Descripción |
|---|---|
| enableSendMediaStream | Activar o desactivar transmisión de flujos multimedia |
Mensajes en tiempo real
| API | Descripción |
|---|---|
| sendDataMsg | Enviar un mensaje de datos |
Callbacks de eventos
| API | Descripción |
|---|---|
| onError | Callback de error |
| onWarning | Callback de advertencia |
| onConnectionStatusChange | Cambios de estado de conexión |
| onStats | Estadísticas |
| onAudioDeviceStateChanged | Cambios de estado del dispositivo de audio |
| onAudioDeviceRouteChanged | Cambios de ruta de audio |
| onAudioFileState | Evento reservado de estado de archivo de audio; actualmente no se emite |
| onLocalAudioVolumeIndication | Indicación de volumen local |
| onVideoDeviceStateChanged | Cambios de estado del dispositivo de video |
| onDataMsg | Mensajes de datos |
Detalles de API
Ciclo de vida del motor
createEngine
Crea un motor singleton. Las llamadas repetidas devuelven la instancia existente.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqCreateConfig | Configuración de creación del motor |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqCreateConfig | Obligatorio; {} es válido. La creación repetida no aplica de nuevo la configuración. |
null si falla.
destroy
Destruye el motor, inicia la liberación de recursos y elimina todos los listeners de eventos.
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.
isAoqSupported
Comprueba las capacidades básicas del navegador necesarias para una conexión AOQ.
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqConnectConfig | Credenciales de conexión, incluidos token, ID de sesión y endpoints de relay |
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.
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqAudioCaptureConfig | Configuración de captura de audio |
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.
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
mute | boolean | true: silenciar; false: reactivar |
0 si tiene éxito.
startAudioPlayer
Inicia el reproductor de audio e inicializa la salida de forma asíncrona.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqAudioPlaybackConfig | Configuración de reproducción de audio |
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.
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
fadeMs | number | Duració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. |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
fadeMs | number | Reservado y actualmente ignorado. Se usa la atenuación predeterminada; pasar 0 no la desactiva. |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
trackType | AoqTrackType | Parámetro de compatibilidad. Use Audio. Actualmente no selecciona el flujo de reproducción. |
fadeMs | number | Duració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. |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqAudioCodecConfig | Configuración de codificación de audio |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqAudioCodecConfig | Configuración de decodificación de audio |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqAudioVolumeIndicationConfig | Configuración de indicación de volumen |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqVideoCaptureConfig | Configuración de captura de video |
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
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
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
cameraPreference | AoqCameraDirection | string | No | Orientación o ID preferido. Omita para borrar la preferencia anterior y permitir que el navegador elija de nuevo. |
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.
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
trackType | AoqTrackType | Solo admite AoqTrackTypeVideo. Otros tipos devuelven AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Configuración del contenedor. Pase null para desvincular. |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
trackType | AoqTrackType | Solo admite AoqTrackTypeVideo. Otros tipos devuelven AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Configuración del contenedor. Pase null para desvincular. |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqVideoCodecConfig | Configuración de codificación de video |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
config | AoqVideoCodecConfig | Configuración de decodificación de video |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
trackType | AoqTrackType | Tipo de pista multimedia |
enable | boolean | true: activar transmisión; false: desactivar transmisión |
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.
| Parámetro | Tipo | Descripción |
|---|---|---|
msg | AoqDataMsg | Objeto mensaje; msg.data debe contener bytes UTF-8 no vacíos |
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.
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.
| Evento | Firma del callback | Descripción |
|---|---|---|
onError | (code: number, message: string) => void | Callback de error |
onWarning | (code: number, message: string) => void | Callback de advertencia |
onConnectionStatusChange | (status: AoqConnectionStatus) => void | Cambios de estado de conexión |
onStats | (stats: AoqStats) => void | Estadísticas |
onAudioDeviceStateChanged | (state: AoqAudioDeviceState) => void | Cambios de estado del dispositivo de audio |
onAudioDeviceRouteChanged | (routeType: AoqAudioDeviceRouteType) => void | Cambios de ruta de audio |
onAudioFileState | (state: AoqAudioFileState) => void | Reservado; actualmente no se emite |
onLocalAudioVolumeIndication | (volume: AoqAudioVolume) => void | Indicación de volumen local |
onVideoDeviceStateChanged | (state: AoqVideoDeviceState) => void | Cambios de estado del dispositivo de video |
onDataMsg | (msg: AoqDataMsg) => void | Mensajes 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.
| Parámetro | Tipo | Descripción |
|---|---|---|
code | number | Código de error; consulte AoqErrorCode |
message | string | Descripción del error |
onWarning
Informa advertencias del motor sobre condiciones no fatales que requieren atención.
| Parámetro | Tipo | Descripción |
|---|---|---|
code | number | Código de advertencia; consulte AoqWarningCode |
message | string | Descripción de la advertencia |
onConnectionStatusChange
Informa cambios de estado de conexión.
| Parámetro | Tipo | Descripción |
|---|---|---|
status | AoqConnectionStatus | Estado 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.
| Parámetro | Tipo | Descripción |
|---|---|---|
stats | AoqStats | Objeto de estadísticas |
onAudioDeviceStateChanged
Informa cambios de estado de operaciones de captura y reproducción de audio.
| Parámetro | Tipo | Descripción |
|---|---|---|
state | AoqAudioDeviceState | Estado 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.
| Parámetro | Tipo | Descripción |
|---|---|---|
routeType | AoqAudioDeviceRouteType | Ruta 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.
| Parámetro | Tipo | Descripción |
|---|---|---|
state | AoqAudioFileState | Estado del archivo de audio |
onLocalAudioVolumeIndication
Informa el volumen de captura local. Active primero enableLocalAudioVolumeIndication.
| Parámetro | Tipo | Descripción |
|---|---|---|
volume | AoqAudioVolume | Información de volumen |
onVideoDeviceStateChanged
Informa cambios de estado de operaciones de captura de video.
| Parámetro | Tipo | Descripción |
|---|---|---|
state | AoqVideoDeviceState | Estado del dispositivo de video |
onDataMsg
Informa mensajes de datos recibidos.
| Parámetro | Tipo | Descripción |
|---|---|---|
msg | AoqDataMsg | Objeto mensaje recibido. Use TextDecoder para leer el texto UTF-8 de msg.data. |
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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
workDir | string | No | — | Reservado; el SDK web no utiliza este campo para seleccionar el directorio de almacenamiento |
enableDumpAudio | boolean | No | false | Guardar audio de depuración. Obtenga autorización y controle el acceso al audio del usuario. |
enableDumpExport | boolean | No | false | Solo se aplica con enableDumpAudio=true. Exporta un ZIP de dump y elimina los archivos OPFS asociados de forma asíncrona al destruir. |
maxEncodedVideoFrameBytes | number | No | 194560 (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. |
enableDropOversizedVideoFrame | boolean | No | false | Descartar 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. |
extras | string | No | — | Cadena de objeto JSON. JSON no válido, valor no objeto o política de renderizado no válida hace que createEngine devuelva null. |
extras admitidos:
| Campo JSON | Tipo | Predeterminado | Descripción |
|---|---|---|---|
remoteVideoRenderer | 'auto' | 'video' | 'canvas' | 'auto' | Política de renderizado remoto. auto prefiere video y usa canvas cuando es necesario. |
user_specified_enable_av_sync | boolean | true | Activar sincronización de audio/video. Use un booleano JSON. |
user_specified_audio_playback_transport | 'message-port' | Automático | Fuerza reproducción con MessagePort. Si se omite, selecciona memoria compartida o MessagePort según el entorno. |
AoqConnectConfig
Configuración de autenticación de conexión.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
token | string | Sí | — | Token temporal de cliente no vacío, correspondiente a aoqTokenForClient, no una clave API |
sid | string | Sí | — | ID de sesión no vacío. Use la cadena sid completa de la respuesta de autenticación. |
wtBaseUrl | string | No | Derivada de Relay | URL HTTPS WT preferida con una sola ruta. Se ignora con varias rutas, que conectan a /aoq en cada host y puerto. |
signedSid | string | Sí (en ejecución) | — | SID firmado completo, normalmente el sid completo de autenticación. Opcional en TypeScript, obligatorio en el flujo WT actual. |
certFingerprint | string | string[] | Condicional | — | Huella SHA-256 compartida del certificado WT. Las rutas sin huella propia deben poder utilizarla. |
workspaceIdHash | string | No | — | Corresponde a extraInfo.workspaceIdHash. No lo sustituya por el Workspace ID original. |
relayEndpoints | AoqRelayEndpoint[] | Sí | — | Lista completa de endpoints con al menos una entrada |
publishTracks | AoqTrackParam[] | Sí | — | Pistas ascendentes. Puede estar vacía, pero no junto con subscribeTracks. |
subscribeTracks | AoqTrackParam[] | Sí | — | Pistas descendentes. Puede estar vacía. No admite pistas duplicadas en la misma dirección ni Screen. |
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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
routeIndex | number | Sí (en ejecución) | — | Entero único entre 0 y 2147483647. Inicialmente se usa el menor índice. Opcional en TypeScript. |
certFingerprint | string | string[] | Condicional | Huella compartida | La huella no vacía de la ruta sustituye la compartida. Obligatoria si no hay huella compartida. |
endpoint | string | Sí | — | Host o IP WT sin esquema, ruta, espacios, información de usuario ni consulta. Admite IPv6. |
port | number | Sí | — | Puerto WT, entero entre 1 y 65535 |
AoqTrackParam
Propiedades de pista.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
trackType | AoqTrackType | Sí | — | Audio, Video o Data. Sin duplicados en una dirección. Screen aún no se admite. |
trackMode | AoqTrackMode | No | Segment para audio descendente | Solo 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.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
supported | boolean | — | Si el entorno tiene capacidades básicas de conexión AOQ |
missingFeatures | AoqMissingFeature[] | — | 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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
channel | number | No | 1 | Canales 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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
channel | number | No | 1 | Canales solicitados: 1 o 2. La salida usa la frecuencia real de AudioContext. |
playOnlyAndIgnoreMute | boolean | No | false | Solo 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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
trackType | AoqTrackType | No | — | Reservado; actualmente no selecciona el flujo de audio |
codecType | AoqEncoderType | No | AoqEncoderTypeAudioPCM | PCM / Opus. Debe coincidir con la configuración negociada con el par. |
sampleRate | number | No | 48000 | Frecuencia en Hz. Valores negociados: 8000, 12000, 16000, 24000, 32000, 44100, 48000. El navegador también debe admitir la codificación elegida. |
channel | number | No | 1 | Número de canales: 1 o 2 |
bitrate | number | No | 32000 (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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
interval | number | No | 0 | Intervalo de callback en ms. Valores <=0 desactivan; valores positivos menores de 10 se tratan como 10. |
smooth | number | No | 3 | Factor de suavizado, 0..10. Los valores mayores suavizan más. |
reportSpeech | boolean | No | false | Informar actividad de voz (VAD) |
AoqAudioVolume
Información de volumen local.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
volume | number | — | Volumen instantáneo suavizado, rango [0-255] |
isSpeech | boolean | — | 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.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
state | AoqAudioDeviceStateCode | — | Código de estado del dispositivo de audio |
reason | number | — | 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.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
fileId | string | — | ID de archivo de audio |
stateCode | AoqAudioFileStateCode | — | Código de estado de reproducción del archivo |
errorCode | number | — | Código de error |
Tipos de video
AoqVideoCaptureConfig
Configuración de captura de video.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
width | number | No | 1280 | Ancho solicitado en píxeles con restricción ideal. El navegador/dispositivo elige el valor real. |
height | number | No | 720 | Alto solicitado en píxeles con restricción ideal. El navegador/dispositivo elige el valor real. |
fps | number | No | 15 | Frecuencia de captura solicitada con restricciones ideal y max |
cameraPreference | AoqCameraDirection | string | No | Selección del navegador | Orientació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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
trackType | AoqTrackType | No | — | Reservado; actualmente no selecciona el flujo de video |
codecType | AoqEncoderType | No | AoqEncoderTypeVideoH264 | H.264 / JPEG. Debe coincidir con la configuración negociada con el par. |
width | number | No | 540 | Ancho objetivo de codificación o negociado en bajada, en píxeles. Entero positivo obligatorio al conectar. |
height | number | No | 960 | Alto objetivo de codificación o negociado en bajada, en píxeles. Entero positivo obligatorio al conectar. |
fps | number | No | 5 | Frecuencia de codificación o negociada en bajada. Entero positivo obligatorio al conectar. |
bitrate | number | No | 500000 (codificación) | Tasa objetivo positiva de codificación en bps. No se usa en decodificación. |
minBitrate | number | No | 128000 | Tasa 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. |
keyframeInterval | number | No | 2 | Intervalo 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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
view | HTMLElement | string | Sí | — | Contenedor normal o su ID DOM sin #. No use directamente video, audio, canvas, img ni elementos vacíos. |
renderMode | AoqRenderMode | No | AoqRenderModeAuto(0) | Modo de ajuste de video |
AoqVideoDeviceState
Datos de callback de estado del dispositivo de video.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
state | AoqVideoDeviceStateCode | — | Código de estado del dispositivo de video |
reason | number | — | 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.
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
data | Uint8Array | Sí | — | 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.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
audioPublishStats | AoqAudioPublishStats[] | — | Estadísticas de publicación de audio |
audioSubscribeStats | AoqAudioSubscribeStats[] | — | Estadísticas de suscripción de audio |
videoPublishStats | AoqVideoPublishStats[] | — | Estadísticas de publicación de video |
videoSubscribeStats | AoqVideoSubscribeStats[] | — | Estadísticas de suscripción de video |
dataMsgPublishStats | AoqDataMsgPublishStats[] | — | Estadísticas de publicación de mensajes de datos |
dataMsgSubscribeStats | AoqDataMsgSubscribeStats[] | — | Estadísticas de suscripción de mensajes de datos |
networkStats | AoqNetworkStats | — | Estadísticas de red |
AoqAudioPublishStats
Estadísticas de publicación de audio.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de pista |
bitrate | number | — | Tasa total ascendente de aplicación de la conexión en bps, no solo audio |
bytes | number | — | Bytes totales ascendentes de aplicación de la conexión, no solo audio |
encodeVolume | number | 0 | Valor de relleno. Use onLocalAudioVolumeIndication para volumen de captura. |
AoqAudioSubscribeStats
Estadísticas de suscripción de audio.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de pista |
bitrate | number | — | Tasa total descendente de aplicación de la conexión en bps, no solo audio |
bytes | number | — | Bytes totales descendentes de aplicación de la conexión, no solo audio |
playVolume | number | 0 | Valor de relleno; no indica si la reproducción está silenciada |
AoqVideoPublishStats
Estadísticas de publicación de video.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de pista |
bitrate | number | 0 | Valor de relleno; no se informa la tasa de video aislada |
bytes | number | 0 | Valor de relleno; no se informa el número de bytes de video aislado |
encodeFps | number | — | Frecuencia de fotogramas codificados |
AoqVideoSubscribeStats
Estadísticas de suscripción de video.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de pista |
bitrate | number | 0 | Valor de relleno; no se informa la tasa de video aislada |
bytes | number | 0 | Valor de relleno; no se informa el número de bytes de video aislado |
decodeFps | number | — | Frecuencia de fotogramas decodificados |
renderFps | number | — | Frecuencia de fotogramas renderizados |
AoqDataMsgPublishStats
Estadísticas de publicación de mensajes de datos.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de pista |
bitrate | number | — | Tasa actual en bps |
bytes | number | — | Bytes enviados acumulados |
AoqDataMsgSubscribeStats
Estadísticas de suscripción de mensajes de datos.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
trackType | AoqTrackType | — | Tipo de pista |
bitrate | number | — | Tasa actual en bps |
bytes | number | — | Bytes recibidos acumulados |
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.
| Campo | Tipo | Predeterminado | Descripción |
|---|---|---|---|
sendBitrate | number | — | Tasa ascendente en bps |
sendBytes | number | — | Bytes ascendentes acumulados |
recvBitrate | number | — | Tasa descendente en bps |
recvBytes | number | — | Bytes descendentes acumulados |
loss | number | — | 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. |
rtt | number | — | Tiempo de ida y vuelta opcional en ms; se omite si se desconoce |
bwe | number | — | Presupuesto efectivo opcional de envío de aplicación Client→Relay en bps; se omite si se desconoce o caducó |
audioReserveBps | number | — | 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 enum | Valor | Descripción |
|---|---|---|
AoqTrackTypeAudio | 0 | Audio |
AoqTrackTypeVideo | 1 | Video |
AoqTrackTypeData | 2 | Mensajes de datos |
AoqTrackTypeScreen | 3 | Reservado; no admitido en el flujo de conexión actual |
AoqTrackMode
Modo de transporte de audio.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqTrackModeSegment | 0 | Modo Segment |
AoqTrackModeStream | 1 | Modo de flujo Realtime |
AoqEncoderType
Formato multimedia de la pista.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqEncoderTypeUnknown | 0 | Desconocido |
AoqEncoderTypeAudioPCM | 1 | Audio PCM |
AoqEncoderTypeAudioOpus | 2 | Audio Opus |
AoqEncoderTypeVideoH264 | 3 | Video H.264 |
AoqEncoderTypeVideoJpeg | 4 | Video JPEG |
AoqEncoderTypeDataText | 5 | Datos de texto |
AoqConnectionStatus
Estado de conexión del motor.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqConnectionStatusDisconnected | 0 | Desconectado |
AoqConnectionStatusConnecting | 1 | Conectando |
AoqConnectionStatusConnected | 2 | Conectado |
AoqConnectionStatusFailed | 3 | Conexión fallida |
AoqErrorCode
Códigos de error.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqECOK | 0 | Éxito |
AoqECParamInvalid | 1 | Parámetro no válido |
AoqECStateInvalid | 2 | Estado no válido |
AoqECUnSupport | 3 | No implementado en la plataforma/modo actual |
AoqECAudio | 100 | Error general de audio |
AoqECAudioExternalBufferFull | 110 | Búfer de audio externo lleno |
AoqECAudioDevice | 120 | Error general del dispositivo de audio |
AoqECAudioDeviceRecordingAuthFailed | 121 | Permiso de micrófono denegado |
AoqECAudioDeviceRecordingOccupied | 122 | Micrófono en uso |
AoqECAudioDeviceRecordingBackgroundStart | 123 | Captura iniciada en segundo plano |
AoqECAudioDeviceRecordingStartFail | 124 | Error al iniciar captura |
AoqECAudioDevicePlayoutOccupied | 125 | Dispositivo de reproducción en uso |
AoqECAudioDevicePlayoutBackgroundStart | 126 | Reproducción iniciada en segundo plano |
AoqECAudioDevicePlayoutStartFail | 127 | Error al iniciar reproducción |
AoqECAudioDeviceEarpieceRequiresVoipMode | 128 | Auricular requiere modo VoIP |
AoqECVideo | 200 | Error general de video |
AoqECVideoExternalBufferFull | 210 | Búfer de video externo lleno |
AoqECVideoExternalCaptureNotEnabled | 211 | Captura de video externa no activada |
AoqECVideoExternalEncoderNotEnabled | 212 | Codificador de video externo no activado |
AoqECVideoDevice | 220 | Error general del dispositivo de video |
AoqECVideoDeviceCameraOpenFail | 221 | Error al abrir cámara |
AoqECVideoDeviceCameraAuthFailed | 222 | Permiso de cámara denegado |
AoqECVideoDeviceCameraOccupied | 223 | Cámara en uso |
AoqECVideoDeviceCameraRunningError | 224 | Error de ejecución de la cámara |
AoqECVideoCodec | 230 | Error general del códec de video |
AoqECVideoCodecEncoderInitFail | 231 | Error de inicialización del codificador de video |
AoqECVideoRender | 240 | Error general de renderizado de video |
AoqECVideoRenderCreateFail | 241 | Error al crear renderizador |
AoqECVideoRenderDrawError | 242 | Error de dibujo en el renderizado |
AoqWarningCode
Códigos de advertencia.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqWCOK | 0 | Normal |
AoqWCAudio | 100 | Advertencia general de audio |
AoqWCAudioHowling | 101 | Retroalimentación acústica detectada |
AoqWCAudioDevice | 120 | Advertencia general del dispositivo de audio |
AoqWCAudioDeviceMicEnumerateError | 121 | Error al enumerar micrófonos |
AoqWCAudioDeviceMicStartTimeout | 122 | Tiempo de espera de inicio del micrófono agotado |
AoqWCAudioDeviceRecordingError | 123 | Error de captura |
AoqWCAudioDeviceSpeakerEnumerateError | 124 | Error al enumerar altavoces |
AoqWCAudioDeviceSpeakerStartTimeout | 125 | Tiempo de espera de inicio del altavoz agotado |
AoqWCAudioDevicePlayoutError | 126 | Error de reproducción |
AoqWCAudioDeviceSilentMode | 127 | Dispositivo en modo silencioso |
AoqWCVideo | 200 | Advertencia general de video |
AoqWCVideoCameraEnumerateError | 201 | Error al enumerar cámaras |
AoqWCVideoEncoderSwitched | 202 | Codificador de video cambiado |
AoqWCVideoRenderDowngrade | 203 | Renderizado alternativo |
AoqAudioDeviceStateCode
Códigos de estado del dispositivo de audio.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqAudioDeviceNone | 0 | Sin estado |
AoqAudioDeviceRecordStarting | 1 | Iniciando captura |
AoqAudioDeviceRecordStarted | 2 | Captura iniciada |
AoqAudioDeviceRecordStopping | 3 | Deteniendo captura |
AoqAudioDeviceRecordStopped | 4 | Captura detenida |
AoqAudioDeviceRecordFail | 5 | Captura fallida |
AoqAudioDevicePlayStarting | 6 | Iniciando reproducción |
AoqAudioDevicePlayStarted | 7 | Reproducción iniciada |
AoqAudioDevicePlayStopping | 8 | Deteniendo reproducción |
AoqAudioDevicePlayStopped | 9 | Reproducción detenida |
AoqAudioDevicePlayFail | 10 | Reproducción fallida |
AoqAudioDeviceRouteType
Tipos de ruta del dispositivo de audio.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqAudioDeviceRouteDefault | 0 | Ruta predeterminada |
AoqAudioDeviceRouteHeadset | 1 | Auriculares |
AoqAudioDeviceRouteSpeakerPhone | 4 | Altavoz integrado |
AoqAudioDeviceRouteUsb | 5 | Dispositivo USB |
AoqAudioDeviceRouteBluetooth | 6 | Dispositivo Bluetooth |
AoqAudioFileStateCode
Códigos de estado de reproducción de archivos de audio.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqAudioFileNone | 0 | Sin estado |
AoqAudioFileStarted | 1 | Reproducción iniciada |
AoqAudioFileStopped | 2 | Reproducción detenida |
AoqAudioFilePaused | 3 | Reproducción pausada |
AoqAudioFileResumed | 4 | Reproducción reanudada |
AoqAudioFileEnded | 5 | Reproducción finalizada |
AoqAudioFileBuffering | 6 | Almacenando en búfer |
AoqAudioFileBufferingEnd | 7 | Almacenamiento en búfer terminado |
AoqAudioFileFailed | 8 | Reproducción fallida |
AoqCameraDirection
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqCameraDirectionFront | 0 | Preferir cámara frontal |
AoqCameraDirectionBack | 1 | Preferir cámara trasera |
AoqVideoDeviceStateCode
Códigos de estado del dispositivo de video.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqVideoDeviceNone | 0 | Sin estado |
AoqVideoDeviceCaptureStarting | 1 | Iniciando captura |
AoqVideoDeviceCaptureStarted | 2 | Captura iniciada |
AoqVideoDeviceCaptureStopping | 3 | Deteniendo captura |
AoqVideoDeviceCaptureStopped | 4 | Captura detenida |
AoqVideoDeviceCaptureFail | 5 | Captura fallida |
AoqMirrorMode
Enum de reflejo reservado. El SDK web no tiene configuración ni API que lo utilice.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqMirrorModeDisabled | 0 | Reflejo desactivado |
AoqMirrorModeEnabled | 1 | Reflejo activado |
AoqOrientationMode
Enum de orientación reservado. El SDK web no tiene configuración ni API que lo utilice.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqOrientationModeAuto | 0 | Automático |
AoqOrientationModePortrait | 1 | Vertical |
AoqOrientationModeLandscape | 2 | Horizontal |
AoqRenderMode
Modos de ajuste de video.
| Miembro de enum | Valor | Descripción |
|---|---|---|
AoqRenderModeAuto | 0 | Predeterminado: mostrar imagen completa conservando proporciones |
AoqRenderModeStretch | 1 | Estirar para llenar el contenedor |
AoqRenderModeFill | 2 | Mostrar imagen completa conservando proporciones, permitiendo barras negras |
AoqRenderModeCrop | 3 | Llenar 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ía | Declaraciones públicas | Compatibilidad actual |
|---|---|---|
| Mezcla de archivos de audio | AoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCode | Sin controles de reproducción o mezcla de archivos; no se emiten eventos de estado de archivo |
| Audio externo y observadores | AoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirection | Sin métodos de entrada de audio externo ni registro de observadores de tramas de audio |
| Video externo y observadores | AoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecType | Sin entrada de fotogramas externos ni registro de observadores de video. La configuración del códec utiliza AoqEncoderType. |
| Reflejo y orientación | AoqMirrorMode, AoqOrientationMode | Sin campos ni métodos correspondientes. El reflejo de vista previa local es automático. |
| Dispositivos de audio de bajo nivel | AoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCode | Declaraciones 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.