Skip to main content

Référence API du SDK Web AOQ

Le SDK Web AOQ prend en charge les interactions audio, vidéo et de données en temps réel dans les navigateurs. Cette référence décrit les API de gestion du moteur, de capture et de lecture audio et vidéo, de messages de données et de callbacks d’événements.

Installer le SDK

Le SDK Web AOQ se connecte au serveur via WebTransport (HTTP/3 / QUIC) et échange des messages audio, vidéo et de données dans un Worker. Il nécessite un navigateur compatible WebTransport et un contexte sécurisé HTTPS. Utilisez AoqClientEngine.isAoqSupported() pour vérifier les capacités de base du navigateur. Installez le SDK avec npm :
npm install aoq-web-sdk@1.0.1-60040320
Vous pouvez également obtenir le package d’installation sur Téléchargement du SDK, puis exécuter la commande suivante dans le répertoire du projet. Remplacez le chemin du package par son emplacement réel.
npm install ./aoq-web-sdk-1.0.1-60040320.tgz

Liste des API

Cycle de vie du moteur

APIDescription
createEngineCréer un moteur singleton
createAoqClientEngineFonction de fabrique nommée équivalente
destroyDétruire le moteur
getVersionObtenir la version du SDK
isAoqSupportedVérifier les capacités du navigateur
connectÉtablir une connexion
disconnectDéconnecter

Gestion des périphériques audio

APIDescription
startAudioCaptureDémarrer la capture audio
stopAudioCaptureArrêter la capture audio
muteAudioCaptureCouper le son de la capture audio
startAudioPlayerDémarrer la lecture audio
stopAudioPlayerArrêter la lecture audio
pauseAudioPlayerSuspendre la lecture avec fondu sortant
resumeAudioPlayerReprendre la lecture avec fondu entrant par défaut
interruptAudioPlayerInterrompre la lecture

Configuration du codage audio

APIDescription
setAudioEncoderConfigDéfinir les paramètres de codage audio
setAudioDecoderConfigDéfinir les paramètres de décodage audio

Indication du volume local

APIDescription
enableLocalAudioVolumeIndicationActiver l’indication du volume local

Gestion des périphériques vidéo

APIDescription
startVideoCaptureDémarrer la capture vidéo
getCamerasÉnumérer les caméras
switchCameraChanger de caméra selon une préférence d’orientation ou un ID de périphérique
stopVideoCaptureArrêter la capture vidéo
setLocalViewDéfinir le conteneur vidéo local
setRemoteViewDéfinir le conteneur vidéo distant

Configuration du codage vidéo

APIDescription
setVideoEncoderConfigDéfinir les paramètres de codage vidéo
setVideoDecoderConfigDéfinir les paramètres de décodage vidéo

Contrôle de la transmission des flux multimédias

APIDescription
enableSendMediaStreamActiver ou désactiver la transmission des flux multimédias

Messages en temps réel

APIDescription
sendDataMsgEnvoyer un message de données

Callbacks d’événements

APIDescription
onErrorCallback d’erreur
onWarningCallback d’avertissement
onConnectionStatusChangeChangements d’état de connexion
onStatsStatistiques
onAudioDeviceStateChangedChangements d’état du périphérique audio
onAudioDeviceRouteChangedChangements de route audio
onAudioFileStateÉvénement réservé d’état de fichier audio ; non émis actuellement
onLocalAudioVolumeIndicationIndication du volume local
onVideoDeviceStateChangedChangements d’état du périphérique vidéo
onDataMsgMessages de données

Détails des API

Cycle de vie du moteur

createEngine

Crée un moteur singleton. Les appels répétés renvoient l’instance existante.
static createEngine(config: AoqCreateConfig): AoqClientEngine | null
ParamètreTypeDescription
configAoqCreateConfigConfiguration de création du moteur
Renvoie une instance AoqClientEngine en cas de succès, ou null en cas d’échec. Le singleton initialisé est renvoyé sans réappliquer la configuration. Détruisez-le avant de créer un moteur avec une nouvelle configuration.

createAoqClientEngine

Fabrique nommée exportée par le package, équivalente à AoqClientEngine.createEngine(config). Ce n’est pas une méthode d’instance et aucune initialisation supplémentaire n’est nécessaire.
function createAoqClientEngine(config: AoqCreateConfig): AoqClientEngine | null
ParamètreTypeDescription
configAoqCreateConfigObligatoire ; {} est valide. Une création répétée ne réapplique pas la configuration.
Renvoie le moteur singleton en cas de succès, ou null en cas d’échec.
import { createAoqClientEngine } from 'aoq-web-sdk';

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

destroy

Détruit le moteur, commence à libérer les ressources et supprime tous les écouteurs d’événements.
static destroy(): number
Renvoie 0 en cas de succès, ou AoqECStateInvalid(2) si aucune instance n’existe. La méthode retourne de manière synchrone. L’enregistrement des journaux et l’export facultatif des dumps sont asynchrones et peuvent être encore en cours. Créez un nouveau moteur avec createEngine avant de réutiliser le SDK ; l’instance détruite n’est plus utilisable.

getVersion

Obtient la version du SDK.
static getVersion(): string
Renvoie la version du package installé sous forme de chaîne, et non la révision du document ou l’ID de commit du code source.

isAoqSupported

Vérifie les capacités de base du navigateur nécessaires à une connexion AOQ.
static isAoqSupported(): Promise<AoqSupportResult>
Renvoie Promise<AoqSupportResult> avec le résultat et les capacités manquantes. La vérification teste WebTransport dans un Worker avec un délai de 5 secondes. Elle ne contrôle pas l’accès réseau, la configuration du serveur, l’authentification, les autorisations des périphériques ou les configurations multimédias spécifiques. supported: true ne garantit pas la réussite d’une connexion ou d’un appel.

connect

Établit une connexion au serveur.
connect(config: AoqConnectConfig): number
ParamètreTypeDescription
configAoqConnectConfigIdentifiants de connexion, dont le token, l’ID de session et les points de terminaison du relais
Renvoie 0 lorsque la demande est acceptée. Appelez après la création du moteur, l’inscription aux événements et la configuration des codecs. La connexion démarre normalement depuis Disconnected ; une nouvelle tentative depuis Failed est autorisée. Les autres états renvoient AoqECStateInvalid(2). Des paramètres de piste, de média ou de connexion invalides, ou Opus sans les capacités WebCodecs requises, peuvent renvoyer AoqECParamInvalid(1). Un Network Worker indisponible renvoie AoqECStateInvalid(2). Le résultat est signalé de manière asynchrone par onConnectionStatusChange. Connected signifie que MEDIA_SETUP est terminé et que les pistes sont liées. Configurez la session selon le protocole de données du modèle et confirmez que l’application est prête avant d’activer l’envoi audio ou vidéo.

