Cette rubrique décrit les API C++, les rappels et les types de données d'AOQ Client SDK pour Windows.
AoqClientEngine et signale les événements asynchrones via la classe abstraite AoqEngineEventListener. Toutes les définitions de type résident dans le namespace AoqClientSdk et le fichier d'en-tête est AoqClientEngine.h.
const char*. Elles doivent rester valides au moins jusqu'au retour de l'appel correspondant. Le moteur les copie en interne selon les besoins.Détails des API
Cycle de vie du moteur
createEngine
Créez l'instance du moteur. Le SDK conserve le moteur en tant que singleton global ; par conséquent, un nouvel appel à cette méthode renvoie l'instance existante.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de création du moteur. Pour plus d'informations, consultez |
|
| Écouteur de rappel d'événements. Pour plus d'informations, consultez |
nullptr est renvoyé en cas d'échec.
destroy
Détruisez l'instance du moteur. Une fois le moteur détruit, vous devez appeler à nouveau createEngine avant de pouvoir continuer à l'utiliser.
getVersion
Obtenez la version du SDK.
connect
Connectez-vous au serveur relais. Le serveur d'application obtient les paramètres de connexion AOQ temporaires basés sur le protocole utilisé et les envoie au client. Pour plus d'informations, consultez Authentification par jeton.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration d'authentification de la connexion. Pour plus d'informations, consultez |
disconnect
Déconnectez-vous du serveur.
Gestion des périphériques audio
startAudioCapture
Ouvrez le périphérique de capture audio (microphone).
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de capture audio. Pour plus d'informations, consultez |
stopAudioCapture
Fermez le périphérique de capture audio.
muteAudioCapture
Coupez ou rétablissez le son de la capture audio.
Paramètres | Type | Description |
|---|---|---|
|
|
|
startAudioPlayer
Démarrez le rendu audio pour lire l'audio distant.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de lecture audio. Pour plus d'informations, consultez |
stopAudioPlayer
Arrêtez le rendu audio.
pauseAudioPlayer
Mettez en pause le rendu audio, avec prise en charge du fondu sortant.
Paramètres | Type | Description |
|---|---|---|
|
| Durée du fondu sortant, en millisecondes. 0 indique une pause immédiate. |
resumeAudioPlayer
Reprenez le rendu audio, avec prise en charge du fondu entrant.
Paramètres | Type | Description |
|---|---|---|
|
| Durée du fondu entrant, en millisecondes. 0 indique une reprise immédiate. |
interruptAudioPlayer
Interrompez la session audio en cours et arrêtez l'audio en cours de lecture.
Paramètres | Type | Description |
|---|---|---|
|
| Type de piste. Pour plus d'informations, consultez |
|
| Durée du fondu sortant, en millisecondes. 0 indique une interruption immédiate. |
enableLocalAudioVolumeIndication
Activez ou désactivez l'indication du volume de capture local. Une fois activée, le rappel onLocalAudioVolumeIndication est déclenché à l'intervalle spécifié par config.interval. Si config.interval <= 0, le rappel est désactivé. Vous devez appeler cette méthode après startAudioCapture pour obtenir les données de volume.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration d'indication de volume. Pour plus d'informations, consultez |
Configuration de l'encodage audio
setAudioEncoderConfig
Définissez les paramètres d'encodage audio.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec audio. Pour plus d'informations, consultez |
setAudioDecoderConfig
Définissez les paramètres de décodage audio.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec audio. Pour plus d'informations, consultez |
Gestion des périphériques vidéo
startVideoCapture
Ouvrez le périphérique de capture vidéo (caméra). Lorsque isExternal=true est configuré, la caméra n'est pas ouverte et les images sont alimentées par pushExternalVideoCapturedFrame.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de capture vidéo. Pour plus d'informations, consultez |
stopVideoCapture
Fermez le périphérique de capture vidéo.
setLocalView
Définissez ou supprimez la fenêtre de rendu vidéo local. Si canvas.view == nullptr, la liaison est supprimée.
Paramètres | Type | Description |
|---|---|---|
|
| Piste vidéo. Transmettez |
|
| Toile de rendu. Pour plus d'informations, consultez |
setRemoteView
Définissez ou supprimez la fenêtre de rendu vidéo distant. Si canvas.view == nullptr, la liaison est supprimée.
Paramètres | Type | Description |
|---|---|---|
|
| Piste vidéo. Transmettez |
|
| Toile de rendu. Pour plus d'informations, consultez |
Encodage vidéo et entrée externe
setVideoEncoderConfig
Définissez les paramètres d'encodage vidéo et acheminez-les en fonction de config.trackType.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec vidéo. Pour plus d'informations, consultez |
setVideoDecoderConfig
Définissez les paramètres de décodage vidéo (une proposition de codec côté abonné, qui doit être appelée avant connect). L'appel est acheminé en fonction de config.trackType.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec vidéo. Pour plus d'informations, consultez |
pushExternalVideoCapturedFrame
Transmettez une image vidéo externe. Vous devez d'abord appeler startVideoCapture et configurer isExternal=true. Si la capture vidéo externe n'est pas démarrée, AoqECVideoExternalCaptureNotEnabled (211) est renvoyé. Si le format d'image n'est pas pris en charge, AoqECParamInvalid est renvoyé.
Paramètres | Type | Description |
|---|---|---|
|
| Cible d'acheminement. Transmettez |
|
| Données de l'image vidéo externe. Pour plus d'informations, consultez |
AoqECVideoExternalBufferFull (210) indique que le tampon est plein ; AoqECVideoExternalCaptureNotEnabled (211) indique que la capture vidéo externe n'est pas activée ; AoqECParamInvalid indique un format d'image non pris en charge ; les autres valeurs non nulles indiquent d'autres erreurs.
pushExternalVideoEncodedFrame
Transmettez directement une image vidéo encodée en externe, en contournant l'encodeur. Vous devez d'abord appeler setVideoEncoderConfig et configurer isExternal=true. Seul le format JPEG est actuellement pris en charge.
Paramètres | Type | Description |
|---|---|---|
|
| Cible d'acheminement. Transmettez |
|
| Données de l'image encodée en externe. Pour plus d'informations, consultez |
Contrôle du flux multimédia
enableSendMediaStream
Activez ou désactivez l'envoi d'un flux multimédia local. Nous vous recommandons de désactiver l'envoi après l'initialisation et de l'activer uniquement lorsque le rappel onConnectionStatusChange signale AoqConnectionStatusConnected.
Paramètres | Type | Description |
|---|---|---|
|
| Cible d'acheminement. |
|
|
|
Lecture de fichiers audio
startAudioFile
Démarrez la lecture d'un fichier audio local vers le flux de publication.
Paramètres | Type | Description |
|---|---|---|
|
| ID du fichier audio. La couche métier doit garantir son unicité. |
|
| Configuration de mixage du fichier audio. Pour plus d'informations, consultez |
stopAudioFile
Arrêtez la lecture du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| ID du fichier audio |
pauseAudioFile
Mettez en pause la lecture du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| ID du fichier audio |
resumeAudioFile
Reprenez la lecture du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| ID du fichier audio |
getAudioFileDuration
Obtenez la durée totale du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| ID du fichier audio |
-AoqErrorCode).
Types de données et énumérations
Types généraux
AoqCreateConfig
Configuration de création du moteur.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Répertoire de travail du SDK |
|
|
| Indique s'il faut enregistrer les données audio (à des fins de débogage) |
|
|
| Paramètres étendus (chaîne JSON) |
AoqConnectConfig
Configuration de la connexion au serveur relais. Les champs relayEndpoints, publishTracks et subscribeTracks sont des tableaux de style C accompagnés de leur longueur. La mémoire du tableau est gérée par l'appelant et doit rester valide uniquement pendant l'appel à connect.
Champ | Type | Description |
|---|---|---|
|
| Jeton d'authentification de la connexion |
|
| ID de session |
|
| Empreinte du certificat du serveur |
|
| ID de hachage de l'espace de travail |
|
| Tableau des points d'accès relais |
|
| Nombre de points d'accès relais |
|
| Tableau des attributs des pistes de publication locales |
|
| Nombre de pistes de publication |
|
| Tableau des attributs des pistes d'abonnement locales |
|
| Nombre de pistes d'abonnement |
AoqRelayEndpoint
Point d'accès relais.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Index du chemin |
|
|
| Adresse du serveur (nom de domaine ou adresse IP) |
|
|
| Port du serveur |
AoqTrackParam
Attribut de piste.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Type de piste |
|
|
| Mode streaming ou non streaming. Effectif uniquement pour la liaison descendante audio. |
AoqDataMsg
Structure de données du message. Lors de son utilisation dans un rappel, sa validité est garantie uniquement pendant l'exécution du rappel. Si vous devez l'utiliser de manière asynchrone, effectuez une copie vous-même.
Champ | Type | Description |
|---|---|---|
|
| Contenu du message. Pointe vers la mémoire détenue par l'appelant. |
|
| Nombre d'octets |
Types de statistiques
AoqStats
Statistiques du moteur. Chaque tableau de statistiques est fourni sous la forme d'un pointeur et d'un compteur.
Champ | Type | Description |
|---|---|---|
|
| Tableau des statistiques de publication audio et nombre d'entrées |
|
| Tableau des statistiques de publication vidéo et nombre d'entrées |
|
| Tableau des statistiques de publication des messages de données et nombre d'entrées |
|
| Tableau des statistiques d'abonnement audio et nombre d'entrées |
|
| Tableau des statistiques d'abonnement vidéo et nombre d'entrées |
|
| Tableau des statistiques d'abonnement aux messages de données et nombre d'entrées |
|
| Statistiques réseau |
AoqNetworkStats
Statistiques réseau.
Field | Type | Description |
|---|---|---|
|
| Débit d'envoi, en bit/s |
|
| Nombre cumulé d'octets envoyés |
|
| Débit de réception, en bit/s |
|
| Nombre cumulé d'octets reçus |
|
| Taux de perte de paquets, de 0 à 100 |
|
| Latence aller-retour, en ms |
AoqAudioPublishStats
Statistiques de publication audio.
Field | Type | Description |
|---|---|---|
|
| Type de piste |
|
| Débit binaire, en bit/s |
|
| Nombre cumulé d'octets |
|
| Volume d'encodage du flux publié |
AoqVideoPublishStats
Statistiques de publication vidéo.
Field | Type | Description |
|---|---|---|
|
| Type de piste |
|
| Débit binaire, en bit/s |
|
| Nombre cumulé d'octets |
|
| Fréquence d'images d'encodage |
AoqDataMsgPublishStats
Statistiques de publication des messages de données.
Field | Type | Description |
|---|---|---|
|
| Type de piste |
|
| Débit binaire, en bit/s |
|
| Nombre cumulé d'octets |
AoqAudioSubscribeStats
Statistiques d'abonnement audio.
Field | Type | Description |
|---|---|---|
|
| Type de piste |
|
| Débit binaire, en bit/s |
|
| Nombre cumulé d'octets |
|
| Volume de lecture |
AoqVideoSubscribeStats
Statistiques d'abonnement vidéo.
Field | Type | Description |
|---|---|---|
|
| Type de piste |
|
| Débit binaire, en bit/s |
|
| Nombre cumulé d'octets |
|
| Fréquence d'images de décodage |
|
| Fréquence d'images de rendu |
AoqDataMsgSubscribeStats
Statistiques d'abonnement aux messages de données.
Field | Type | Description |
|---|---|---|
|
| Type de piste |
|
| Débit binaire, en bit/s |
|
| Nombre cumulé d'octets |
Enumerations
AoqErrorCode
Énumération des codes d'erreur.
Enum value | Value | Description |
|---|---|---|
| 0 | Succès |
| 1 | Paramètre non valide |
| 2 | État non valide |
| 3 | L'API est appelée, mais n'est pas implémentée sur la plateforme actuelle ou dans le mode actuel |
| 100 | Erreur audio générique |
| 110 | Le tampon audio externe est plein |
| 120 | Erreur générique du périphérique audio |
| 121 | Autorisation d'enregistrement non accordée |
| 122 | Le périphérique d'enregistrement est en cours d'utilisation |
| 123 | Démarrer l'enregistrement en arrière-plan |
| 124 | Échec du démarrage de l'enregistrement |
| 125 | Le périphérique de lecture est en cours d'utilisation |
| 126 | Démarrer la lecture en arrière-plan |
| 127 | Échec du démarrage de la lecture |
| 128 | Le mode écouteur nécessite l'activation de la VoIP |
| 200 | Erreur vidéo générique |
| 210 | Le tampon vidéo externe est plein |
| 211 | La capture vidéo externe n'est pas activée |
| 212 | L'encodage vidéo externe n'est pas activé |
| 220 | Erreur générique du périphérique vidéo |
| 221 | Échec de l'ouverture de la caméra |
| 222 | Autorisation d'accès à la caméra non accordée |
| 223 | La caméra est en cours d'utilisation |
| 224 | Erreur d'exécution de la caméra |
| 230 | Erreur générique du codec vidéo |
| 231 | Échec de l'initialisation de l'encodeur |
| 240 | Erreur générique de rendu vidéo |
| 241 | Échec de la création de la vue de rendu |
| 242 | Erreur de dessin lors du rendu |
AoqWarningCode
Énumération des codes d'avertissement.
Enum value | Value | Description |
|---|---|---|
| 0 | Aucun avertissement |
| 100 | Avertissement audio générique |
| 101 | Détection d'un effet Larsen audio |
| 120 | Avertissement générique du périphérique audio |
| 121 | Erreur d'énumération du microphone |
| 122 | Délai dépassé lors du démarrage du microphone |
| 123 | Erreur d'enregistrement |
| 124 | Erreur d'énumération du haut-parleur |
| 125 | Délai dépassé lors du démarrage du haut-parleur |
| 126 | Erreur de lecture |
| 200 | Avertissement vidéo générique |
| 201 | Erreur d'énumération de la caméra |
| 202 | Changement d'encodeur vidéo |
| 203 | Rétrogradation du rendu vidéo |
AoqTrackType
Type de piste.
Enum value | Value | Description |
|---|---|---|
| 0 | Piste audio |
| 1 | Piste vidéo |
| 2 | Piste de messages de données |
AoqEncoderType
Type d'encodeur.
Enum value | Value | Description |
|---|---|---|
| 0 | Format inconnu |
| 1 | Audio PCM |
| 2 | Audio Opus (basé sur un plug-in ; contactez l'équipe SDK pour qu'il soit intégré ou téléchargé dynamiquement dans l'application) |
| 3 | Vidéo H.264 |
| 4 | Vidéo JPEG |
| 5 | Texte du message |
AoqTrackMode
Mode de diffusion en continu ou non. S'applique uniquement à la liaison descendante audio.
Enum value | Value | Description |
|---|---|---|
| 0 | Segmented : les données sont encapsulées et transmises par segments sémantiques, tels qu'une phrase. |
| 1 | Streaming : les données sont transmises en continu. |
AoqConnectionStatus
Statut de la connexion au moteur.
Enum value | Value | Description |
|---|---|---|
| 0 | Déconnecté |
| 1 | Connexion en cours |
| 2 | Connecté |
| 3 | Échec de la connexion |
Types audio
AoqAudioCaptureConfig
Configuration de la capture audio.
Field | Type | Default value | Description |
|---|---|---|---|
|
|
| Indique s'il faut utiliser une capture externe |
|
|
| Nombre de canaux de capture audio. Les valeurs 1 et 2 sont prises en charge. |
AoqAudioPlaybackConfig
Configuration de la lecture audio.
Field | Type | Default value | Description |
|---|---|---|---|
|
|
| Indique s'il faut utiliser une lecture externe |
|
|
| Nombre de canaux de lecture audio. Les valeurs 1 et 2 sont prises en charge. |
AoqAudioCodecConfig
Configuration du codec audio.
Field | Type | Default value | Description |
|---|---|---|---|
|
|
| Type de piste |
|
|
| Format du codec |
|
|
| Fréquence d'échantillonnage, en Hz. Pour l'encodage, Opus 8/16/48K et PCM 8/16/32/48K sont pris en charge. Pour le décodage, 24K est également pris en charge, mais limité au mode Segment. Le mode Stream ne prend pas en charge 24K ; une combinaison invalide déclenche le rappel onError avec AoqECParamInvalid lors de la connexion. |
|
|
| Nombre de canaux. Les valeurs 1 et 2 sont prises en charge. |
|
|
| Débit binaire, en bit/s |
AoqAudioDeviceState
État du périphérique audio.
Field | Type | Description |
|---|---|---|
|
| Code d'état |
|
| Code d'erreur ( |
AoqAudioDeviceStateCode
Code d'état du périphérique audio.
Enum value | Value | Description |
|---|---|---|
| 0 | Aucun état |
| 1 | Démarrage de la capture |
| 2 | Capture démarrée |
| 3 | Arrêt de la capture |
| 4 | Capture arrêtée |
| 5 | Échec de la capture |
| 6 | Démarrage de la lecture |
| 7 | Lecture démarrée |
| 8 | Arrêt de la lecture |
| 9 | Lecture arrêtée |
| 10 | Échec de la lecture |
AoqAudioDeviceRouteType
Type de routage du périphérique audio.
Enum value | Value | Description |
|---|---|---|
| 0 | Par défaut |
| 1 | Casque |
| 2 | Écouteur |
| 3 | Casque sans microphone |
| 4 | Haut-parleur intégré |
| 5 | USB |
| 6 | Bluetooth |
| 7 | Bluetooth A2DP |
AoqAudioFileMixConfig
Configuration de lecture d'un fichier audio vers le flux de publication.
Field | Type | Default value | Description |
|---|---|---|---|
|
|
| Nom du fichier (incluant le chemin). Obligatoire. |
|
|
| Nombre de boucles. La valeur -1 indique une boucle illimitée. |
|
|
| Position de démarrage de la lecture, en ms |
|
|
| Volume de publication. Valeurs valides : 0 à 100. |
|
|
| Volume de lecture. Valeurs valides : 0 à 100. |
AoqAudioFileState
État du fichier audio.
Field | Type | Description |
|---|---|---|
|
| ID du fichier |
|
| Code d'état |
|
| Code d'erreur |
AoqAudioFileStateCode
Code d'état du fichier audio.
Enum value | Value | Description |
|---|---|---|
| 0 | Aucun état |
| 1 | Démarré |
| 2 | Arrêté |
| 3 | En pause |
| 4 | Repris |
| 5 | Lecture terminée |
| 6 | Mise en mémoire tampon |
| 7 | Fin de la mise en mémoire tampon |
| 8 | Échec de la lecture |
AoqAudioFileErrorCode
Code d'erreur de lecture du fichier audio.
Enum value | Value | Description |
|---|---|---|
| 0 | Aucune erreur |
| 1 | Échec de l'ouverture du fichier |
| 2 | Échec du décodage du fichier |
AoqAudioExternalStreamConfig
Configuration du flux audio externe.
Field | Type | Default value | Description |
|---|---|---|---|
|
|
| Type de piste audio |
|
|
| Format du flux audio. Le format PCM est pris en charge. |
|
|
| Nombre de canaux. Cette valeur est limitée par le codec audio du flux de publication, qui prend en charge 1 et 2. Les canaux supplémentaires sont ignorés. |
|
|
| Fréquence d'échantillonnage, en Hz. Les valeurs 8, 12, 16, 24, 32, 44,1, 48, 64, 88,2, 96, 176,4 et 192K sont prises en charge. |
|
|
| Volume de lecture. Valeurs valides : 0 à 100. |
|
|
| Volume de publication. Valeurs valides : 0 à 100. |
|
|
| Durée maximale de la mémoire tampon, en ms. Valeurs valides : 100 et plus. Si la durée mise en mémoire tampon dans le SDK dépasse cette valeur, l'opération Push échoue. |
|
|
| Indique s'il faut appliquer le traitement 3A au PCM d'entrée |
AoqAudioFrameData
Données audio.
Field | Type | Description |
|---|---|---|
|
| Pointeur vers les données audio |
|
| Nombre d'échantillons (par canal) |
|
| Octets par échantillon |
|
| Nombre de canaux |
|
| Nombre d'échantillons par seconde |
|
| Tour d'entrée PCM (utilisé pour la notification de fin de consommation de |
|
| Horodatage |
|
| Longueur des données |
|
| Valide dans les rappels de données. La valeur |
AoqAudioStreamDirection
Sens du flux audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Publication de l'audio |
| 1 | Lecture de l'audio |
AoqAudioExternalStreamToggle
Contrôle du flux audio externe.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Récupéré |
| 1 | En pause |
AoqAudioSource
Type de source des données audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Données audio capturées |
| 1 | Données audio après traitement 3A |
| 2 | Données audio à publier (nécessite une connexion établie avec succès) |
| 3 | Données audio à lire |
AoqAudioObserverMode
Mode de rappel des trames audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Lecture seule |
| 1 | Lecture-écriture |
AoqAudioObserverConfig
Paramètres de configuration pour les rappels de données audio.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Fréquence d'échantillonnage de l'audio de rappel. Elle est limitée par la source. Un rééchantillonnage est effectué si les fréquences ne correspondent pas. Les valeurs prises en charge sont 8, 12, 16, 24, 32, 44,1, 48, 64, 88,2, 96, 176,4 et 192 kHz. |
|
|
| Nombre de canaux audio dans le rappel. Les valeurs 1 et 2 sont prises en charge. Ce paramètre est limité par les paramètres de codec du flux d'abonnement. |
|
|
| Mode de rappel |
AoqAudioVolumeIndicationConfig
Configuration de l'indication du volume local.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Intervalle de rappel, en ms. Une valeur inférieure ou égale à 0 désactive le rappel. Une valeur supérieure à 0 et inférieure à 10 est traitée comme 10. |
|
|
| Coefficient de lissage du volume. Valeurs valides : 0 à 10. Plus la valeur est élevée, plus la sortie est lisse. |
AoqAudioVolume
Informations sur le volume local.
Champ | Type | Description |
|---|---|---|
|
| Volume instantané lissé. Valeurs valides : 0 à 255. |
Types vidéo
AoqVideoCaptureConfig
Configuration de la capture vidéo.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Largeur de capture, en pixels. Ce paramètre n'a aucun effet lorsque |
|
|
| Hauteur de capture, en pixels. Ce paramètre n'a aucun effet lorsque |
|
|
| Taux de rafraîchissement de la capture. Ce paramètre n'a aucun effet lorsque |
|
|
| Indique s'il faut utiliser une capture externe. Si la valeur est |
AoqVideoCanvas
Structure de données pour le rendu vidéo. view est un pointeur opaque vers le handle de vue natif de la plateforme. Sous Windows, transmettez le handle de fenêtre HWND. L'appelant doit s'assurer que le cycle de vie de view survit à la période pendant laquelle il est défini par setLocalView / setRemoteView.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Handle de la vue d'affichage ( |
|
|
| Mode de rendu |
AoqRenderMode
Mode d'affichage du rendu.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Mode automatique |
| 1 | Mode étiré pour remplir. Lorsque les rapports d'aspect ne correspondent pas, l'image est étirée au rapport cible et devient déformée. |
| 2 | Mode letterbox. Lorsque les rapports d'aspect ne correspondent pas, des barres noires sont ajoutées en haut et en bas ou à gauche et à droite. |
| 3 | Mode recadrage. Lorsque les rapports d'aspect ne correspondent pas, la largeur ou la hauteur est recadrée et une partie de l'image est perdue. |
AoqVideoPixelFormat
Format de pixel vidéo.
Valeur d'énumération | Valeur | description |
|---|---|---|
| 0 | Format inconnu |
| 1 | I420 |
| 2 | NV12 |
| 3 | NV21 |
| 4 | BGRA |
| 5 | RGBA |
AoqVideoFrame
Données vidéo externes.
Champ | type | description |
|---|---|---|
|
| Format de pixel |
|
| width, en pixels |
|
| Hauteur, en pixels |
|
| Pointeur vers les données au format packé (NV12/NV21/BGRA/RGBA) |
|
| Nombre d'octets des données packées |
|
| Pointeurs vers les données des trois plans I420 |
|
| Pas (stride) des trois plans I420 |
|
| Horodatage, en ms. Si la valeur est 0, le SDK la renseigne avec l'horloge locale. |
AoqVideoEncodedFrame
Une image vidéo encodée en externe. L'appelant effectue l'encodage et le SDK emballe et envoie directement l'image sans ré-encodage.
Champ | type | description |
|---|---|---|
|
| format de codec |
|
| Pointeur vers les données encodées |
|
| Nombre d'octets des données encodées |
|
| width, en pixels |
|
| Hauteur, en pixels |
|
| Horodatage, en ms. Si la valeur est 0, le SDK la renseigne avec l'horloge locale. |
AoqVideoCodecType
type de codec de l'image encodée en externe.
Valeur d'énumération | Valeur | description |
|---|---|---|
| 0 | JPEG |
AoqVideoDeviceState
État du périphérique vidéo.
Champ | type | description |
|---|---|---|
|
| <!--@p {"id":"77c5611f15a1"}--br>code d'état |
|
| code d'erreur ( |
AoqVideoDeviceStateCode
code d'état du périphérique vidéo.
Valeur d'énumération | Valeur | description |
|---|---|---|
| 0 | Aucun état |
| 1 | Démarrage de la caméra |
| 2 | Caméra démarrée |
| 3 | Arrêt de la caméra |
| 4 | Caméra arrêtée |
| 5 | Échec du démarrage de la caméra (par exemple, autorisation refusée ou périphérique indisponible) |
AoqMirrorMode
Mode miroir.
Valeur d'énumération | Valeur | description |
|---|---|---|
| 0 | Désactiver le mode miroir |
| 1 | activez le mode miroir |
AoqOrientationMode
Mode d'orientation.
Valeur d'énumération | Valeur | description |
|---|---|---|
| 0 | Automatique |
| 1 | Portrait |
| 2 | Paysage |
AoqVideoCodecConfig
Paramètres du codec vidéo, partagés entre l'encodage et le décodage. Pour le décodage, seuls les champs trackType, codecType, width, height, fps et bitrate sont pris en compte et participent à la négociation en tant que proposition d'abonnement. En revanche, les champs minBitrate, keyframeInterval, mirrorMode, orientationMode et isExternal sont utilisés uniquement pour l'encodage.
Field | Type | Default value | Description |
|---|---|---|---|
|
|
| Mode d'encodage externe. Lorsque la valeur est |
|
|
| Type de piste |
|
|
| Format du codec |
|
|
| Largeur de la résolution |
|
|
| Hauteur de la résolution |
|
|
| Fréquence d'images |
|
|
| Débit initial, en bit/s |
|
|
| Débit minimal, en bit/s |
|
|
| Intervalle entre les images clés, en secondes |
|
|
| Mode miroir |
|
|
| Mode d'orientation |
AoqVideoSource
source de données pour le rappel des images vidéo (position dans le pipeline).
Enum value | Value | Description |
|---|---|---|
| 0 | Données vidéo capturées avant le prétraitement |
| 1 | Données vidéo avant l'encodage, après le prétraitement |
| 2 | Données vidéo distantes après le décodage et avant le rendu |
AoqVideoObserverMode
Mode de rappel des images vidéo.
Enum value | Value | Description |
|---|---|---|
| 0 | Lecture seule |
| 1 | Lecture-écriture |
AoqVideoObserverAlignment
Méthode d'alignement de la width pour la sortie vidéo.
Enum value | Value | Description |
|---|---|---|
| 0 | Valeur par défaut |
| 1 | Alignement sur un nombre pair |
| 2 | Alignement sur 4 octets |
| 3 | Alignement sur 8 octets |
| 4 | Alignement sur 16 octets |
AoqVideoObserverConfig
Paramètres pour les rappels de données vidéo.
Field | Type | Default value | Description |
|---|---|---|---|
|
|
| Format de pixel attendu pour les données de rappel |
|
|
| Politique d'alignement de la largeur |
|
|
| Mode de rappel. Le mode ReadWrite est pris en charge uniquement pour le format I420. |
|
|
| Indique s'il faut appliquer un effet miroir aux données de rappel |
getAudioFileCurrentPosition
Récupère la position de lecture actuelle du fichier audio.
Parameters | Type | Description |
|---|---|---|
|
| ID du fichier audio |
-AoqErrorCode).
setAudioFilePositionMillis
définissez la position de lecture du fichier audio (recherche).
Parameters | Type | Description |
|---|---|---|
|
| ID du fichier audio |
|
| Position de lecture, en millisecondes |
setAudioFileVolume
Définit le volume du fichier audio.
Parameters | Type | Description |
|---|---|---|
|
| ID du fichier audio |
|
| Direction du flux audio. Pour plus d'informations, consultez |
|
| Valeur du volume. Valeurs valides : 0 à 100. |
getAudioFileVolume
Récupère le volume actuel du fichier audio.
Parameters | Type | Description |
|---|---|---|
|
| ID du fichier audio |
|
| Direction du flux audio. Pour plus d'informations, consultez |
-AoqErrorCode).
Flux audio externes
addAudioExternalStream
Ajoute un flux audio externe.
Parameters | Type | Description |
|---|---|---|
|
| ID du flux audio externe. La couche métier doit garantir son unicité. |
|
| Configuration du flux audio externe. Pour plus d'informations, consultez |
pushAudioExternalStreamData
Alimente le SDK avec des données PCM audio externes. Si la valeur AoqECAudioExternalBufferFull (110) est renvoyée, cela signifie que le tampon du SDK est plein. Il est recommandé d'attendre environ 20 ms avant de renvoyer la trame de données actuelle.
Parameters | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| Données audio externes brutes. Pour plus d'informations, consultez |
AoqECAudioExternalBufferFull.setAudioExternalStreamVolume
Définit le volume d'un flux audio externe.
Parameters | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| Type de flux audio externe. Pour plus d'informations, consultez |
|
| Valeur du volume. Valeurs valides : 0 à 100. |
getAudioExternalStreamVolume
Récupère le volume d'un flux audio externe.
Parameters | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| Type de flux audio externe. Pour plus d'informations, consultez |
-AoqErrorCode).
clearAudioExternalStreamBuffer
Vide le tampon d'un flux audio externe.
Parameters | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| Durée de l'atténuation (fade-out). La valeur -1 utilise l'atténuation par défaut du SDK, 0 vide intégralement le tampon sans atténuation, et toute valeur supérieure à 0 applique une atténuation sur le nombre de millisecondes spécifié. |
removeAudioExternalStream
Supprime un flux audio externe.
Parameters | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
Messagerie en temps réel
sendDataMsg
Envoie un message de données en temps réel.
Parameters | Type | Description |
|---|---|---|
|
| Contenu du message. Pour plus d'informations, consultez |
Rappels de trames audio
setAudioFrameObserver
Définit l'écouteur de rappel pour les données de trame audio. Transmettez nullptr pour arrêter les rappels. Après avoir défini l'écouteur, appelez enableAudioFrameObserver pour activer le rappel correspondant à la source de données.
Paramètres | Type | Description |
|---|---|---|
|
| Écouteur de rappel de trame audio. Pour plus d'informations, consultez |
enableAudioFrameObserver
Active ou désactive le rappel de trame audio à une position spécifiée.
Paramètres | Type | Description |
|---|---|---|
|
| Indique s'il faut autoriser les rappels de données |
|
| Type de la source de données audio brutes. Pour plus d'informations, consultez |
|
| Paramètres du rappel. Pour plus d'informations, consultez |
Rappels de trames vidéo
setVideoFrameObserver
Définit l'écouteur de rappel pour les données de trame vidéo. Transmettez nullptr pour arrêter les rappels. Après avoir défini l'écouteur, appelez enableVideoFrameObserver pour activer le rappel correspondant à la source de données.
Paramètres | Type | Description |
|---|---|---|
|
| Écouteur de rappel de trame vidéo. Pour plus d'informations, consultez |
enableVideoFrameObserver
Active ou désactive le rappel de trame vidéo à une position spécifiée.
Paramètres | Type | Description |
|---|---|---|
|
| Indique s'il faut activer les rappels de données à une position donnée |
|
| Source de données du rappel de trame vidéo (position dans le pipeline). Pour plus d'informations, consultez |
|
| Paramètres du rappel. Pour plus d'informations, consultez |
Rappels
AoqEngineEventListener
AoqEngineEventListener constitue le point d'entrée unifié pour toutes les notifications d'événements asynchrones du SDK. Il s'agit d'une classe abstraite que vous devez hériter et implémenter, puis transmettre lors de l'appel à createEngine. Tous les rappels peuvent être déclenchés sur des threads internes ; vous devez donc gérer vous-même la sécurité des threads. Transitions d'état : Disconnected → Connecting → Connected/Failed → Disconnected.
onError
Rappel d'erreur du moteur.
Paramètres | Type | Description |
|---|---|---|
|
| Code d'erreur. Pour plus d'informations, consultez |
|
| Description de l'erreur |
onWarning
Rappel d'avertissement du moteur.
Paramètres | Type | Description |
|---|---|---|
|
| Code d'avertissement. Pour plus d'informations, consultez |
|
| Description de l'avertissement |
onConnectionStatusChange
Rappel de changement d'état de la connexion du moteur.
Paramètres | Type | Description |
|---|---|---|
|
| État de la connexion. Pour plus d'informations, consultez |
onStats
Rappel de statistiques du moteur.
Paramètres | Type | Description |
|---|---|---|
|
| Données statistiques. Pour plus d'informations, consultez |
onAudioDeviceStateChanged
Rappel indiquant les changements d'état des opérations de capture et de lecture des périphériques audio.
Paramètres | Type | Description |
|---|---|---|
|
| État du périphérique audio. Pour plus d'informations, consultez |
onAudioDeviceRouteChanged
Rappel de modification du chemin de sortie audio.
Parameters | Type | Description |
|---|---|---|
|
| Type de chemin. Pour connaître les valeurs valides, consultez |
onAudioFileState
Rappel d'état de lecture d'un fichier audio.
Parameters | Type | Description |
|---|---|---|
|
| État de lecture du fichier. Pour plus d'informations, consultez |
onLocalAudioVolumeIndication
Rappel d'indication du volume de capture local. Pour l'activer, appelez enableLocalAudioVolumeIndication.
Parameters | Type | Description |
|---|---|---|
|
| Informations sur le volume local. Pour plus d'informations, consultez |
onVideoDeviceStateChanged
Rappel des modifications d'état des opérations de capture du périphérique vidéo.
Parameters | Type | Description |
|---|---|---|
|
| État du périphérique vidéo. Pour plus d'informations, consultez |
onDataMsg
Rappel de réception d'un message de données en temps réel.
Parameters | Type | Description |
|---|---|---|
|
| Message de données. Pour plus d'informations, consultez |
IAudioFrameObserver
Interface pour les rappels de données de trame audio, que l'appelant implémente par héritage. N'effectuez aucune opération longue dans les rappels, sous peine de provoquer des anomalies audio.
onCapturedAudioFrame
Rappel des données brutes capturées. Pour l'activer, appelez enableAudioFrameObserver et définissez audioSource = AoqAudioSourceCaptured. Vous pouvez configurer la fréquence d'échantillonnage et le nombre de canaux ; le mode lecture-écriture est pris en charge.
Parameters | Type | Description |
|---|---|---|
|
| Données audio brutes capturées. Pour plus d'informations, consultez |
onProcessCapturedAudioFrame
Rappel des données après traitement 3A. Pour l'activer, appelez enableAudioFrameObserver et définissez audioSource = AoqAudioSourceProcessCaptured. Vous pouvez configurer la fréquence d'échantillonnage et le nombre de canaux ; le mode lecture-écriture est pris en charge.
Parameters | Type | Description |
|---|---|---|
|
| Données audio brutes après traitement 3A. Pour plus d'informations, consultez |
onPublishAudioFrame
Rappel des données de publication. Pour l'activer, appelez enableAudioFrameObserver et définissez audioSource = AoqAudioSourcePublish. Vous pouvez configurer la fréquence d'échantillonnage et le nombre de canaux ; seul le mode lecture seule est pris en charge.
Parameters | Type | Description |
|---|---|---|
|
| Type de piste. Pour plus d'informations, consultez |
|
| Données audio brutes à publier. Pour plus d'informations, consultez |
onPlaybackAudioFrame
Rappel des données de lecture. Pour l'activer, appelez enableAudioFrameObserver et définissez audioSource = AoqAudioSourcePlayback. Vous pouvez configurer la fréquence d'échantillonnage et le nombre de canaux ; le mode lecture-écriture est pris en charge.
Parameters | Type | Description |
|---|---|---|
|
| Données audio brutes pour la lecture. Pour plus d'informations, consultez |
IVideoFrameObserver
Interface pour les rappels de données de trame vidéo, que l'appelant implémente par héritage. N'effectuez aucune opération longue dans les rappels, sous peine de provoquer des saccades vidéo. Une valeur de retour true indique que les données sont modifiées et doivent être réécrites dans le SDK. La réécriture n'est effective que pour le format I420. Une valeur de retour false indique un accès en lecture seule. Les données contenues dans frame ne sont valides que pendant le rappel. Pour les utiliser de manière asynchrone, effectuez vous-même une copie.
onCapturedVideoFrame
Rappel des données brutes locales après capture, avant prétraitement. Pour l'activer, appelez enableVideoFrameObserver et définissez videoSource = AoqVideoSourceCaptured.
Parameters | Type | Description |
|---|---|---|
|
| Données de trame vidéo capturée. Pour plus d'informations, consultez |
true indique que les données sont modifiées et doivent être réécrites dans le SDK ; false indique un accès en lecture seule.
onPreEncodeVideoFrame
Rappel des données brutes locales avant encodage, après prétraitement. Pour l'activer, appelez enableVideoFrameObserver et définissez videoSource = AoqVideoSourcePreEncode.
Parameters | Type | Description |
|---|---|---|
|
| Type de piste vidéo. Pour plus d'informations, consultez |
|
| Données de trame vidéo avant encodage. Pour plus d'informations, consultez |
true indique que les données sont modifiées et doivent être réécrites dans le SDK ; false indique un accès en lecture seule.
onRemoteVideoFrame
Rappel des données brutes distantes après décodage et avant rendu. Pour l'activer, appelez enableVideoFrameObserver et définissez videoSource = AoqVideoSourceRemote.
Parameters | Type | Description |
|---|---|---|
|
| Type de piste vidéo. Pour plus d'informations, consultez |
|
| Données de trame vidéo distante. Pour plus d'informations, consultez |
true indique que les données sont modifiées et doivent être réécrites dans le SDK ; false indique un accès en lecture seule.