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 :
Liste des API
Cycle de vie du moteur
| API | Description |
|---|---|
| createEngine | Créer un moteur singleton |
| createAoqClientEngine | Fonction de fabrique nommée équivalente |
| destroy | Détruire le moteur |
| getVersion | Obtenir la version du SDK |
| isAoqSupported | Vérifier les capacités du navigateur |
| connect | Établir une connexion |
| disconnect | Déconnecter |
Gestion des périphériques audio
| API | Description |
|---|---|
| startAudioCapture | Démarrer la capture audio |
| stopAudioCapture | Arrêter la capture audio |
| muteAudioCapture | Couper le son de la capture audio |
| startAudioPlayer | Démarrer la lecture audio |
| stopAudioPlayer | Arrêter la lecture audio |
| pauseAudioPlayer | Suspendre la lecture avec fondu sortant |
| resumeAudioPlayer | Reprendre la lecture avec fondu entrant par défaut |
| interruptAudioPlayer | Interrompre la lecture |
Configuration du codage audio
| API | Description |
|---|---|
| setAudioEncoderConfig | Définir les paramètres de codage audio |
| setAudioDecoderConfig | Définir les paramètres de décodage audio |
Indication du volume local
| API | Description |
|---|---|
| enableLocalAudioVolumeIndication | Activer l’indication du volume local |
Gestion des périphériques vidéo
| API | Description |
|---|---|
| startVideoCapture | Démarrer la capture vidéo |
| getCameras | Énumérer les caméras |
| switchCamera | Changer de caméra selon une préférence d’orientation ou un ID de périphérique |
| stopVideoCapture | Arrêter la capture vidéo |
| setLocalView | Définir le conteneur vidéo local |
| setRemoteView | Définir le conteneur vidéo distant |
Configuration du codage vidéo
| API | Description |
|---|---|
| setVideoEncoderConfig | Définir les paramètres de codage vidéo |
| setVideoDecoderConfig | Définir les paramètres de décodage vidéo |
Contrôle de la transmission des flux multimédias
| API | Description |
|---|---|
| enableSendMediaStream | Activer ou désactiver la transmission des flux multimédias |
Messages en temps réel
| API | Description |
|---|---|
| sendDataMsg | Envoyer un message de données |
Callbacks d’événements
| API | Description |
|---|---|
| onError | Callback d’erreur |
| onWarning | Callback d’avertissement |
| onConnectionStatusChange | Changements d’état de connexion |
| onStats | Statistiques |
| onAudioDeviceStateChanged | Changements d’état du périphérique audio |
| onAudioDeviceRouteChanged | Changements de route audio |
| onAudioFileState | Événement réservé d’état de fichier audio ; non émis actuellement |
| onLocalAudioVolumeIndication | Indication du volume local |
| onVideoDeviceStateChanged | Changements d’état du périphérique vidéo |
| onDataMsg | Messages 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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqCreateConfig | Configuration de création du moteur |
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqCreateConfig | Obligatoire ; {} est valide. Une création répétée ne réapplique pas la configuration. |
null en cas d’échec.
destroy
Détruit le moteur, commence à libérer les ressources et supprime tous les écouteurs d’événements.
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.
isAoqSupported
Vérifie les capacités de base du navigateur nécessaires à une connexion AOQ.
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqConnectConfig | Identifiants de connexion, dont le token, l’ID de session et les points de terminaison du relais |
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.
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqAudioCaptureConfig | Configuration de capture audio |
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.
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.
| Paramètre | Type | Description |
|---|---|---|
mute | boolean | true : couper le son ; false : réactiver le son |
0 en cas de succès.
startAudioPlayer
Démarre le lecteur audio et initialise le périphérique de sortie de manière asynchrone.
| Paramètre | Type | Description |
|---|---|---|
config | AoqAudioPlaybackConfig | Configuration de lecture audio |
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.
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.
| Paramètre | Type | Description |
|---|---|---|
fadeMs | number | Duré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. |
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.
| Paramètre | Type | Description |
|---|---|---|
fadeMs | number | Réservé et actuellement ignoré. Le fondu par défaut est utilisé ; 0 ne le désactive pas. |
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.
| Paramètre | Type | Description |
|---|---|---|
trackType | AoqTrackType | Paramètre de compatibilité. Utilisez Audio. Ne sélectionne actuellement pas le flux de lecture. |
fadeMs | number | Duré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. |
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqAudioCodecConfig | Configuration du codage audio |
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqAudioCodecConfig | Configuration du décodage audio |
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqAudioVolumeIndicationConfig | Configuration de l’indication de volume |
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqVideoCaptureConfig | Configuration de capture vidéo |
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
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
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
cameraPreference | AoqCameraDirection | string | Non | Orientation ou ID préféré. Omettez pour effacer la préférence précédente et laisser le navigateur choisir à nouveau. |
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.
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.
| Paramètre | Type | Description |
|---|---|---|
trackType | AoqTrackType | Seul AoqTrackTypeVideo est pris en charge. Les autres types renvoient AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Configuration du conteneur de rendu. Passez null pour délier. |
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.
| Paramètre | Type | Description |
|---|---|---|
trackType | AoqTrackType | Seul AoqTrackTypeVideo est pris en charge. Les autres types renvoient AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Configuration du conteneur de rendu. Passez null pour délier. |
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqVideoCodecConfig | Configuration du codage vidéo |
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.
| Paramètre | Type | Description |
|---|---|---|
config | AoqVideoCodecConfig | Configuration du décodage vidéo |
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.
| Paramètre | Type | Description |
|---|---|---|
trackType | AoqTrackType | Type de piste multimédia |
enable | boolean | true : activer la transmission ; false : la désactiver |
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.
| Paramètre | Type | Description |
|---|---|---|
msg | AoqDataMsg | Objet message ; msg.data doit contenir des octets UTF-8 non vides |
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.
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.
| Événement | Signature du callback | Description |
|---|---|---|
onError | (code: number, message: string) => void | Callback d’erreur |
onWarning | (code: number, message: string) => void | Callback d’avertissement |
onConnectionStatusChange | (status: AoqConnectionStatus) => void | Changements d’état de connexion |
onStats | (stats: AoqStats) => void | Statistiques |
onAudioDeviceStateChanged | (state: AoqAudioDeviceState) => void | Changements d’état du périphérique audio |
onAudioDeviceRouteChanged | (routeType: AoqAudioDeviceRouteType) => void | Changements de route audio |
onAudioFileState | (state: AoqAudioFileState) => void | Réservé ; non émis actuellement |
onLocalAudioVolumeIndication | (volume: AoqAudioVolume) => void | Indication du volume local |
onVideoDeviceStateChanged | (state: AoqVideoDeviceState) => void | Changements d’état du périphérique vidéo |
onDataMsg | (msg: AoqDataMsg) => void | Messages 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.
| Paramètre | Type | Description |
|---|---|---|
code | number | Code d’erreur ; voir AoqErrorCode |
message | string | Description de l’erreur |
onWarning
Signale les avertissements du moteur relatifs à des situations non fatales nécessitant une attention.
| Paramètre | Type | Description |
|---|---|---|
code | number | Code d’avertissement ; voir AoqWarningCode |
message | string | Description de l’avertissement |
onConnectionStatusChange
Signale les changements d’état de connexion.
| Paramètre | Type | Description |
|---|---|---|
status | AoqConnectionStatus | É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.
| Paramètre | Type | Description |
|---|---|---|
stats | AoqStats | Objet de statistiques |
onAudioDeviceStateChanged
Signale les changements d’état des opérations de capture et de lecture audio.
| Paramètre | Type | Description |
|---|---|---|
state | AoqAudioDeviceState | É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.
| Paramètre | Type | Description |
|---|---|---|
routeType | AoqAudioDeviceRouteType | Route 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.
| Paramètre | Type | Description |
|---|---|---|
state | AoqAudioFileState | État du fichier audio |
onLocalAudioVolumeIndication
Signale le volume de capture local. Activez d’abord enableLocalAudioVolumeIndication.
| Paramètre | Type | Description |
|---|---|---|
volume | AoqAudioVolume | Informations de volume |
onVideoDeviceStateChanged
Signale les changements d’état des opérations de capture vidéo.
| Paramètre | Type | Description |
|---|---|---|
state | AoqVideoDeviceState | État du périphérique vidéo |
onDataMsg
Signale les messages de données reçus.
| Paramètre | Type | Description |
|---|---|---|
msg | AoqDataMsg | Objet message reçu. Utilisez TextDecoder pour lire le texte UTF-8 de msg.data. |
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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
workDir | string | Non | — | Réservé ; le SDK Web ne l’utilise pas pour sélectionner le répertoire de stockage |
enableDumpAudio | boolean | Non | false | Enregistrer l’audio de débogage. Obtenez une autorisation et contrôlez l’accès à l’audio utilisateur. |
enableDumpExport | boolean | Non | false | Effectif uniquement avec enableDumpAudio=true. Exporte un ZIP de dump et supprime les fichiers OPFS associés de manière asynchrone à la destruction. |
maxEncodedVideoFrameBytes | number | Non | 194560 (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. |
enableDropOversizedVideoFrame | boolean | Non | false | Abandonner 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. |
extras | string | Non | — | Chaîne d’objet JSON. JSON invalide, valeur non objet ou stratégie de rendu distant invalide fait renvoyer null à createEngine. |
extras pris en charge :
| Champ JSON | Type | Valeur par défaut | Description |
|---|---|---|---|
remoteVideoRenderer | 'auto' | 'video' | 'canvas' | 'auto' | Stratégie de rendu distant. auto privilégie video puis utilise canvas si nécessaire. |
user_specified_enable_av_sync | boolean | true | Activer la synchronisation audio/vidéo. Utilisez un booléen JSON. |
user_specified_audio_playback_transport | 'message-port' | Automatique | Impose la lecture MessagePort. Si omis, choisit mémoire partagée ou MessagePort selon l’environnement. |
AoqConnectConfig
Configuration d’authentification de connexion.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
token | string | Oui | — | Token client temporaire non vide correspondant à aoqTokenForClient, pas une clé API |
sid | string | Oui | — | ID de session non vide. Utilisez la chaîne sid complète de la réponse d’authentification. |
wtBaseUrl | string | Non | Construit depuis Relay | URL HTTPS WT privilégiée en route unique. Ignorée avec plusieurs routes, qui se connectent à /aoq sur chaque hôte et port. |
signedSid | string | Oui (à l’exécution) | — | SID signé complet, généralement le sid complet d’authentification. Facultatif en TypeScript, obligatoire dans le flux WT actuel. |
certFingerprint | string | string[] | Conditionnel | — | Empreinte SHA-256 partagée du certificat WT. Les routes sans empreinte propre doivent pouvoir l’utiliser. |
workspaceIdHash | string | Non | — | Correspond à extraInfo.workspaceIdHash. Ne remplacez pas par le Workspace ID d’origine. |
relayEndpoints | AoqRelayEndpoint[] | Oui | — | Liste complète de points de terminaison, au moins une entrée |
publishTracks | AoqTrackParam[] | Oui | — | Pistes montantes. Peut être vide, mais pas en même temps que subscribeTracks. |
subscribeTracks | AoqTrackParam[] | Oui | — | Pistes descendantes. Peut être vide. Les doublons dans une direction et Screen ne sont pas pris en charge. |
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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
routeIndex | number | Oui (à l’exécution) | — | Entier unique entre 0 et 2147483647. Le plus petit index est utilisé initialement. Facultatif en TypeScript. |
certFingerprint | string | string[] | Conditionnel | Empreinte partagée | L’empreinte de route non vide remplace la partagée. Obligatoire sans empreinte partagée. |
endpoint | string | Oui | — | Nom d’hôte ou IP WT sans schéma, chemin, espaces, informations utilisateur ni requête. IPv6 pris en charge. |
port | number | Oui | — | Port WT, entier entre 1 et 65535 |
AoqTrackParam
Propriétés de piste.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
trackType | AoqTrackType | Oui | — | Audio, Video ou Data. Aucun doublon dans une direction. Screen n’est pas encore pris en charge. |
trackMode | AoqTrackMode | Non | Segment pour l’audio descendant | Contrô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.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
supported | boolean | — | Présence des capacités de base de connexion AOQ dans l’environnement |
missingFeatures | AoqMissingFeature[] | — | É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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
channel | number | Non | 1 | Canaux 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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
channel | number | Non | 1 | Canaux demandés : 1 ou 2. La sortie utilise la fréquence réelle de l’AudioContext. |
playOnlyAndIgnoreMute | boolean | Non | false | Pour 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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
trackType | AoqTrackType | Non | — | Réservé ; ne sélectionne pas actuellement le flux audio |
codecType | AoqEncoderType | Non | AoqEncoderTypeAudioPCM | PCM / Opus. Doit correspondre à la configuration négociée avec le pair. |
sampleRate | number | Non | 48000 | Fréquence en Hz. Valeurs négociées : 8000, 12000, 16000, 24000, 32000, 44100, 48000. Le navigateur doit également prendre en charge le codage choisi. |
channel | number | Non | 1 | Nombre de canaux : 1 ou 2 |
bitrate | number | Non | 32000 (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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
interval | number | Non | 0 | Intervalle de callback en ms. Les valeurs <=0 désactivent ; une valeur positive inférieure à 10 vaut 10. |
smooth | number | Non | 3 | Facteur de lissage, 0..10. Une valeur supérieure lisse davantage. |
reportSpeech | boolean | Non | false | Signaler l’activité vocale (VAD) |
AoqAudioVolume
Informations de volume local.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
volume | number | — | Volume instantané lissé, plage [0-255] |
isSpeech | boolean | — | 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.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
state | AoqAudioDeviceStateCode | — | Code d’état du périphérique audio |
reason | number | — | 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é.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
fileId | string | — | ID du fichier audio |
stateCode | AoqAudioFileStateCode | — | Code d’état de lecture du fichier |
errorCode | number | — | Code d’erreur |
Types vidéo
AoqVideoCaptureConfig
Configuration de capture vidéo.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
width | number | Non | 1280 | Largeur demandée en pixels, contrainte ideal. Le navigateur/périphérique choisit la valeur réelle. |
height | number | Non | 720 | Hauteur demandée en pixels, contrainte ideal. Le navigateur/périphérique choisit la valeur réelle. |
fps | number | Non | 15 | Fréquence d’images demandée, contraintes ideal et max |
cameraPreference | AoqCameraDirection | string | Non | Choix du navigateur | Orientation ou ID de caméra préféré, contrainte ideal. Repli autorisé ; les chaînes vides sont invalides. |
AoqVideoCodecConfig
Configuration du codec vidéo.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
trackType | AoqTrackType | Non | — | Réservé ; ne sélectionne pas actuellement le flux vidéo |
codecType | AoqEncoderType | Non | AoqEncoderTypeVideoH264 | H.264 / JPEG. Doit correspondre à la configuration négociée avec le pair. |
width | number | Non | 540 | Largeur cible de codage ou négociée en réception, en pixels. Entier positif requis à la connexion. |
height | number | Non | 960 | Hauteur cible de codage ou négociée en réception, en pixels. Entier positif requis à la connexion. |
fps | number | Non | 5 | Fréquence de codage ou négociée en réception. Entier positif requis à la connexion. |
bitrate | number | Non | 500000 (codage) | Débit cible positif de codage en bps. Non utilisé au décodage. |
minBitrate | number | Non | 128000 | Dé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. |
keyframeInterval | number | Non | 2 | Intervalle 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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
view | HTMLElement | string | Oui | — | Conteneur standard ou son ID DOM sans #. N’utilisez pas directement video, audio, canvas, img ou des éléments vides. |
renderMode | AoqRenderMode | Non | AoqRenderModeAuto(0) | Mode d’ajustement vidéo |
AoqVideoDeviceState
Données du callback d’état du périphérique vidéo.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
state | AoqVideoDeviceStateCode | — | Code d’état du périphérique vidéo |
reason | number | — | 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.
| Champ | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
data | Uint8Array | Oui | — | 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.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
audioPublishStats | AoqAudioPublishStats[] | — | Statistiques de publication audio |
audioSubscribeStats | AoqAudioSubscribeStats[] | — | Statistiques d’abonnement audio |
videoPublishStats | AoqVideoPublishStats[] | — | Statistiques de publication vidéo |
videoSubscribeStats | AoqVideoSubscribeStats[] | — | Statistiques d’abonnement vidéo |
dataMsgPublishStats | AoqDataMsgPublishStats[] | — | Statistiques de publication de messages de données |
dataMsgSubscribeStats | AoqDataMsgSubscribeStats[] | — | Statistiques d’abonnement aux messages de données |
networkStats | AoqNetworkStats | — | Statistiques réseau |
AoqAudioPublishStats
Statistiques de publication audio.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
trackType | AoqTrackType | — | Type de piste |
bitrate | number | — | Débit applicatif montant total de connexion en bps, pas un débit audio isolé |
bytes | number | — | Octets applicatifs montants totaux de connexion, pas un total audio isolé |
encodeVolume | number | 0 | Valeur de remplacement. Utilisez onLocalAudioVolumeIndication pour le volume capturé. |
AoqAudioSubscribeStats
Statistiques d’abonnement audio.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
trackType | AoqTrackType | — | Type de piste |
bitrate | number | — | Débit applicatif descendant total de connexion en bps, pas un débit audio isolé |
bytes | number | — | Octets applicatifs descendants totaux de connexion, pas un total audio isolé |
playVolume | number | 0 | Valeur de remplacement ; ne permet pas de déterminer si la lecture est muette |
AoqVideoPublishStats
Statistiques de publication vidéo.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
trackType | AoqTrackType | — | Type de piste |
bitrate | number | 0 | Valeur de remplacement ; débit vidéo isolé non fourni actuellement |
bytes | number | 0 | Valeur de remplacement ; nombre d’octets vidéo isolé non fourni actuellement |
encodeFps | number | — | Fréquence d’images codées |
AoqVideoSubscribeStats
Statistiques d’abonnement vidéo.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
trackType | AoqTrackType | — | Type de piste |
bitrate | number | 0 | Valeur de remplacement ; débit vidéo isolé non fourni actuellement |
bytes | number | 0 | Valeur de remplacement ; nombre d’octets vidéo isolé non fourni actuellement |
decodeFps | number | — | Fréquence d’images décodées |
renderFps | number | — | Fréquence d’images rendues |
AoqDataMsgPublishStats
Statistiques de publication de messages de données.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
trackType | AoqTrackType | — | Type de piste |
bitrate | number | — | Débit actuel en bps |
bytes | number | — | Total cumulé d’octets envoyés |
AoqDataMsgSubscribeStats
Statistiques d’abonnement aux messages de données.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
trackType | AoqTrackType | — | Type de piste |
bitrate | number | — | Débit actuel en bps |
bytes | number | — | Total cumulé d’octets reçus |
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.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
sendBitrate | number | — | Débit montant en bps |
sendBytes | number | — | Octets montants cumulés |
recvBitrate | number | — | Débit descendant en bps |
recvBytes | number | — | Octets descendants cumulés |
loss | number | — | Taux de perte montant facultatif (0–1). Privilégie les observations QUIC du navigateur, sinon une estimation Relay Datagram. Omis si inconnu. |
rtt | number | — | Temps aller-retour facultatif en ms ; omis si inconnu |
bwe | number | — | Budget effectif facultatif d’envoi applicatif Client→Relay en bps ; omis si inconnu ou périmé |
audioReserveBps | number | — | 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ération | Valeur | Description |
|---|---|---|
AoqTrackTypeAudio | 0 | Audio |
AoqTrackTypeVideo | 1 | Vidéo |
AoqTrackTypeData | 2 | Messages de données |
AoqTrackTypeScreen | 3 | Réservé ; non pris en charge dans le flux de connexion actuel |
AoqTrackMode
Mode de transport audio.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqTrackModeSegment | 0 | Mode Segment |
AoqTrackModeStream | 1 | Mode de flux Realtime |
AoqEncoderType
Format multimédia de piste.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqEncoderTypeUnknown | 0 | Inconnu |
AoqEncoderTypeAudioPCM | 1 | Audio PCM |
AoqEncoderTypeAudioOpus | 2 | Audio Opus |
AoqEncoderTypeVideoH264 | 3 | Vidéo H.264 |
AoqEncoderTypeVideoJpeg | 4 | Vidéo JPEG |
AoqEncoderTypeDataText | 5 | Données texte |
AoqConnectionStatus
État de connexion du moteur.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqConnectionStatusDisconnected | 0 | Déconnecté |
AoqConnectionStatusConnecting | 1 | Connexion en cours |
AoqConnectionStatusConnected | 2 | Connecté |
AoqConnectionStatusFailed | 3 | Échec de connexion |
AoqErrorCode
Codes d’erreur.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqECOK | 0 | Succès |
AoqECParamInvalid | 1 | Paramètre invalide |
AoqECStateInvalid | 2 | État invalide |
AoqECUnSupport | 3 | Non implémenté pour la plateforme/le mode actuel |
AoqECAudio | 100 | Erreur audio générale |
AoqECAudioExternalBufferFull | 110 | Tampon audio externe plein |
AoqECAudioDevice | 120 | Erreur générale du périphérique audio |
AoqECAudioDeviceRecordingAuthFailed | 121 | Autorisation du microphone refusée |
AoqECAudioDeviceRecordingOccupied | 122 | Microphone occupé |
AoqECAudioDeviceRecordingBackgroundStart | 123 | Capture démarrée en arrière-plan |
AoqECAudioDeviceRecordingStartFail | 124 | Échec du démarrage de capture |
AoqECAudioDevicePlayoutOccupied | 125 | Périphérique de lecture occupé |
AoqECAudioDevicePlayoutBackgroundStart | 126 | Lecture démarrée en arrière-plan |
AoqECAudioDevicePlayoutStartFail | 127 | Échec du démarrage de lecture |
AoqECAudioDeviceEarpieceRequiresVoipMode | 128 | Écouteur nécessitant le mode VoIP |
AoqECVideo | 200 | Erreur vidéo générale |
AoqECVideoExternalBufferFull | 210 | Tampon vidéo externe plein |
AoqECVideoExternalCaptureNotEnabled | 211 | Capture vidéo externe non activée |
AoqECVideoExternalEncoderNotEnabled | 212 | Encodeur vidéo externe non activé |
AoqECVideoDevice | 220 | Erreur générale du périphérique vidéo |
AoqECVideoDeviceCameraOpenFail | 221 | Échec d’ouverture de la caméra |
AoqECVideoDeviceCameraAuthFailed | 222 | Autorisation de caméra refusée |
AoqECVideoDeviceCameraOccupied | 223 | Caméra occupée |
AoqECVideoDeviceCameraRunningError | 224 | Erreur d’exécution de la caméra |
AoqECVideoCodec | 230 | Erreur générale de codec vidéo |
AoqECVideoCodecEncoderInitFail | 231 | Échec d’initialisation de l’encodeur vidéo |
AoqECVideoRender | 240 | Erreur générale de rendu vidéo |
AoqECVideoRenderCreateFail | 241 | Échec de création du moteur de rendu |
AoqECVideoRenderDrawError | 242 | Erreur de dessin du rendu |
AoqWarningCode
Codes d’avertissement.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqWCOK | 0 | Normal |
AoqWCAudio | 100 | Avertissement audio général |
AoqWCAudioHowling | 101 | Larsen détecté |
AoqWCAudioDevice | 120 | Avertissement général du périphérique audio |
AoqWCAudioDeviceMicEnumerateError | 121 | Erreur d’énumération des microphones |
AoqWCAudioDeviceMicStartTimeout | 122 | Délai de démarrage du microphone dépassé |
AoqWCAudioDeviceRecordingError | 123 | Erreur de capture |
AoqWCAudioDeviceSpeakerEnumerateError | 124 | Erreur d’énumération des haut-parleurs |
AoqWCAudioDeviceSpeakerStartTimeout | 125 | Délai de démarrage du haut-parleur dépassé |
AoqWCAudioDevicePlayoutError | 126 | Erreur de lecture |
AoqWCAudioDeviceSilentMode | 127 | Périphérique en mode silencieux |
AoqWCVideo | 200 | Avertissement vidéo général |
AoqWCVideoCameraEnumerateError | 201 | Erreur d’énumération des caméras |
AoqWCVideoEncoderSwitched | 202 | Encodeur vidéo changé |
AoqWCVideoRenderDowngrade | 203 | Rendu de repli |
AoqAudioDeviceStateCode
Codes d’état du périphérique audio.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqAudioDeviceNone | 0 | Aucun état |
AoqAudioDeviceRecordStarting | 1 | Démarrage de capture |
AoqAudioDeviceRecordStarted | 2 | Capture démarrée |
AoqAudioDeviceRecordStopping | 3 | Arrêt de capture |
AoqAudioDeviceRecordStopped | 4 | Capture arrêtée |
AoqAudioDeviceRecordFail | 5 | Échec de capture |
AoqAudioDevicePlayStarting | 6 | Démarrage de lecture |
AoqAudioDevicePlayStarted | 7 | Lecture démarrée |
AoqAudioDevicePlayStopping | 8 | Arrêt de lecture |
AoqAudioDevicePlayStopped | 9 | Lecture arrêtée |
AoqAudioDevicePlayFail | 10 | Échec de lecture |
AoqAudioDeviceRouteType
Types de route du périphérique audio.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqAudioDeviceRouteDefault | 0 | Route par défaut |
AoqAudioDeviceRouteHeadset | 1 | Casque |
AoqAudioDeviceRouteSpeakerPhone | 4 | Haut-parleur intégré |
AoqAudioDeviceRouteUsb | 5 | Périphérique USB |
AoqAudioDeviceRouteBluetooth | 6 | Périphérique Bluetooth |
AoqAudioFileStateCode
Codes d’état de lecture de fichiers audio.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqAudioFileNone | 0 | Aucun état |
AoqAudioFileStarted | 1 | Lecture démarrée |
AoqAudioFileStopped | 2 | Lecture arrêtée |
AoqAudioFilePaused | 3 | Lecture suspendue |
AoqAudioFileResumed | 4 | Lecture reprise |
AoqAudioFileEnded | 5 | Lecture terminée |
AoqAudioFileBuffering | 6 | Mise en tampon |
AoqAudioFileBufferingEnd | 7 | Mise en tampon terminée |
AoqAudioFileFailed | 8 | Échec de lecture |
AoqCameraDirection
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqCameraDirectionFront | 0 | Préférer la caméra avant |
AoqCameraDirectionBack | 1 | Préférer la caméra arrière |
AoqVideoDeviceStateCode
Codes d’état du périphérique vidéo.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqVideoDeviceNone | 0 | Aucun état |
AoqVideoDeviceCaptureStarting | 1 | Démarrage de capture |
AoqVideoDeviceCaptureStarted | 2 | Capture démarrée |
AoqVideoDeviceCaptureStopping | 3 | Arrêt de capture |
AoqVideoDeviceCaptureStopped | 4 | Capture arrêtée |
AoqVideoDeviceCaptureFail | 5 | É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ération | Valeur | Description |
|---|---|---|
AoqMirrorModeDisabled | 0 | Miroir désactivé |
AoqMirrorModeEnabled | 1 | Miroir 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ération | Valeur | Description |
|---|---|---|
AoqOrientationModeAuto | 0 | Automatique |
AoqOrientationModePortrait | 1 | Portrait |
AoqOrientationModeLandscape | 2 | Paysage |
AoqRenderMode
Modes d’ajustement vidéo.
| Membre de l’énumération | Valeur | Description |
|---|---|---|
AoqRenderModeAuto | 0 | Par défaut : image entière en conservant les proportions |
AoqRenderModeStretch | 1 | Étirer pour remplir le conteneur |
AoqRenderModeFill | 2 | Image entière en conservant les proportions, bandes noires autorisées |
AoqRenderModeCrop | 3 | Remplir 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égorie | Déclarations publiques | Prise en charge actuelle |
|---|---|---|
| Mixage de fichiers audio | AoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCode | Aucun contrôle de lecture ou mixage de fichiers ; aucun événement d’état de fichier émis |
| Audio externe et observateurs | AoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirection | Aucune méthode d’entrée audio externe ni d’inscription d’observateur de trames audio |
| Vidéo externe et observateurs | AoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecType | Aucune entrée de trames vidéo externes ni inscription d’observateur vidéo. La configuration du codec utilise AoqEncoderType. |
| Miroir et orientation | AoqMirrorMode, AoqOrientationMode | Aucun champ ni méthode correspondant. L’inversion de l’aperçu local est automatique. |
| Périphériques audio bas niveau | AoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCode | Dé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é.