disconnect

Déconnecte du serveur.
disconnect(): number
Renvoie 0 lorsque la demande est acceptée. Le résultat est signalé par onConnectionStatusChange. Attendez AoqConnectionStatusDisconnected avant de modifier les codecs et de reconnecter. Un appel déjà déconnecté renvoie AoqECStateInvalid(2). La déconnexion n’arrête pas les périphériques ; appelez également les méthodes d’arrêt de capture et de lecture à la fin d’un appel.

Gestion des périphériques audio

startAudioCapture

Démarre la capture du microphone et demande l’autorisation de manière asynchrone.
startAudioCapture(config: AoqAudioCaptureConfig): Promise<number>
ParamètreTypeDescription
configAoqAudioCaptureConfigConfiguration de capture audio
Renvoie Promise<number> ; 0 indique un succès. Le navigateur peut demander l’autorisation du microphone à la première utilisation ou si elle n’a pas été accordée. Les changements d’état sont signalés par onAudioDeviceStateChanged. En cas de congestion, l’audio montant en attente depuis environ 100 ms dans la file d’envoi est abandonné pour limiter l’accumulation de latence. L’audio dont l’envoi a commencé n’est pas retiré. Ce seuil n’est pas une limite de latence de bout en bout.

stopAudioCapture

Arrête la capture audio.
stopAudioCapture(): number
Renvoie 0 en cas de succès. Renvoie AoqECStateInvalid(2) si le périphérique n’a pas démarré ou est déjà arrêté.

muteAudioCapture

Coupe ou réactive le son de la capture audio. La capture continue en mode muet, mais des trames silencieuses sont envoyées.
muteAudioCapture(mute: boolean): number
ParamètreTypeDescription
mutebooleantrue : couper le son ; false : réactiver le son
Renvoie 0 en cas de succès.

startAudioPlayer

Démarre le lecteur audio et initialise le périphérique de sortie de manière asynchrone.
startAudioPlayer(config: AoqAudioPlaybackConfig): Promise<number>
ParamètreTypeDescription
configAoqAudioPlaybackConfigConfiguration de lecture audio
Renvoie Promise<number> ; 0 indique un succès. Les changements d’état de lecture sont signalés par onAudioDeviceStateChanged. Appelez depuis un gestionnaire de clic utilisateur et gérez les restrictions de lecture automatique. Un appel pendant le démarrage ou lorsque le lecteur est déjà démarré renvoie AoqECStateInvalid(2). En mode Realtime (trackMode audio descendant égal à Stream), l’audio reçu avant le démarrage du lecteur est consommé en continu sans s’accumuler. Chaque démarrage, y compris le premier, supprime l’audio antérieur et ne lit que le nouvel audio. Le mode Segment conserve l’audio non lu.

stopAudioPlayer

Arrête le lecteur audio.
stopAudioPlayer(): number
Renvoie 0 en cas de succès. Renvoie AoqECStateInvalid(2) si le périphérique n’a pas démarré ou est déjà arrêté. En mode Realtime, l’audio entrant continue d’être consommé après l’arrêt de la sortie, et la vidéo continue. Un redémarrage ne lit que le nouvel audio. Les états de pause ou d’interruption sont conservés. Le mode Segment conserve l’audio non lu.

pauseAudioPlayer

Suspend la lecture après le fondu sortant. Appelez resumeAudioPlayer pour reprendre.
pauseAudioPlayer(fadeMs: number): number
ParamètreTypeDescription
fadeMsnumberDurée du fondu sortant en ms, arrondie en nombre d’échantillons au taux réel du périphérique. 0 désactive le fondu ; les valeurs négatives ou non finies utilisent 100 ms.
Renvoie 0 à l’acceptation de la demande. Le fondu peut ne pas être terminé et le lecteur peut ne pas être en cours de lecture. Le mode Segment conserve l’audio restant et la position de lecture, puis reprend à cet endroit. Le mode Realtime supprime l’audio en attente et continue de consommer l’audio reçu pendant la pause ; il reprend à la position courante, sans rejouer cet intervalle.

resumeAudioPlayer

Reprend une lecture suspendue ou interrompue avec le fondu entrant par défaut : 2 ms en mode Segment, 100 ms en mode Realtime.
resumeAudioPlayer(fadeMs: number): number
ParamètreTypeDescription
fadeMsnumberRéservé et actuellement ignoré. Le fondu par défaut est utilisé ; 0 ne le désactive pas.
Renvoie 0 à l’acceptation de la demande ; la reprise peut être encore en cours.

interruptAudioPlayer

Interrompt la lecture et supprime l’audio restant après le fondu sortant. Contrairement à une pause en mode Segment, l’audio supprimé n’est pas rejoué à la reprise.
interruptAudioPlayer(trackType: AoqTrackType, fadeMs: number): number
ParamètreTypeDescription
trackTypeAoqTrackTypeParamètre de compatibilité. Utilisez Audio. Ne sélectionne actuellement pas le flux de lecture.
fadeMsnumberDurée du fondu sortant en ms, arrondie en nombre d’échantillons au taux réel du périphérique. 0 désactive le fondu ; les valeurs négatives ou non finies utilisent 100 ms.
Renvoie 0 à l’acceptation de la demande. L’interruption peut être encore en cours et le lecteur peut ne pas être en cours de lecture. La lecture reprend automatiquement lorsque le serveur envoie l’audio d’un nouveau tour. Vous pouvez aussi appeler resumeAudioPlayer. Une interruption demandée pendant une pause est ignorée mais peut renvoyer 0. Le mode Segment reprend ensuite l’audio conservé avant la pause. La séquence pause puis interruption ne vide pas la file de lecture.

Configuration du codage audio

setAudioEncoderConfig

Définit les paramètres de codage audio.
setAudioEncoderConfig(config: AoqAudioCodecConfig): number
ParamètreTypeDescription
configAoqAudioCodecConfigConfiguration du codage audio
Renvoie 0 en cas de succès. Appelez avant connect() lorsque le moteur est Disconnected. Toute modification pendant la connexion ou à l’état connecté renvoie AoqECStateInvalid(2). Déconnectez, attendez Disconnected, configurez, puis reconnectez. Le retour 0 indique l’acceptation de la configuration. Le format audio est de nouveau validé à la connexion. Opus nécessite aussi WebCodecs dans le navigateur.

setAudioDecoderConfig

Définit les paramètres de décodage audio.
setAudioDecoderConfig(config: AoqAudioCodecConfig): number
ParamètreTypeDescription
configAoqAudioCodecConfigConfiguration du décodage audio
Renvoie 0 en cas de succès. Appelez avant connect() lorsque le moteur est Disconnected. Toute modification pendant la connexion ou à l’état connecté renvoie AoqECStateInvalid(2).

Indication du volume local

enableLocalAudioVolumeIndication

Active ou désactive les notifications périodiques de volume local via onLocalAudioVolumeIndication.
enableLocalAudioVolumeIndication(config: AoqAudioVolumeIndicationConfig): number
ParamètreTypeDescription
configAoqAudioVolumeIndicationConfigConfiguration de l’indication de volume
Renvoie 0 en cas de succès. Définissez interval sur 0 ou une valeur négative pour désactiver les callbacks.

Gestion des périphériques vidéo

startVideoCapture

Démarre la capture de la caméra.
startVideoCapture(config: AoqVideoCaptureConfig): number
ParamètreTypeDescription
configAoqVideoCaptureConfigConfiguration de capture vidéo
Renvoie 0 en cas de succès. Le retour 0 indique l’acceptation de la demande asynchrone. Le succès ou l’échec est signalé par onVideoDeviceStateChanged ; la caméra n’est pas nécessairement déjà active. cameraPreference accepte un enum d’orientation ou un ID de périphérique. Si omis, le navigateur choisit. Une autre caméra peut être utilisée si la préférence n’est pas satisfaite.

getCameras

getCameras(): Promise<MediaDeviceInfo[]>
Énumère les périphériques videoinput visibles sans ouvrir de caméra ni demander d’autorisation. Les noms ou IDs peuvent être incomplets avant autorisation. Réénumérez après autorisation ou modification des périphériques. La Promise est rejetée si le moteur n’est pas initialisé ou si l’énumération échoue.

switchCamera

switchCamera(cameraPreference?: AoqCameraDirection | string): number
ParamètreTypeObligatoireDescription
cameraPreferenceAoqCameraDirection | stringNonOrientation ou ID préféré. Omettez pour effacer la préférence précédente et laisser le navigateur choisir à nouveau.
L’orientation et l’ID utilisent des contraintes ideal, autorisant une caméra de repli. 0 indique l’acceptation. L’état est signalé par onVideoDeviceStateChanged, les échecs par onError. Renvoie AoqECStateInvalid(2) sans capture active, au démarrage ou pendant un changement ; une orientation invalide ou un ID vide renvoie AoqECParamInvalid(1). Le changement libère l’ancien périphérique, ouvre la cible et attend sa première image. Si l’ancienne piste a été transférée à un Worker, même avec retour ultérieur au thread principal, la confirmation de libération est attendue pendant 2 secondes au plus. Son expiration signale un échec sans ouverture ni restauration. Chaque tentative dure au plus 15 secondes. En cas d’échec, une tentative restaure la capture avec la préférence initiale ; même une restauration réussie signale l’échec du changement. Succès : CaptureStarted(reason=0) ; échec avec restauration : CaptureStarted(reason=code d’erreur) ; restauration impossible : CaptureFail(reason=code d’erreur). Si la cible explicite est déjà satisfaite, CaptureStarted est émis de manière asynchrone sans réouverture. Le callback n’indique pas l’ID réel. Le changement conserve le contrôle d’envoi, les codecs et l’aperçu. Arrêter la capture annule le changement ; détruire le moteur supprime les callbacks suivants. Le changement peut interrompre brièvement la vidéo. La chronologie reste continue, sans garantie de synchronisation audio/vidéo matérielle. Le navigateur choisit le périphérique réel ; ne présentez pas la préférence demandée comme un périphérique confirmé.

stopVideoCapture

Arrête la capture vidéo.
stopVideoCapture(): number
Renvoie 0 en cas de succès. Renvoie AoqECStateInvalid(2) si le périphérique n’a pas démarré ou est déjà arrêté.

setLocalView

Définit le conteneur vidéo local. Le SDK crée les éléments de rendu à l’intérieur.
setLocalView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParamètreTypeDescription
trackTypeAoqTrackTypeSeul AoqTrackTypeVideo est pris en charge. Les autres types renvoient AoqECUnSupport(3).
canvasAoqVideoCanvas | nullConfiguration du conteneur de rendu. Passez null pour délier.
Renvoie 0 en cas de succès. Donnez au conteneur des dimensions explicites. Le SDK y crée ses éléments de rendu. Utilisez un conteneur DOM standard de dimensions explicites, tel qu’un div. Ne passez pas directement video, audio, canvas, img ou un élément vide. Un conteneur invalide, un ID inexistant ou un renderMode invalide renvoie AoqECParamInvalid(1) en conservant la liaison précédente. 0 indique l’acceptation ; la première image peut ne pas encore être affichée.

setRemoteView

Définit le conteneur vidéo distant. Le SDK crée les éléments de rendu à l’intérieur.
setRemoteView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParamètreTypeDescription
trackTypeAoqTrackTypeSeul AoqTrackTypeVideo est pris en charge. Les autres types renvoient AoqECUnSupport(3).
canvasAoqVideoCanvas | nullConfiguration du conteneur de rendu. Passez null pour délier.
Renvoie 0 en cas de succès. Utilisez un conteneur DOM standard de dimensions explicites, tel qu’un div. Ne passez pas directement video, audio, canvas, img ou un élément vide. Un conteneur invalide, un ID inexistant ou un renderMode invalide renvoie AoqECParamInvalid(1) en conservant la liaison précédente. 0 indique l’acceptation ; la première image peut ne pas encore être affichée.

Configuration du codage vidéo

setVideoEncoderConfig

Définit les paramètres de codage vidéo.
setVideoEncoderConfig(config: AoqVideoCodecConfig): number
ParamètreTypeDescription
configAoqVideoCodecConfigConfiguration du codage vidéo
Renvoie 0 en cas de succès. Appelez lorsque le moteur est Disconnected. Pendant la connexion ou à l’état connecté, renvoie AoqECStateInvalid(2). Configurez avant la première connexion et capture vidéo. La configuration fusionnée est mise en cache pour les flux suivants ; les captures ou encodeurs existants ne sont pas reconfigurés immédiatement.

setVideoDecoderConfig

Définit les paramètres de décodage vidéo.
setVideoDecoderConfig(config: AoqVideoCodecConfig): number
ParamètreTypeDescription
configAoqVideoCodecConfigConfiguration du décodage vidéo
Renvoie 0 en cas de succès. Appelez avant connect() lorsque le moteur est Disconnected. Toute modification pendant la connexion ou à l’état connecté renvoie AoqECStateInvalid(2).

Contrôle de la transmission des flux multimédias

enableSendMediaStream

Active ou désactive la transmission des pistes audio ou vidéo.
enableSendMediaStream(trackType: AoqTrackType, enable: boolean): number
ParamètreTypeDescription
trackTypeAoqTrackTypeType de piste multimédia
enablebooleantrue : activer la transmission ; false : la désactiver
Renvoie 0 en cas de succès. Contrôle Audio et Video, pas Data. D’autres valeurs peuvent renvoyer 0 sans effet. Désactiver la transmission n’arrête pas la capture ; utilisez le stop...Capture() correspondant.

Messages en temps réel

sendDataMsg

Envoie du texte UTF-8 porté par un Uint8Array au pair, par exemple du JSON applicatif. Le chemin WT actuel n’accepte pas de charges binaires arbitraires ni les messages de contrôle internes du SDK par cette méthode.
sendDataMsg(msg: AoqDataMsg): number
ParamètreTypeDescription
msgAoqDataMsgObjet message ; msg.data doit contenir des octets UTF-8 non vides
Renvoie 0 en cas de succès. Requiert un moteur connecté, des pistes prêtes et Data dans publishTracks. Un message absent ou msg.data non Uint8Array renvoie AoqECParamInvalid(1). Une connexion non prête renvoie AoqECStateInvalid(2). Un flux d’envoi inactif ou un message vide renvoie actuellement -1. 0 indique l’acceptation locale, pas un accusé de réception. La validation UTF-8 ou l’envoi ultérieur peut encore échouer via onError. L’ArrayBuffer sous-jacent de msg.data peut être transféré et détaché, affectant aussi les autres vues qui le partagent. Passez une copie data.slice() pour conserver l’original. N’envoyez pas de clés API ni d’identifiants temporaires dans les messages frontend ou les journaux.
const data = new TextEncoder().encode(JSON.stringify({ type: 'user_message', text: '你好' }));
const code = engine.sendDataMsg({ data });
if (code !== 0) console.error('消息未受理', code);
Le JSON illustre seulement le codage. Suivez le protocole de messages du modèle pour les champs réels et la disponibilité de l’application.

Callbacks d’événements

Abonnez-vous avec engine.on('eventName', callback), écoutez une fois avec engine.once(...) et désabonnez-vous avec engine.off('eventName', callback) en réutilisant la même fonction. La destruction retire tous les écouteurs. Inscrivez-les avant la connexion ou le démarrage des périphériques et gardez les callbacks légers.
import { AoqConnectionStatus } from 'aoq-web-sdk';

const handleStatus = (status: AoqConnectionStatus) => console.log('连接状态', status);
engine.on('onConnectionStatusChange', handleStatus);
engine.off('onConnectionStatusChange', handleStatus);
ÉvénementSignature du callbackDescription
onError(code: number, message: string) => voidCallback d’erreur
onWarning(code: number, message: string) => voidCallback d’avertissement
onConnectionStatusChange(status: AoqConnectionStatus) => voidChangements d’état de connexion
onStats(stats: AoqStats) => voidStatistiques
onAudioDeviceStateChanged(state: AoqAudioDeviceState) => voidChangements d’état du périphérique audio
onAudioDeviceRouteChanged(routeType: AoqAudioDeviceRouteType) => voidChangements de route audio
onAudioFileState(state: AoqAudioFileState) => voidRéservé ; non émis actuellement
onLocalAudioVolumeIndication(volume: AoqAudioVolume) => voidIndication du volume local
onVideoDeviceStateChanged(state: AoqVideoDeviceState) => voidChangements d’état du périphérique vidéo
onDataMsg(msg: AoqDataMsg) => voidMessages de données

onError

Signale des erreurs asynchrones ou d’exécution en plus des retours synchrones. Diagnostiquez avec code, message et les états de connexion et des périphériques. Une erreur ne termine pas nécessairement la connexion. Les erreurs réseau peuvent utiliser des codes généraux ; le nombre seul n’indique pas l’étape en échec.
engine.on('onError', (code: number, message: string) => { /* 在此处理回调 */ });
ParamètreTypeDescription
codenumberCode d’erreur ; voir AoqErrorCode
messagestringDescription de l’erreur

onWarning

Signale les avertissements du moteur relatifs à des situations non fatales nécessitant une attention.
engine.on('onWarning', (code: number, message: string) => { /* 在此处理回调 */ });
ParamètreTypeDescription
codenumberCode d’avertissement ; voir AoqWarningCode
messagestringDescription de l’avertissement

onConnectionStatusChange

Signale les changements d’état de connexion.
engine.on('onConnectionStatusChange', (status: AoqConnectionStatus) => { /* 在此处理回调 */ });
ParamètreTypeDescription
statusAoqConnectionStatusÉtat actuel de connexion

onStats

Fournit des statistiques environ chaque seconde à l’état Connected et s’arrête en le quittant. Voir AoqStats pour les champs disponibles. Les valeurs de remplacement ne sont pas des mesures.
engine.on('onStats', (stats: AoqStats) => { /* 在此处理回调 */ });
ParamètreTypeDescription
statsAoqStatsObjet de statistiques

onAudioDeviceStateChanged

Signale les changements d’état des opérations de capture et de lecture audio.
engine.on('onAudioDeviceStateChanged', (state: AoqAudioDeviceState) => { /* 在此处理回调 */ });
ParamètreTypeDescription
stateAoqAudioDeviceStateÉtat du périphérique audio

onAudioDeviceRouteChanged

Lors d’un changement de la liste des sorties, le SDK tente de déduire la route à partir des libellés du navigateur. Il peut se tromper ou manquer un changement ; ce n’est pas une confirmation de la route réelle. Le type par défaut peut être renvoyé avant autorisation ou avec des données incomplètes.
engine.on('onAudioDeviceRouteChanged', (routeType: AoqAudioDeviceRouteType) => { /* 在此处理回调 */ });
ParamètreTypeDescription
routeTypeAoqAudioDeviceRouteTypeRoute déduite des libellés ; ne confirme pas le périphérique de sortie réel

onAudioFileState

Callback réservé d’état de fichier audio. AoqClientEngine ne propose actuellement aucun contrôle de lecture de fichier et n’émet pas cet événement.
engine.on('onAudioFileState', (state: AoqAudioFileState) => { /* 在此处理回调 */ });
ParamètreTypeDescription
stateAoqAudioFileStateÉtat du fichier audio

onLocalAudioVolumeIndication

Signale le volume de capture local. Activez d’abord enableLocalAudioVolumeIndication.
engine.on('onLocalAudioVolumeIndication', (volume: AoqAudioVolume) => { /* 在此处理回调 */ });
ParamètreTypeDescription
volumeAoqAudioVolumeInformations de volume

onVideoDeviceStateChanged

Signale les changements d’état des opérations de capture vidéo.
engine.on('onVideoDeviceStateChanged', (state: AoqVideoDeviceState) => { /* 在此处理回调 */ });
ParamètreTypeDescription
stateAoqVideoDeviceStateÉtat du périphérique vidéo

onDataMsg

Signale les messages de données reçus.
engine.on('onDataMsg', (msg: AoqDataMsg) => { /* 使用 msg.data 读取消息数据 */ });
ParamètreTypeDescription
msgAoqDataMsgObjet message reçu. Utilisez TextDecoder pour lire le texte UTF-8 de msg.data.
Incluez Data dans subscribeTracks pour recevoir les messages. Le callback reçoit un objet, pas un Uint8Array directement. L’application doit analyser et valider le JSON.

Types de données et énumérations

Types communs

AoqCreateConfig

Configuration de création du moteur.
ChampTypeObligatoireValeur par défautDescription
workDirstringNon—Réservé ; le SDK Web ne l’utilise pas pour sélectionner le répertoire de stockage
enableDumpAudiobooleanNonfalseEnregistrer l’audio de débogage. Obtenez une autorisation et contrôlez l’accès à l’audio utilisateur.
enableDumpExportbooleanNonfalseEffectif uniquement avec enableDumpAudio=true. Exporte un ZIP de dump et supprime les fichiers OPFS associés de manière asynchrone à la destruction.
maxEncodedVideoFrameBytesnumberNon194560 (190×1024)Taille maximale cible d’une image JPEG en octets. 0 désactive la limite. La qualité est réduite en cas de dépassement ; une valeur invalide utilise le défaut.
enableDropOversizedVideoFramebooleanNonfalseAbandonner les JPEG encore trop grands à la qualité minimale. Avec false, ils peuvent toujours être envoyés. Aucun abandon pour ce motif si la limite vaut 0.
extrasstringNon—Chaîne d’objet JSON. JSON invalide, valeur non objet ou stratégie de rendu distant invalide fait renvoyer null à createEngine.
Champs extras pris en charge :
Champ JSONTypeValeur par défautDescription
remoteVideoRenderer'auto' | 'video' | 'canvas''auto'Stratégie de rendu distant. auto privilégie video puis utilise canvas si nécessaire.
user_specified_enable_av_syncbooleantrueActiver la synchronisation audio/vidéo. Utilisez un booléen JSON.
user_specified_audio_playback_transport'message-port'AutomatiqueImpose la lecture MessagePort. Si omis, choisit mémoire partagée ou MessagePort selon l’environnement.
Ces champs ne modifient pas les en-têtes HTTP de réponse et n’activent pas d’API publique de diagnostic.

AoqConnectConfig

Configuration d’authentification de connexion.
ChampTypeObligatoireValeur par défautDescription
tokenstringOui—Token client temporaire non vide correspondant à aoqTokenForClient, pas une clé API
sidstringOui—ID de session non vide. Utilisez la chaîne sid complète de la réponse d’authentification.
wtBaseUrlstringNonConstruit depuis RelayURL HTTPS WT privilégiée en route unique. Ignorée avec plusieurs routes, qui se connectent à /aoq sur chaque hôte et port.
signedSidstringOui (à l’exécution)—SID signé complet, généralement le sid complet d’authentification. Facultatif en TypeScript, obligatoire dans le flux WT actuel.
certFingerprintstring | string[]Conditionnel—Empreinte SHA-256 partagée du certificat WT. Les routes sans empreinte propre doivent pouvoir l’utiliser.
workspaceIdHashstringNon—Correspond à extraInfo.workspaceIdHash. Ne remplacez pas par le Workspace ID d’origine.
relayEndpointsAoqRelayEndpoint[]Oui—Liste complète de points de terminaison, au moins une entrée
publishTracksAoqTrackParam[]Oui—Pistes montantes. Peut être vide, mais pas en même temps que subscribeTracks.
subscribeTracksAoqTrackParam[]Oui—Pistes descendantes. Peut être vide. Les doublons dans une direction et Screen ne sont pas pris en charge.
Le backend doit renvoyer des identifiants complets et valides. Convertissez clientRelayEndpoints[].route_index en routeIndex dans l’adaptateur. N’inventez pas de SID, d’adresse, d’index ni d’empreinte. Les empreintes WT doivent correspondre au certificat réel du point WebTransport. Pour sha256/<hex>, retirez le préfixe et validez 64 chiffres hexadécimaux. Empreintes partagées et par route acceptent une chaîne ou un tableau ; chaque entrée doit être valide, une seule correspondance suffit. Une empreinte de route non vide remplace la partagée ; un tableau vide signifie non configuré. Il n’existe ni empreinte universelle ni option pour ignorer la validation. L’absence de signedSid ou d’empreintes valides peut provoquer un échec asynchrone même après un retour 0 de connect(). Gérez les événements d’état et onError.

AoqRelayEndpoint

Point de terminaison Relay.
ChampTypeObligatoireValeur par défautDescription
routeIndexnumberOui (à l’exécution)—Entier unique entre 0 et 2147483647. Le plus petit index est utilisé initialement. Facultatif en TypeScript.
certFingerprintstring | string[]ConditionnelEmpreinte partagéeL’empreinte de route non vide remplace la partagée. Obligatoire sans empreinte partagée.
endpointstringOui—Nom d’hôte ou IP WT sans schéma, chemin, espaces, informations utilisateur ni requête. IPv6 pris en charge.
portnumberOui—Port WT, entier entre 1 et 65535

AoqTrackParam

Propriétés de piste.
ChampTypeObligatoireValeur par défautDescription
trackTypeAoqTrackTypeOui—Audio, Video ou Data. Aucun doublon dans une direction. Screen n’est pas encore pris en charge.
trackModeAoqTrackModeNonSegment pour l’audio descendantContrôle seulement l’audio descendant. PCM / Opus utilisent Segment par défaut ; sélectionnez Stream pour Realtime. L’audio montant utilise toujours Realtime. Le montant, la vidéo et les données ignorent ce champ.

AoqSupportResult

Résultat du contrôle des capacités du navigateur.
ChampTypeValeur par défautDescription
supportedboolean—Présence des capacités de base de connexion AOQ dans l’environnement
missingFeaturesAoqMissingFeature[]—Échecs observés du précontrôle, pouvant inclure 'secure-context', 'worker' et 'web-transport'

AoqMissingFeature

Échecs de base : 'secure-context' | 'worker' | 'web-transport'. worker peut aussi indiquer une politique de déploiement bloquante, un échec de démarrage/exécution ou un timeout, pas seulement l’absence de Worker. La liste n’évalue pas toutes les capacités multimédias.

Types audio

AoqAudioCaptureConfig

Configuration de capture audio.
ChampTypeObligatoireValeur par défautDescription
channelnumberNon1Canaux demandés : 1 (mono) ou 2 (stéréo). Le réglage réel peut être déterminé par la piste du périphérique.

AoqAudioPlaybackConfig

Configuration de lecture audio.
ChampTypeObligatoireValeur par défautDescription
channelnumberNon1Canaux demandés : 1 ou 2. La sortie utilise la fréquence réelle de l’AudioContext.
playOnlyAndIgnoreMutebooleanNonfalsePour la lecture seule. Définit audioSession sur playback si disponible afin d’éviter l’effet du bouton silencieux iOS. Gardez false pour capturer le microphone. Ignorer le mode silencieux n’est pas garanti sans prise en charge du navigateur.

AoqAudioCodecConfig

Configuration du codec audio.
ChampTypeObligatoireValeur par défautDescription
trackTypeAoqTrackTypeNon—Réservé ; ne sélectionne pas actuellement le flux audio
codecTypeAoqEncoderTypeNonAoqEncoderTypeAudioPCMPCM / Opus. Doit correspondre à la configuration négociée avec le pair.
sampleRatenumberNon48000Fréquence en Hz. Valeurs négociées : 8000, 12000, 16000, 24000, 32000, 44100, 48000. Le navigateur doit également prendre en charge le codage choisi.
channelnumberNon1Nombre de canaux : 1 ou 2
bitratenumberNon32000 (codage Opus)En bps, uniquement pour coder Opus. Le débit PCM dépend de la fréquence, des canaux et de la profondeur en bits. Non utilisé au décodage.

AoqAudioVolumeIndicationConfig

Configuration de l’indication du volume local.
ChampTypeObligatoireValeur par défautDescription
intervalnumberNon0Intervalle de callback en ms. Les valeurs <=0 désactivent ; une valeur positive inférieure à 10 vaut 10.
smoothnumberNon3Facteur de lissage, 0..10. Une valeur supérieure lisse davantage.
reportSpeechbooleanNonfalseSignaler l’activité vocale (VAD)

AoqAudioVolume

Informations de volume local.
ChampTypeValeur par défautDescription
volumenumber—Volume instantané lissé, plage [0-255]
isSpeechboolean—Indicateur vocal facultatif, significatif uniquement avec reportSpeech=true. Gérez les valeurs absentes.

AoqAudioDeviceState

Données du callback d’état du périphérique audio.
ChampTypeValeur par défautDescription
stateAoqAudioDeviceStateCode—Code d’état du périphérique audio
reasonnumber—Code de motif ; voir AoqErrorCode

AoqAudioFileState

Structure réservée d’état de lecture de fichier audio ; le SDK Web n’émet pas encore l’événement associé.
ChampTypeValeur par défautDescription
fileIdstring—ID du fichier audio
stateCodeAoqAudioFileStateCode—Code d’état de lecture du fichier
errorCodenumber—Code d’erreur

Types vidéo

AoqVideoCaptureConfig

Configuration de capture vidéo.
ChampTypeObligatoireValeur par défautDescription
widthnumberNon1280Largeur demandée en pixels, contrainte ideal. Le navigateur/périphérique choisit la valeur réelle.
heightnumberNon720Hauteur demandée en pixels, contrainte ideal. Le navigateur/périphérique choisit la valeur réelle.
fpsnumberNon15Fréquence d’images demandée, contraintes ideal et max
cameraPreferenceAoqCameraDirection | stringNonChoix du navigateurOrientation ou ID de caméra préféré, contrainte ideal. Repli autorisé ; les chaînes vides sont invalides.

AoqVideoCodecConfig

Configuration du codec vidéo.
ChampTypeObligatoireValeur par défautDescription
trackTypeAoqTrackTypeNon—Réservé ; ne sélectionne pas actuellement le flux vidéo
codecTypeAoqEncoderTypeNonAoqEncoderTypeVideoH264H.264 / JPEG. Doit correspondre à la configuration négociée avec le pair.
widthnumberNon540Largeur cible de codage ou négociée en réception, en pixels. Entier positif requis à la connexion.
heightnumberNon960Hauteur cible de codage ou négociée en réception, en pixels. Entier positif requis à la connexion.
fpsnumberNon5Fréquence de codage ou négociée en réception. Entier positif requis à la connexion.
bitratenumberNon500000 (codage)Débit cible positif de codage en bps. Non utilisé au décodage.
minBitratenumberNon128000Débit cible minimal en bps. Omis ou 0 utilise 128000, plafonné à la cible utilisateur. H.264 ne se suspend pas lorsque le budget BWE atteint 0. Non utilisé au décodage.
keyframeIntervalnumberNon2Intervalle d’images clés H.264 en secondes, au moins 1 seconde au codage. Non utilisé pour JPEG ou le décodage.

AoqVideoCanvas

Configuration du conteneur de rendu vidéo.
ChampTypeObligatoireValeur par défautDescription
viewHTMLElement | stringOui—Conteneur standard ou son ID DOM sans #. N’utilisez pas directement video, audio, canvas, img ou des éléments vides.
renderModeAoqRenderModeNonAoqRenderModeAuto(0)Mode d’ajustement vidéo
L’aperçu local est automatiquement inversé par CSS si la piste réelle est frontale ; une orientation inconnue n’est pas inversée. Les pixels codés ne changent pas. Aucun paramètre séparé de miroir ou d’orientation n’est disponible. Un remplacement invalide conserve la liaison existante. Délier avec null retire seulement les nœuds SDK, pas ceux de l’application.

AoqVideoDeviceState

Données du callback d’état du périphérique vidéo.
ChampTypeValeur par défautDescription
stateAoqVideoDeviceStateCode—Code d’état du périphérique vidéo
reasonnumber—Motif : 0 pour un arrêt explicite ; AoqECVideoDevice(220) pour une fin inattendue de piste Web

Types de messages de données

AoqDataMsg

Structure commune à sendDataMsg et onDataMsg publics. Ces API n’acceptent pas directement une chaîne ou un Uint8Array. Le chemin WT transporte le texte UTF-8 dans un tableau d’octets.
ChampTypeObligatoireValeur par défautDescription
dataUint8ArrayOui—UTF-8 valide et non vide à l’envoi. Lisez msg.data à la réception.

Types de statistiques

AoqStats

Résumé des statistiques moteur. Tous les champs suivants sont facultatifs ; gérez leur absence.
ChampTypeValeur par défautDescription
audioPublishStatsAoqAudioPublishStats[]—Statistiques de publication audio
audioSubscribeStatsAoqAudioSubscribeStats[]—Statistiques d’abonnement audio
videoPublishStatsAoqVideoPublishStats[]—Statistiques de publication vidéo
videoSubscribeStatsAoqVideoSubscribeStats[]—Statistiques d’abonnement vidéo
dataMsgPublishStatsAoqDataMsgPublishStats[]—Statistiques de publication de messages de données
dataMsgSubscribeStatsAoqDataMsgSubscribeStats[]—Statistiques d’abonnement aux messages de données
networkStatsAoqNetworkStats—Statistiques réseau
onStats ne remplit pas encore dataMsgPublishStats ni dataMsgSubscribeStats. bitrate / bytes audio sont les totaux de connexion, pas le trafic audio isolé ; encodeVolume / playVolume valent 0. bitrate / bytes vidéo valent aussi 0 ; seules les fréquences viennent du moteur vidéo. Utilisez networkStats pour le trafic total et onLocalAudioVolumeIndication pour le volume capturé.

AoqAudioPublishStats

Statistiques de publication audio.
ChampTypeValeur par défautDescription
trackTypeAoqTrackType—Type de piste
bitratenumber—Débit applicatif montant total de connexion en bps, pas un débit audio isolé
bytesnumber—Octets applicatifs montants totaux de connexion, pas un total audio isolé
encodeVolumenumber0Valeur de remplacement. Utilisez onLocalAudioVolumeIndication pour le volume capturé.

AoqAudioSubscribeStats

Statistiques d’abonnement audio.
ChampTypeValeur par défautDescription
trackTypeAoqTrackType—Type de piste
bitratenumber—Débit applicatif descendant total de connexion en bps, pas un débit audio isolé
bytesnumber—Octets applicatifs descendants totaux de connexion, pas un total audio isolé
playVolumenumber0Valeur de remplacement ; ne permet pas de déterminer si la lecture est muette

AoqVideoPublishStats

Statistiques de publication vidéo.
ChampTypeValeur par défautDescription
trackTypeAoqTrackType—Type de piste
bitratenumber0Valeur de remplacement ; débit vidéo isolé non fourni actuellement
bytesnumber0Valeur de remplacement ; nombre d’octets vidéo isolé non fourni actuellement
encodeFpsnumber—Fréquence d’images codées

AoqVideoSubscribeStats

Statistiques d’abonnement vidéo.
ChampTypeValeur par défautDescription
trackTypeAoqTrackType—Type de piste
bitratenumber0Valeur de remplacement ; débit vidéo isolé non fourni actuellement
bytesnumber0Valeur de remplacement ; nombre d’octets vidéo isolé non fourni actuellement
decodeFpsnumber—Fréquence d’images décodées
renderFpsnumber—Fréquence d’images rendues

AoqDataMsgPublishStats

Statistiques de publication de messages de données.
ChampTypeValeur par défautDescription
trackTypeAoqTrackType—Type de piste
bitratenumber—Débit actuel en bps
bytesnumber—Total cumulé d’octets envoyés
Le type est défini, mais onStats ne remplit pas encore ce tableau.

AoqDataMsgSubscribeStats

Statistiques d’abonnement aux messages de données.
ChampTypeValeur par défautDescription
trackTypeAoqTrackType—Type de piste
bitratenumber—Débit actuel en bps
bytesnumber—Total cumulé d’octets reçus
Le type est défini, mais onStats ne remplit pas encore ce tableau.

AoqNetworkStats

Statistiques réseau. Les débits mesurent les bits/s de charge utile applicative ; les cumuls utilisent la même base en octets. Les sondages et le surcoût de transport sont exclus.
ChampTypeValeur par défautDescription
sendBitratenumber—Débit montant en bps
sendBytesnumber—Octets montants cumulés
recvBitratenumber—Débit descendant en bps
recvBytesnumber—Octets descendants cumulés
lossnumber—Taux de perte montant facultatif (0–1). Privilégie les observations QUIC du navigateur, sinon une estimation Relay Datagram. Omis si inconnu.
rttnumber—Temps aller-retour facultatif en ms ; omis si inconnu
bwenumber—Budget effectif facultatif d’envoi applicatif Client→Relay en bps ; omis si inconnu ou périmé
audioReserveBpsnumber—Débit facultatif réservé à la charge utile audio codée actuelle, en bps. Exclut la redondance RED et le surcoût de transport ; ce n’est pas le trafic audio réel.

Énumérations

AoqTrackType

Type multimédia de piste.
Membre de l’énumérationValeurDescription
AoqTrackTypeAudio0Audio
AoqTrackTypeVideo1Vidéo
AoqTrackTypeData2Messages de données
AoqTrackTypeScreen3Réservé ; non pris en charge dans le flux de connexion actuel

AoqTrackMode

Mode de transport audio.
Membre de l’énumérationValeurDescription
AoqTrackModeSegment0Mode Segment
AoqTrackModeStream1Mode de flux Realtime

AoqEncoderType

Format multimédia de piste.
Membre de l’énumérationValeurDescription
AoqEncoderTypeUnknown0Inconnu
AoqEncoderTypeAudioPCM1Audio PCM
AoqEncoderTypeAudioOpus2Audio Opus
AoqEncoderTypeVideoH2643Vidéo H.264
AoqEncoderTypeVideoJpeg4Vidéo JPEG
AoqEncoderTypeDataText5Données texte

AoqConnectionStatus

État de connexion du moteur.
Membre de l’énumérationValeurDescription
AoqConnectionStatusDisconnected0Déconnecté
AoqConnectionStatusConnecting1Connexion en cours
AoqConnectionStatusConnected2Connecté
AoqConnectionStatusFailed3Échec de connexion

AoqErrorCode

Codes d’erreur.
Membre de l’énumérationValeurDescription
AoqECOK0Succès
AoqECParamInvalid1Paramètre invalide
AoqECStateInvalid2État invalide
AoqECUnSupport3Non implémenté pour la plateforme/le mode actuel
AoqECAudio100Erreur audio générale
AoqECAudioExternalBufferFull110Tampon audio externe plein
AoqECAudioDevice120Erreur générale du périphérique audio
AoqECAudioDeviceRecordingAuthFailed121Autorisation du microphone refusée
AoqECAudioDeviceRecordingOccupied122Microphone occupé
AoqECAudioDeviceRecordingBackgroundStart123Capture démarrée en arrière-plan
AoqECAudioDeviceRecordingStartFail124Échec du démarrage de capture
AoqECAudioDevicePlayoutOccupied125Périphérique de lecture occupé
AoqECAudioDevicePlayoutBackgroundStart126Lecture démarrée en arrière-plan
AoqECAudioDevicePlayoutStartFail127Échec du démarrage de lecture
AoqECAudioDeviceEarpieceRequiresVoipMode128Écouteur nécessitant le mode VoIP
AoqECVideo200Erreur vidéo générale
AoqECVideoExternalBufferFull210Tampon vidéo externe plein
AoqECVideoExternalCaptureNotEnabled211Capture vidéo externe non activée
AoqECVideoExternalEncoderNotEnabled212Encodeur vidéo externe non activé
AoqECVideoDevice220Erreur générale du périphérique vidéo
AoqECVideoDeviceCameraOpenFail221Échec d’ouverture de la caméra
AoqECVideoDeviceCameraAuthFailed222Autorisation de caméra refusée
AoqECVideoDeviceCameraOccupied223Caméra occupée
AoqECVideoDeviceCameraRunningError224Erreur d’exécution de la caméra
AoqECVideoCodec230Erreur générale de codec vidéo
AoqECVideoCodecEncoderInitFail231Échec d’initialisation de l’encodeur vidéo
AoqECVideoRender240Erreur générale de rendu vidéo
AoqECVideoRenderCreateFail241Échec de création du moteur de rendu
AoqECVideoRenderDrawError242Erreur de dessin du rendu

AoqWarningCode

Codes d’avertissement.
Membre de l’énumérationValeurDescription
AoqWCOK0Normal
AoqWCAudio100Avertissement audio général
AoqWCAudioHowling101Larsen détecté
AoqWCAudioDevice120Avertissement général du périphérique audio
AoqWCAudioDeviceMicEnumerateError121Erreur d’énumération des microphones
AoqWCAudioDeviceMicStartTimeout122Délai de démarrage du microphone dépassé
AoqWCAudioDeviceRecordingError123Erreur de capture
AoqWCAudioDeviceSpeakerEnumerateError124Erreur d’énumération des haut-parleurs
AoqWCAudioDeviceSpeakerStartTimeout125Délai de démarrage du haut-parleur dépassé
AoqWCAudioDevicePlayoutError126Erreur de lecture
AoqWCAudioDeviceSilentMode127Périphérique en mode silencieux
AoqWCVideo200Avertissement vidéo général
AoqWCVideoCameraEnumerateError201Erreur d’énumération des caméras
AoqWCVideoEncoderSwitched202Encodeur vidéo changé
AoqWCVideoRenderDowngrade203Rendu de repli

AoqAudioDeviceStateCode

Codes d’état du périphérique audio.
Membre de l’énumérationValeurDescription
AoqAudioDeviceNone0Aucun état
AoqAudioDeviceRecordStarting1Démarrage de capture
AoqAudioDeviceRecordStarted2Capture démarrée
AoqAudioDeviceRecordStopping3Arrêt de capture
AoqAudioDeviceRecordStopped4Capture arrêtée
AoqAudioDeviceRecordFail5Échec de capture
AoqAudioDevicePlayStarting6Démarrage de lecture
AoqAudioDevicePlayStarted7Lecture démarrée
AoqAudioDevicePlayStopping8Arrêt de lecture
AoqAudioDevicePlayStopped9Lecture arrêtée
AoqAudioDevicePlayFail10Échec de lecture

AoqAudioDeviceRouteType

Types de route du périphérique audio.
Membre de l’énumérationValeurDescription
AoqAudioDeviceRouteDefault0Route par défaut
AoqAudioDeviceRouteHeadset1Casque
AoqAudioDeviceRouteSpeakerPhone4Haut-parleur intégré
AoqAudioDeviceRouteUsb5Périphérique USB
AoqAudioDeviceRouteBluetooth6Périphérique Bluetooth

AoqAudioFileStateCode

Codes d’état de lecture de fichiers audio.
Membre de l’énumérationValeurDescription
AoqAudioFileNone0Aucun état
AoqAudioFileStarted1Lecture démarrée
AoqAudioFileStopped2Lecture arrêtée
AoqAudioFilePaused3Lecture suspendue
AoqAudioFileResumed4Lecture reprise
AoqAudioFileEnded5Lecture terminée
AoqAudioFileBuffering6Mise en tampon
AoqAudioFileBufferingEnd7Mise en tampon terminée
AoqAudioFileFailed8Échec de lecture

AoqCameraDirection

Membre de l’énumérationValeurDescription
AoqCameraDirectionFront0Préférer la caméra avant
AoqCameraDirectionBack1Préférer la caméra arrière

AoqVideoDeviceStateCode

Codes d’état du périphérique vidéo.
Membre de l’énumérationValeurDescription
AoqVideoDeviceNone0Aucun état
AoqVideoDeviceCaptureStarting1Démarrage de capture
AoqVideoDeviceCaptureStarted2Capture démarrée
AoqVideoDeviceCaptureStopping3Arrêt de capture
AoqVideoDeviceCaptureStopped4Capture arrêtée
AoqVideoDeviceCaptureFail5Échec de capture

AoqMirrorMode

Énumération miroir réservée. Le SDK Web ne propose aucun paramètre ni API l’utilisant.
Membre de l’énumérationValeurDescription
AoqMirrorModeDisabled0Miroir désactivé
AoqMirrorModeEnabled1Miroir activé

AoqOrientationMode

Énumération d’orientation réservée. Le SDK Web ne propose aucun paramètre ni API l’utilisant.
Membre de l’énumérationValeurDescription
AoqOrientationModeAuto0Automatique
AoqOrientationModePortrait1Portrait
AoqOrientationModeLandscape2Paysage

AoqRenderMode

Modes d’ajustement vidéo.
Membre de l’énumérationValeurDescription
AoqRenderModeAuto0Par défaut : image entière en conservant les proportions
AoqRenderModeStretch1Étirer pour remplir le conteneur
AoqRenderModeFill2Image entière en conservant les proportions, bandes noires autorisées
AoqRenderModeCrop3Remplir en conservant les proportions, rogner le débordement

Autres déclarations publiques

IAoqEngineEvents définit les 10 signatures de callbacks d’événements, dont l’événement réservé onAudioFileState. L’abonnement par nom fournit l’inférence des paramètres TypeScript. Ces types et énumérations sont exportés, mais le moteur Web actuel ne propose pas d’API correspondante de contrôle ou d’observation. Une déclaration du même nom sur une autre plateforme n’implique pas sa prise en charge Web.
CatégorieDéclarations publiquesPrise en charge actuelle
Mixage de fichiers audioAoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCodeAucun contrôle de lecture ou mixage de fichiers ; aucun événement d’état de fichier émis
Audio externe et observateursAoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirectionAucune méthode d’entrée audio externe ni d’inscription d’observateur de trames audio
Vidéo externe et observateursAoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecTypeAucune entrée de trames vidéo externes ni inscription d’observateur vidéo. La configuration du codec utilise AoqEncoderType.
Miroir et orientationAoqMirrorMode, AoqOrientationModeAucun champ ni méthode correspondant. L’inversion de l’aperçu local est automatique.
Périphériques audio bas niveauAoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCodeDéclarations de périphériques bas niveau, pas des événements supplémentaires ni le contrat complet des codes de retour moteur
AOQ_TRACK_AUDIO et AOQ_TRACK_DATA sont les constantes chaîne 'aoq_track_audio' et 'aoq_track_data'. Elles ne sélectionnent pas de pistes pour la connexion ou l’affichage ; utilisez AoqTrackType pour ces API. Les énumérations d’erreur et d’avertissement conservent des valeurs multiplateformes. Le SDK Web ne produit pas nécessairement toutes ces valeurs. Consultez les méthodes et conditions documentées ici pour connaître leur disponibilité.