Cette rubrique décrit les API C++, les rappels et les types de données du SDK Client AOQ pour Linux.
Index des API
Cycle de vie du moteur
API | Description |
|---|---|
createEngine | Créez l'instance du moteur (méthode statique, singleton) |
destroy | Détruisez l'instance du moteur (méthode statique) |
getVersion | Obtenez la version du SDK (méthode statique) |
connect | Connectez-vous au serveur relais |
disconnect | Déconnectez-vous du serveur |
Gestion des périphériques audio
API | Description |
|---|---|
startAudioCapture | Ouvrez le périphérique de capture audio (implémentation vide sous Linux) |
stopAudioCapture | Fermez le périphérique de capture audio (sans effet sous Linux) |
muteAudioCapture | Coupez ou rétablissez le son de la capture audio |
startAudioPlayer | Démarrez le rendu audio (implémentation vide sous Linux) |
stopAudioPlayer | Arrêtez le rendu audio (sans effet sous Linux) |
pauseAudioPlayer | Mettez en pause le rendu audio, avec prise en charge de l'atténuation progressive (fade-out) |
resumeAudioPlayer | Reprenez le rendu audio, avec prise en charge de l'augmentation progressive (fade-in) |
interruptAudioPlayer | Interrompez la lecture audio en cours |
Configuration du codec audio
API | Description |
|---|---|
setAudioEncoderConfig | Définissez les paramètres d'encodage audio |
setAudioDecoderConfig | Définissez les paramètres de décodage audio |
Gestion des périphériques vidéo
API | Description |
|---|---|
startVideoCapture | Ouvrez le périphérique de capture vidéo (seul le mode de capture externe est pris en charge sous Linux) |
stopVideoCapture | Fermez le périphérique de capture vidéo |
setLocalView | Définissez ou supprimez la fenêtre de rendu vidéo local (aucune implémentation de rendu sous Linux) |
setRemoteView | Définissez ou supprimez la fenêtre de rendu vidéo distant (aucune implémentation de rendu sous Linux) |
Codec vidéo et entrée externe
API | Description |
|---|---|
setVideoEncoderConfig | Définissez les paramètres d'encodage vidéo |
setVideoDecoderConfig | Définissez les paramètres de décodage vidéo (une proposition de codec côté abonné) |
pushExternalVideoCapturedFrame | Transmettez une image vidéo capturée en externe |
pushExternalVideoEncodedFrame | Transmettez une image vidéo encodée en externe |
Contrôle du flux multimédia
API | Description |
|---|---|
enableSendMediaStream | Activez ou désactivez l'envoi d'un flux multimédia local |
Lecture de fichiers audio
API | Description |
|---|---|
startAudioFile | Lancez la lecture d'un fichier audio local vers le flux de publication |
stopAudioFile | Arrêtez la lecture du fichier audio |
pauseAudioFile | Mettez en pause la lecture du fichier audio |
resumeAudioFile | Reprenez la lecture du fichier audio |
getAudioFileDuration | Récupérez la durée totale du fichier audio |
getAudioFileCurrentPosition | Récupérez la position de lecture actuelle du fichier audio |
setAudioFilePositionMillis | Définissez la position de lecture du fichier audio (recherche) |
setAudioFileVolume | Définissez le volume du fichier audio |
getAudioFileVolume | Récupérez le volume actuel du fichier audio |
Flux audio externes
API | Description |
|---|---|
addAudioExternalStream | Ajoutez un flux audio externe |
pushAudioExternalStreamData | Alimentez des données PCM audio externes |
setAudioExternalStreamVolume | Définissez le volume d'un flux audio externe |
getAudioExternalStreamVolume | Récupérez le volume d'un flux audio externe |
clearAudioExternalStreamBuffer | Videz le tampon d'un flux audio externe |
removeAudioExternalStream | Supprimez un flux audio externe |
Messagerie en temps réel
API | Description |
|---|---|
sendDataMsg | Envoie un message de données en temps réel |
Rappels de trames audio
API | Description |
|---|---|
setAudioFrameObserver | Enregistre l'écouteur de données de trame audio (purement virtuel) |
enableAudioFrameObserver | Active ou désactive le rappel de trame audio à une position spécifiée (purement virtuel) |
Indication du volume local
API | Description |
|---|---|
enableLocalAudioVolumeIndication | Active ou désactive le rappel d'indication du volume de capture local |
Rappels de trames vidéo
API | Description |
|---|---|
setVideoFrameObserver | Enregistre l'écouteur de données de trame vidéo (purement virtuel) |
enableVideoFrameObserver | Active ou désactive le rappel de trame vidéo à une position spécifiée (purement virtuel) |
Rappels AoqEngineEventListener
Rappel | Description |
|---|---|
onError | Rappel d'erreur du moteur |
onWarning | Rappel d'avertissement du moteur |
onConnectionStatusChange | Rappel de changement d'état de la connexion |
onStats | Rappel des statistiques du moteur |
onAudioDeviceStateChanged | Rappel de changement d'état de fonctionnement du périphérique audio |
onAudioDeviceRouteChanged | Rappel de changement de route de sortie audio (non déclenché sous Linux) |
onAudioFileState | Rappel d'état de lecture du fichier audio |
onLocalAudioVolumeIndication | Rappel d'indication du volume de capture local |
onVideoDeviceStateChanged | Rappel de changement d'état de fonctionnement du périphérique vidéo |
onDataMsg | Rappel pour un message de données en temps réel reçu |
Interfaces d'écouteur de données de trame
API | Description |
|---|---|
IAudioFrameObserver | Interface d'écoute des données de trame audio (quatre rappels purement virtuels) |
IVideoFrameObserver | Interface d'écoute des données de trame vidéo (trois rappels purement virtuels) |
Détails de l'API
Cycle de vie du moteur
createEngine
Créez l'instance du moteur. Le SDK conserve le moteur en tant que singleton global ; un nouvel appel à cette méthode renvoie donc l'instance existante.
Paramètres | Type | Description |
|---|---|---|
config | AoqCreateConfig | Configuration de création du moteur |
listener | AoqEngineEventListener\* | Écouteur de rappel d'événements du moteur, implémenté par héritage par l'appelant |
nullptr. La durée de vie de l'écouteur doit excéder celle du moteur.
destroy
Détruisez l'instance du moteur et libérez toutes les ressources associées.
0 indique une réussite ; toute valeur différente de 0 signale un échec.
getVersion
Récupérez la version actuelle du SDK.
connect
Établissez la connexion au serveur de relais. Le serveur d'application obtient les paramètres de connexion AOQ temporaires selon le protocole utilisé, puis les transmet au client. Pour plus d'informations, consultez Authentification par jeton.
Paramètres | Type | Description |
|---|---|---|
config | AoqConnectConfig | Configuration de la connexion, incluant le jeton, le SID, le tableau des points d'accès au relais ainsi que les tableaux des pistes de publication et d'abonnement |
0 indique une réussite et l'opération s'exécute de manière asynchrone ; toute valeur différente de 0 signale un échec. Le résultat de la connexion est notifié via onConnectionStatusChange.
relayEndpoints / publishTracks / subscribeTracks suivent toutes le format « pointeur de tableau de style C + longueur ». La mémoire est gérée par l'appelant et doit rester valide uniquement pendant l'appel à la méthode connect.disconnect
Interrompez la connexion au serveur et libérez les ressources qui y sont associées.
0 indique une réussite ; toute valeur différente de 0 signale un échec.
Gestion des périphériques audio
Paramètres | Type | Description |
|---|---|---|
config | AoqAudioCaptureConfig / AoqAudioPlaybackConfig | Configuration de la capture et de la lecture |
mute | bool | true pour couper le son ; false pour rétablir le son |
fadeMs | int | Durée du fondu sortant ou entrant, en millisecondes. La valeur 0 indique une exécution immédiate. |
trackType | AoqTrackType | Type de piste |
startAudioCapture / startAudioPlayer ont des implémentations vides dans la version Linux (elles retournent directement 0 sans ouvrir de périphérique de carte son), et stopAudioCapture / stopAudioPlayer n'ont aucun effet réel car l'état interne n'est pas défini. Sous Linux, utilisez des flux audio externes (2.8) pour l'entrée audio et exploitez les rappels de trames audio (2.10) pour gérer vous-même la sortie audio. Pour plus d'informations, consultez la section 4.3.Configuration du codec audio
connect(). Une combinaison invalide de la fréquence d'échantillonnage et du mode déclenche le rappel onError avec AoqECParamInvalid lors de la connexion.
Gestion des périphériques vidéo
Paramètres | Type | Description |
|---|---|---|
config | AoqVideoCaptureConfig | Configuration de la capture vidéo |
trackType | AoqTrackType | Type de piste vidéo |
canvas | AoqVideoCanvas | Zone de rendu. Si |
startVideoCapture({.isExternal = true}) combiné à pushExternalVideoCapturedFrame pour fournir les trames. Les méthodes setLocalView / setRemoteView ne disposent d'aucun backend de rendu sous Linux (AoqVideoCanvas.view prend uniquement en charge Apple NSView* / Windows HWND / les vues de rendu Android). Pour la prévisualisation, effectuez le rendu vous-même via le rappel de trame vidéo (2.12). Pour plus d'informations, consultez la section 4.3.Codec vidéo et entrée externe
Paramètres | Type | Description |
|---|---|---|
config | AoqVideoCodecConfig | Configuration du codec, routée en fonction de |
trackType | AoqTrackType | Cible de routage. Définissez-la sur |
frame | AoqVideoFrame / AoqVideoEncodedFrame | Données de trame brute ou encodée |
setVideoDecoderConfigconstitue une proposition de codec pour le côté abonné et doit être appelée avantconnect. Lors du décodage, seuls les paramètrestrackType/codecType/width/height/fps/bitratesont pris en compte.pushExternalVideoCapturedFramenécessite d'abord l'appel àstartVideoCapture(isExternal=true). Cette méthode renvoieAoqECVideoExternalCaptureNotEnabled(211)si la capture externe n'est pas démarrée,AoqECParamInvalidsi le format n'est pas pris en charge, etAoqECVideoExternalBufferFull(210)si le tampon est plein.pushExternalVideoEncodedFramenécessite d'abord l'appel àsetVideoEncoderConfig(isExternal=true). Le SDK emballe et envoie directement la trame sans réencodage. Seul le format JPEG est actuellement pris en charge.- Lorsque
frame.timeStampest égal à0, le SDK le remplit avec l'heure locale.
Contrôle des flux multimédias
trackType peut être AoqTrackTypeAudio ou AoqTrackTypeVideo. Une valeur de retour de 0 indique que l'appel est distribué et s'exécute de manière asynchrone. Nous vous recommandons de désactiver l'envoi après l'initialisation et de ne l'activer qu'une fois que onConnectionStatusChange signale AoqConnectionStatusConnected.
Lecture de fichiers audio
Paramètres | Type | Description |
|---|---|---|
fileId | const char\* | ID du fichier audio. La couche métier doit garantir l'unicité globale. |
config | AoqAudioFileMixConfig | Configuration du mixage de fichiers |
positionMillis | int64_t | Position de lecture cible, en millisecondes |
type | AoqAudioStreamDirection | Volume de publication ou volume de lecture locale |
volume | int | Volume. Valeurs valides : 0 à 100. |
getAudioFileDuration/getAudioFileCurrentPosition: une valeur>=0correspond à la valeur en millisecondes ; une valeur<0indique un échec, et sa valeur absolue correspond à-AoqErrorCode.getAudioFileVolume: une valeur comprise entre0-100représente le volume ; une valeur<0indique un échec, et sa valeur absolue correspond à-AoqErrorCode.
onAudioFileState. Le mixage de fichiers utilise le chemin de publication et ne dépend pas de la carte son locale. Par conséquent, sous Linux, vous pouvez l'utiliser pour pousser un fichier local comme source audio.
Flux audio externes
Paramètres | Type | Description |
|---|---|---|
streamId | const char\* | ID du flux audio externe. La couche métier doit garantir l'unicité globale. |
config | AoqAudioExternalStreamConfig | Configuration du flux audio externe |
data | AoqAudioFrameData | Données audio externes brutes (PCM), sous forme de référence non constante |
type | AoqAudioStreamDirection | Volume de publication ou volume de lecture locale |
vol | int | Volume. Valeurs valides : 0 à 100. |
fadeoutMs | int | Durée de l'atténuation progressive (fade-out). La valeur |
-
Lorsque
pushAudioExternalStreamDatarenvoieAoqECAudioExternalBufferFull(110), le tampon interne du SDK est plein. Nous vous recommandons d'attendre 20 ms, puis de renvoyer la trame de données actuelle. -
Meilleures pratiques : dans les scénarios de capture en temps réel, envoyez des blocs de données de 10 ms dès qu'ils sont disponibles. Pour les sources issues de fichiers, envoyez des blocs de 40 ms toutes les 30 ms et gérez la valeur de retour
AoqECAudioExternalBufferFull. -
getAudioExternalStreamVolume: une valeur comprise entre0-100correspond au volume ; une valeur<0indique un échec, dont la valeur absolue représente-AoqErrorCode. -
clearAudioExternalStreamBufferrenvoievoidet ne possède aucune valeur de retour. -
data.pushSequencesert à la notification d'achèvement de consommation par le SDK (cycle d'entrée PCM).Il n'existe aucun dispositif de capture réel sous Linux. Cet ensemble d'API constitue le principal chemin pour la liaison montante audio.
Messagerie en temps réel
msg.data pointe vers une mémoire détenue par l'appelant et doit rester valide uniquement pendant l'appel. Les messages provenant du pair sont signalés via le rappel onDataMsg.
Rappels de trames audio
Paramètres | Type | Description |
|---|---|---|
observer | IAudioFrameObserver\* | Instance d'écouteur. Transmettez |
enabled | bool | Indique s'il faut activez les rappels de données à cette position |
audioSource | AoqAudioSource | Position de la source de données audio brutes |
config | AoqAudioObserverConfig | Fréquence d'échantillonnage du rappel, nombre de canaux et mode lecture-écriture |
setAudioFrameObserver(observer) pour enregistrer l'écouteur. Ensuite, appelez enableAudioFrameObserver pour chaque position requise. Le cycle de vie de l'écouteur doit couvrir toute la période de rappel. Ne libérez l'écouteur qu'après l'avoir désenregistré.
Prise en charge du mode lecture-écriture (voir la déclaration IAudioFrameObserver) : onCapturedAudioFrame / onProcessCapturedAudioFrame / onPlaybackAudioFrame prennent en charge le mode lecture-écriture, tandis que onPublishAudioFrame ne prend en charge que le mode lecture seule.
setAudioFrameObserver effectue l'enregistrement par dispatch asynchrone (PostTask vers le thread de contrôle), de sorte que le rappel peut prendre effet légèrement après le retour de l'appel. Avant de libérer l'écouteur, laissez un intervalle de sécurité suffisant ou maintenez l'objet en vie.Indication du volume local
config.interval <= 0, le rappel est désactivé. Une fois activé, onLocalAudioVolumeIndication est déclenché à l'intervalle spécifié par config.interval. Vous devez appeler cette méthode après startAudioCapture pour obtenir les données de volume.
Rappels de trames vidéo
Paramètres | Type | Description |
|---|---|---|
observer | IVideoFrameObserver\* | Instance d'écouteur. Transmettez |
enabled | bool | Indique s'il faut activez les rappels de données à cette position |
videoSource | AoqVideoSource | Source de données du rappel de trame vidéo (position dans le pipeline) |
config | AoqVideoObserverConfig | Format de pixel attendu, politique d'alignement, mode lecture-écriture et mise en miroir |
true, les données sont modifiées et doivent être réécrites dans le SDK. Cela ne prend effet que pour I420 / CVPixelBuffer, ce qui signifie uniquement I420 sous Linux. Si le rappel renvoie false, les données sont en lecture seule.
AoqVideoSourceRemote).Rappels AoqEngineEventListener
AoqEngineEventListener constitue le point d'entrée unifié pour toutes les notifications d'événements asynchrones du SDK. Vous devez hériter de cette classe et l'implémenter, puis la transmettre lors de l'appel à createEngine.
= 0), sans implémentation vide par défaut. Sous Linux, vous devez implémenter intégralement les 10 méthodes suivantes ; sinon, la classe dérivée ne peut pas être instanciée. Les rappels peuvent être déclenchés sur des threads internes du SDK.onError
Rappel d'erreur du moteur. Le paramètre code correspond à une valeur de l'énumération AoqErrorCode (voir la section 3.3), tandis que message n'est valide que pendant l'exécution du rappel.
onWarning
Rappel d'avertissement du moteur. Le paramètre code correspond à une valeur de l'énumération AoqWarningCode (voir la section 3.3).
onConnectionStatusChange
Rappel de changement d'état de la connexion. Transitions d'état possibles : Déconnecté -> Connexion en cours -> Connecté / Échec -> Déconnecté.
onStats
Rappel des statistiques du moteur. Le SDK rapporte périodiquement les statistiques de publication et d'abonnement pour l'audio et la vidéo, ainsi que les statistiques réseau. Ces données permettent de surveiller en temps réel la qualité des appels et l'état du réseau, et de diagnostiquer les problèmes audio et vidéo.
Paramètres | Type | Description |
|---|---|---|
stats | AoqStats | Statistiques de publication et d'abonnement, ainsi que statistiques réseau pour l'audio, la vidéo et les messages de données |
AoqStats utilise en interne un modèle « pointeur de tableau + compteur ». Le pointeur n'est valide que durant l'exécution du rappel ; vous devez donc copier les données vous-même si vous souhaitez les utiliser de manière asynchrone.onAudioDeviceStateChanged
Rappel indiquant les changements d'état des opérations de capture et de lecture des périphériques audio. La valeur state.reason correspond à une valeur AoqErrorCode.
onAudioDeviceRouteChanged
Rappel de changement de route de sortie audio. Le paramètre routeType correspond à une valeur de l'énumération AoqAudioDeviceRouteType (voir la section 3.4).
AOQ_HAS_NATIVE_DEVICE_MONITOR est défini uniquement sous Windows et macOS), et les périphériques audio côté serveur ne génèrent pas d'événements de changement de route. Vous devez néanmoins implémenter cette méthode (virtuelle pure), mais l'implémentation peut rester vide.onAudioFileState
Rappel indiquant l'état de lecture des fichiers audio. La valeur state.fileId n'est valide que pendant l'exécution du rappel.
onLocalAudioVolumeIndication
Rappel d'indication du volume de capture local. Pour l'activer, appelez enableLocalAudioVolumeIndication.
onVideoDeviceStateChanged
Rappel indiquant les changements d'état des opérations de capture des périphériques vidéo. La valeur state.reason correspond à une valeur AoqErrorCode.
onDataMsg
Rappel de réception d'un message de données en temps réel. Le champ msg.data n'est garanti valide que pendant l'exécution du rappel. Si vous devez l'utiliser de manière asynchrone, effectuez vous-même une copie des données.
Interfaces d'écoute des données de trame
IAudioFrameObserver
Interface dédiée à l'écoute des données audio. Évitez toute opération longue dans les rappels, sous peine de provoquer des anomalies audio. Toutes les méthodes sont des fonctions virtuelles pures et doivent être intégralement implémentées.
Callback | How to enable it (audioSource) | Read-write mode |
|---|---|---|
onCapturedAudioFrame | AoqAudioSourceCaptured | Read-write supported |
onProcessCapturedAudioFrame | AoqAudioSourceProcessCaptured | Read-write supported |
onPublishAudioFrame | AoqAudioSourcePublish (requires a successful connect) | Only read-only is supported |
onPlaybackAudioFrame | AoqAudioSourcePlayback | Read-write supported |
AoqAudioObserverConfig.
onPlaybackAudioFrame constitue le principal chemin d'accès pour obtenir le flux PCM descendant distant. Étant donné que le module 3A n'est pas compilé sur Linux, les données issues de onProcessCapturedAudioFrame (données après traitement 3A) sont essentiellement identiques aux données brutes capturées. Pour plus d'informations, consultez la section 4.3.IVideoFrameObserver
Interface dédiée à l'écoute des données vidéo. Évitez toute opération longue dans les rappels, sous peine de provoquer des saccades vidéo. Toutes les méthodes sont des fonctions virtuelles pures.
Callback | How to enable it (videoSource) | description |
|---|---|---|
onCapturedVideoFrame | AoqVideoSourceCaptured | Données brutes locales après capture, avant prétraitement |
onPreEncodeVideoFrame | AoqVideoSourcePreEncode | Données brutes locales avant encodage, après prétraitement |
onRemoteVideoFrame | AoqVideoSourceRemote | Données brutes distantes après décodage et avant rendu |
true indique que les données ont été modifiées et doivent être réécrites dans le SDK ; cette option n'est effective que pour les formats I420 / CVPixelBuffer. false signifie un accès en lecture seule. Les pointeurs contenus dans frame ne sont valides que durant l'exécution du rappel. Pour une utilisation asynchrone, effectuez vous-même une copie des données.
Types de données et énumérations
Tous les types sont définis dans le fichier AoqClientEngine.h au sein du namespace AoqClientSdk . Toutes les structures sont des types POD (Plain Old Data) dotés de valeurs par défaut ; il suffit donc de les déclarer pour obtenir les valeurs indiquées dans le tableau. Les champs marqués comme réservés aux appareils mobiles sont exclus par compilation conditionnelle sous Linux et n'existent pas dans les structures.
Types généraux
AoqCreateConfig
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
workDir | const char\* | nullptr | Répertoire de travail du SDK (pour les journaux et les fichiers temporaires) |
enableDumpAudio | bool | false | Indique s'il faut enregistrer les données audio (à des fins de débogage) |
extras | const char\* | nullptr | Paramètres étendus (chaîne JSON) |
createEngine . Le moteur effectue une copie interne de ces données si nécessaire. Le champ isBTScoMode sur Android est réservé aux appareils mobiles et n'existe pas sous Linux.AoqConnectConfig
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
token | const char\* | nullptr | Jeton d'authentification de la connexion |
sid | const char\* | nullptr | ID de session |
certFingerprint | const char\* | nullptr | Empreinte du certificat serveur |
workspaceIdHash | const char\* | nullptr | Hachage de l'ID d'espace de travail |
relayEndpoints | const AoqRelayEndpoint\* | nullptr | Adresse de début du tableau des points d'accès relais |
relayEndpointsCount | size_t | 0 | Nombre de points d'accès relais |
publishTracks | const AoqTrackParam\* | nullptr | Adresse de début du tableau des attributs des pistes de publication |
publishTracksCount | size_t | 0 | Nombre de pistes de publication |
subscribeTracks | const AoqTrackParam\* | nullptr | Adresse de début du tableau des attributs des pistes d'abonnement |
subscribeTracksCount | size_t | 0 | Nombre de pistes d'abonnement |
AoqRelayEndpoint
Field | Type | Default value | Description |
|---|---|---|---|
route_index | int | -1 | Index de la route |
endpoint | const char\* | nullptr | Nom de domaine ou adresse IP du serveur relais |
port | int | 0 | Port du serveur relais |
route_index utilise la notation snake_case, contrairement aux autres champs qui utilisent la notation camelCase.AoqTrackParam
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeAudio | Type de piste |
trackMode | AoqTrackMode | AoqTrackModeSegment | Mode de streaming ou non-streaming. Ce paramètre n'est effectif que pour la liaison descendante audio. |
AoqDataMsg
Field | Type | Default value | Description |
|---|---|---|---|
data | const uint8_t\* | nullptr | Contenu du message. Ce pointeur fait référence à une zone mémoire gérée par l'appelant. |
dataSize | size_t | 0 | Nombre d'octets |
Types de statistiques
AoqStats
Résumé des statistiques du moteur, rapporté périodiquement via onStats. Cette structure repose sur un pointeur de tableau et un compteur. Par défaut, tous les pointeurs sont définis sur nullptr et tous les compteurs sur 0.
Field | Type | Description |
|---|---|---|
audioPublishStats | const AoqAudioPublishStats\* | Tableau des statistiques de publication audio |
audioPublishStatsCount | unsigned int | Nombre d'entrées de statistiques de publication audio |
videoPublishStats | const AoqVideoPublishStats\* | Tableau des statistiques de publication vidéo |
videoPublishStatsCount | unsigned int | Nombre d'entrées de statistiques de publication vidéo |
dataMsgPublishStats | const AoqDataMsgPublishStats\* | Tableau des statistiques de publication des messages de données |
dataMsgPublishStatsCount | unsigned int | Nombre d'entrées de statistiques de publication des messages de données |
audioSubscribeStats | const AoqAudioSubscribeStats\* | Tableau des statistiques d'abonnement audio |
audioSubscribeStatsCount | unsigned int | Nombre d'entrées de statistiques d'abonnement audio |
videoSubscribeStats | const AoqVideoSubscribeStats\* | Tableau des statistiques d'abonnement vidéo |
videoSubscribeStatsCount | unsigned int | Nombre d'entrées de statistiques d'abonnement vidéo |
dataMsgSubscribeStats | const AoqDataMsgSubscribeStats\* | Tableau des statistiques d'abonnement aux messages de données |
dataMsgSubscribeStatsCount | unsigned int | Nombre d'entrées de statistiques d'abonnement aux messages de données |
networkStats | const AoqNetworkStats\* | Statistiques réseau |
AoqAudioPublishStats
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeAudio | Type de piste |
bitrate | unsigned int | 0 | Débit binaire, en bit/s |
bytes | uint64_t | 0 | Nombre cumulé d'octets envoyés |
encodeVolume | unsigned int | 0 | Volume d'encodage du flux de publication |
AoqAudioSubscribeStats
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeAudio | Type de piste |
bitrate | unsigned int | 0 | Débit binaire, en bit/s |
bytes | uint64_t | 0 | Nombre cumulé d'octets reçus |
playVolume | unsigned int | 0 | Volume de lecture |
AoqVideoPublishStats
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeVideo | Type de piste |
bitrate | unsigned int | 0 | Débit binaire, en bit/s |
bytes | uint64_t | 0 | Nombre cumulé d'octets envoyés |
encodeFps | unsigned int | 0 | Fréquence d'images d'encodage |
AoqVideoSubscribeStats
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeVideo | Type de piste |
bitrate | unsigned int | 0 | Débit binaire, en bit/s |
bytes | uint64_t | 0 | Nombre cumulé d'octets reçus |
decodeFps | unsigned int | 0 | Fréquence d'images de décodage |
renderFps | unsigned int | 0 | Fréquence d'images de rendu |
AoqDataMsgPublishStats / AoqDataMsgSubscribeStats
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeData | Type de piste |
bitrate | unsigned int | 0 | Débit binaire, en bit/s |
bytes | uint64_t | 0 | Nombre cumulé d'octets envoyés et reçus |
AoqNetworkStats
Field | Type | Default value | Description |
|---|---|---|---|
sendBitrate | unsigned int | 0 | Débit binaire d'envoi, en bit/s |
sendBytes | uint64_t | 0 | Nombre cumulé d'octets envoyés |
recvBitrate | unsigned int | 0 | Débit binaire de réception, en bit/s |
recvBytes | uint64_t | 0 | Nombre cumulé d'octets reçus |
loss | unsigned int | 0 | Taux de perte de paquets, de 0 à 100 |
rtt | unsigned int | 0 | Latence aller-retour, en ms |
Enumerations
AoqTrackType
Enum value | Value | Description |
|---|---|---|
AoqTrackTypeAudio | 0 | Piste audio |
AoqTrackTypeVideo | 1 | Piste vidéo |
AoqTrackTypeData | 2 | Piste de messages de données |
AoqTrackMode
Enum value | Value | Description |
|---|---|---|
AoqTrackModeSegment | 0 | Segmenté : les données sont encapsulées et livrées par segments sémantiques, tels qu'une phrase. |
AoqTrackModeStream | 1 | En continu : les données sont livrées de manière continue. |
AoqEncoderType
Valeur d'énumération | Valeur | description |
|---|---|---|
AoqEncoderTypeUnknown | 0 | format inconnu |
AoqEncoderTypeAudioPCM | 1 | Audio PCM |
AoqEncoderTypeAudioOpus | 2 | Audio Opus (basé sur un plug-in ; intégré statiquement dans Linux et disponible dès l'installation) |
AoqEncoderTypeVideoH264 | 3 | Vidéo H.264 |
AoqEncoderTypeVideoJpeg | 4 | Vidéo JPEG |
AoqEncoderTypeDataText | 5 | Texte du message |
AoqConnectionStatus
Valeur d'énumération | Valeur | description |
|---|---|---|
AoqConnectionStatusDisconnected | 0 | Déconnecté |
AoqConnectionStatusConnecting | 1 | Connexion en cours |
AoqConnectionStatusConnected | 2 | Connecté |
AoqConnectionStatusFailed | 3 | Échec de la connexion |
AoqErrorCode
AoqEC* (contrairement à la forme complète AoqErrorCode* sur Android), mais les valeurs sont identiques.Valeur enum | Valeur | description |
|---|---|---|
AoqECOK | 0 | Succès |
AoqECParamInvalid | 1 | Paramètre non valide |
AoqECStateInvalid | 2 | État non valide |
AoqECUnSupport | 3 | L'API est appelée, mais n'est pas implémentée sur la plateforme actuelle ou dans le mode actuel |
AoqECAudio | 100 | Erreur audio générique |
AoqECAudioExternalBufferFull | 110 | Le tampon audio externe est plein |
AoqECAudioDevice | 120 | Erreur générique du périphérique audio |
AoqECAudioDeviceRecordingAuthFailed | 121 | Autorisation d'enregistrement non accordée |
AoqECAudioDeviceRecordingOccupied | 122 | Le périphérique d'enregistrement est utilisé |
AoqECAudioDeviceRecordingBackgroundStart | 123 | Échec du démarrage de l'enregistrement en arrière-plan |
AoqECAudioDeviceRecordingStartFail | 124 | Échec du démarrage de l'enregistrement |
AoqECAudioDevicePlayoutOccupied | 125 | Le périphérique de lecture est utilisé |
AoqECAudioDevicePlayoutBackgroundStart | 126 | Échec du démarrage de la lecture en arrière-plan |
AoqECAudioDevicePlayoutStartFail | 127 | Échec du démarrage de la lecture |
AoqECAudioDeviceEarpieceRequiresVoipMode | 128 | L'écouteur nécessite le mode VoIP (scénarios mobiles) |
AoqECVideo | 200 | Erreur vidéo générique |
AoqECVideoExternalBufferFull | 210 | Le tampon vidéo externe est plein |
AoqECVideoExternalCaptureNotEnabled | 211 | La capture vidéo externe n'est pas activée |
AoqECVideoExternalEncoderNotEnabled | 212 | L'encodage vidéo externe n'est pas activé |
AoqECVideoDevice | 220 | Erreur générique du périphérique vidéo |
AoqECVideoDeviceCameraOpenFail | 221 | Échec de l'ouverture de la caméra |
AoqECVideoDeviceCameraAuthFailed | 222 | Autorisation d'accès à la caméra non accordée |
AoqECVideoDeviceCameraOccupied | 223 | La caméra est utilisée |
AoqECVideoDeviceCameraRunningError | 224 | Exception d'exécution de la caméra |
AoqECVideoCodec | 230 | Erreur générique du codec vidéo |
AoqECVideoCodecEncoderInitFail | 231 | Échec de l'initialisation de l'encodeur vidéo |
AoqECVideoRender | 240 | Erreur générique de rendu vidéo |
AoqECVideoRenderCreateFail | 241 | Échec de la création du rendu vidéo |
AoqECVideoRenderDrawError | 242 | Erreur de dessin lors du rendu vidéo |
AoqWarningCode
Enum value | Value | Description |
|---|---|---|
AoqWCOK | 0 | Aucun avertissement |
AoqWCAudio | 100 | Avertissement audio générique |
AoqWCAudioHowling | 101 | Détection d'effet Larsen audio |
AoqWCAudioDevice | 120 | Avertissement générique lié au périphérique audio |
AoqWCAudioDeviceMicEnumerateError | 121 | Erreur d'énumération du microphone |
AoqWCAudioDeviceMicStartTimeout | 122 | Délai d'attente dépassé lors du démarrage du microphone |
AoqWCAudioDeviceRecordingError | 123 | Erreur pendant l'enregistrement |
AoqWCAudioDeviceSpeakerEnumerateError | 124 | Erreur d'énumération des haut-parleurs |
AoqWCAudioDeviceSpeakerStartTimeout | 125 | Délai d'attente dépassé lors du démarrage des haut-parleurs |
AoqWCAudioDevicePlayoutError | 126 | Erreur pendant la lecture |
AoqWCVideo | 200 | Avertissement vidéo générique |
AoqWCVideoCameraEnumerateError | 201 | Erreur d'énumération de la caméra |
AoqWCVideoEncoderSwitched | 202 | Changement de l'encodeur vidéo |
AoqWCVideoRenderDowngrade | 203 | Rétrogradation du rendu vidéo |
AoqMirrorMode
Enum value | Value | Description |
|---|---|---|
AoqMirrorModeDisabled | 0 | Désactiver le mode miroir |
AoqMirrorModeEnabled | 1 | Activez le mode miroir |
AoqOrientationMode
Enum value | Value | Description |
|---|---|---|
AoqOrientationModeAuto | 0 | Ajustement automatique |
AoqOrientationModePortrait | 1 | Portrait |
AoqOrientationModeLandscape | 2 | Paysage |
AoqRenderMode
Enum value | Value | Description |
|---|---|---|
AoqRenderModeAuto | 0 | Mode adaptatif |
AoqRenderModeStretch | 1 | Mode étiré |
AoqRenderModeFill | 2 | Mode de remplissage |
AoqRenderModeCrop | 3 | Mode de recadrage |
AoqVideoCanvas.renderMode. Linux ne disposant d'aucune implémentation de rendu, cette énumération n'a aucun effet concret.AoqAudioStreamDirection
Enum value | Value | Description |
|---|---|---|
AoqAudioStreamPublish | 0 | Publication audio |
AoqAudioStreamPlayout | 1 | Lecture audio |
AoqAudioExternalStreamToggle
Enum value | Value | Description |
|---|---|---|
AoqAudioExternalStreamToggleNormal | 0 | Récupéré |
AoqAudioExternalStreamTogglePause | 1 | En pause |
Types audio
AoqAudioCaptureConfig
Field | Type | Default value | Description |
|---|---|---|---|
isExternal | bool | false | Indique s'il faut utiliser la capture externe |
channel | int | 1 | Nombre de canaux de capture audio. Les valeurs 1 et 2 sont prises en charge. |
isVoipMode est spécifique aux appareils mobiles et n'existe pas sous Linux.AoqAudioPlaybackConfig
Field | Type | Default value | Description |
|---|---|---|---|
isExternal | bool | false | Indique s'il faut utiliser la lecture externe |
channel | int | 1 | Nombre de canaux de lecture audio. Les valeurs 1 et 2 sont prises en charge. |
isVoipMode et isDefaultSpeaker sont réservés aux appareils mobiles et n'existent pas sous Linux.AoqAudioCodecConfig
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeAudio | Type de piste |
codecType | AoqEncoderType | AoqEncoderTypeAudioPCM | Type d'encodage |
sampleRate | int | 48000 | Fréquence d'échantillonnage, en Hz |
channel | int | 1 | Nombre de canaux. Les valeurs 1 et 2 sont prises en charge. |
bitrate | int | 32000 | Débit binaire, en bit/s |
- Encodage : Opus prend en charge les fréquences 8 / 16 / 48 kHz, tandis que PCM prend en charge les fréquences 8 / 16 / 32 / 48 kHz ;
- Décodage : la fréquence 24 kHz est également prise en charge, mais elle est limitée au mode Segment (le mode Stream ne prend pas en charge 24 kHz) ;
- Une combinaison invalide déclenche le rappel
onErroravec le codeAoqECParamInvalidlors de l'appel àconnect.
AoqAudioDeviceRouteType
Enum value | Value | Description |
|---|---|---|
AoqAudioDeviceRouteDefault | 0 | Routage par défaut |
AoqAudioDeviceRouteHeadset | 1 | Casque avec microphone |
AoqAudioDeviceRouteEarpiece | 2 | Écouteur téléphonique |
AoqAudioDeviceRouteHeadsetNoMic | 3 | Casque sans microphone |
AoqAudioDeviceRouteSpeakerPhone | 4 | Haut-parleur intégré |
AoqAudioDeviceRouteUsb | 5 | Périphérique audio USB |
AoqAudioDeviceRouteBluetooth | 6 | Bluetooth |
AoqAudioDeviceRouteBluetoothA2dp | 7 | Bluetooth A2DP |
routeType du rappel onAudioDeviceRouteChanged. Sous Linux, ce rappel n'est pas déclenché.AoqAudioDeviceStateCode
Enum value | Value | Description |
|---|---|---|
AoqAudioDeviceNone | 0 | Aucun état |
AoqAudioDeviceRecordStarting | 1 | Démarrage de la capture |
AoqAudioDeviceRecordStarted | 2 | Capture démarrée |
AoqAudioDeviceRecordStopping | 3 | Arrêt de la capture |
AoqAudioDeviceRecordStopped | 4 | Capture arrêtée |
AoqAudioDeviceRecordFail | 5 | Échec de la capture |
AoqAudioDevicePlayStarting | 6 | Démarrage de la lecture |
AoqAudioDevicePlayStarted | 7 | Lecture démarrée |
AoqAudioDevicePlayStopping | 8 | Arrêt de la lecture |
AoqAudioDevicePlayStopped | 9 | Lecture arrêtée |
AoqAudioDevicePlayFail | 10 | Échec de la lecture |
AoqAudioDeviceState
Field | Type | Default value | Description |
|---|---|---|---|
state | AoqAudioDeviceStateCode | AoqAudioDeviceNone | État de fonctionnement du périphérique |
reason | int | 0 | Code d'erreur. Voir AoqErrorCode. |
AoqAudioFrameData
Données audio brutes. Elles sont utilisées à la fois pour l'alimentation externe des flux via pushAudioExternalStreamData et le rappel IAudioFrameObserver.
Field | Type | Default value | Description |
|---|---|---|---|
dataPtr | void\* | 0 | Pointeur vers les données PCM audio |
numOfSamples | int | 0 | Nombre d'échantillons (par canal) |
bytesPerSample | int | 0 | Octets par échantillon |
numOfChannels | int | 0 | Nombre de canaux |
samplesPerSec | int | 0 | Nombre d'échantillons par seconde (taux d'échantillonnage) |
pushSequence | int | 0 | Tour d'entrée PCM (utilisé pour la notification de fin de consommation du flux) |
timeStamp | int64_t | 0 | Horodatage |
dataSize | int | 0 | Longueur des données, en octets |
autoGenMute | bool | false | Efficace uniquement dans les rappels. La valeur true indique des données silencieuses générées par le SDK. |
AoqAudioSource
Enum value | Value | Description |
|---|---|---|
AoqAudioSourceCaptured | 0 | Données audio capturées |
AoqAudioSourceProcessCaptured | 1 | Données audio après traitement 3A |
AoqAudioSourcePublish | 2 | Données audio à publier (nécessite une connexion réussie) |
AoqAudioSourcePlayback | 3 | Données audio à lire |
AoqAudioSourceMax | 4 | Espace réservé, ne pas utiliser |
AoqAudioObserverMode
Enum value | Value | Description |
|---|---|---|
AoqAudioObserverModeReadOnly | 0 | Mode lecture seule |
AoqAudioObserverModeReadWrite | 1 | Mode lecture-écriture |
AoqAudioObserverConfig
Field | Type | Default value | Description |
|---|---|---|---|
sampleRate | int | 48000 | Fréquence d'échantillonnage de l'audio du rappel, en Hz. Un rééchantillonnage est effectué si la fréquence ne correspond pas à celle de la source. |
channels | int | 1 | 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 du codec du flux d'abonnement. |
mode | AoqAudioObserverMode | AoqAudioObserverModeReadOnly | Mode de rappel |
AoqAudioVolumeIndicationConfig
Field | Type | Default value | Description |
|---|---|---|---|
interval | int | 0 | Intervalle de rappel, en millisecondes. 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. |
smooth | int | 3 | Coefficient de lissage du volume. Une valeur plus élevée produit une sortie plus lisse. Valeurs valides : 0 à 10. |
AoqAudioVolume
Field | Type | Default value | Description |
|---|---|---|---|
volume | int | 0 | Volume instantané lissé. Valeurs valides : 0 à 255. |
Types de fichiers audio et de flux audio externes
AoqAudioFileMixConfig
Field | Type | Default value | Description |
|---|---|---|---|
fileName | const char\* | nullptr | Nom du fichier (incluant le chemin) |
cycles | int | -1 | Nombre de boucles. La valeur -1 indique une lecture en boucle illimitée. |
startPosMs | long | 0 | Position de départ de la lecture, en millisecondes |
publishVolume | int | 100 | Volume de publication. Valeurs valides : 0 à 100. |
playoutVolume | int | 100 | Volume de lecture. Valeurs valides : 0 à 100. |
fileId ne fait pas partie du corps de la configuration et est transmis en tant que paramètre distinct à startAudioFile.AoqAudioFileStateCode
Enum value | Value | Description |
|---|---|---|
AoqAudioFileNone | 0 | Aucun état |
AoqAudioFileStarted | 1 | Démarré |
AoqAudioFileStopped | 2 | Arrêté |
AoqAudioFilePaused | 3 | En pause |
AoqAudioFileResumed | 4 | Repris |
AoqAudioFileEnded | 5 | Lecture terminée |
AoqAudioFileBuffering | 6 | Mise en mémoire tampon |
AoqAudioFileBufferingEnd | 7 | Fin de la mise en mémoire tampon |
AoqAudioFileFailed | 8 | Échec de la lecture |
AoqAudioFileErrorCode
Enum value | Value | Description |
|---|---|---|
AoqAudioFileNoError | 0 | Aucune erreur |
AoqAudioFileOpenFailed | 1 | Échec de l'ouverture du fichier |
AoqAudioFileDecodeFailed | 2 | Échec du décodage du fichier |
AoqAudioFileState
Field | Type | Default value | Description |
|---|---|---|---|
fileId | const char\* | nullptr | ID du fichier. Valide uniquement pendant le rappel. |
stateCode | AoqAudioFileStateCode | AoqAudioFileNone | Code d'état du fichier |
errorCode | AoqAudioFileErrorCode | AoqAudioFileNoError | Code d'erreur du fichier |
AoqAudioExternalStreamConfig
Field | Type | Default value | Description |
|---|---|---|---|
trackType | AoqTrackType | AoqTrackTypeAudio | Type de piste audio |
codecType | AoqEncoderType | AoqEncoderTypeAudioPCM | Format du flux audio. Le format PCM est pris en charge. |
channels | int | 1 | Nombre de canaux. Cette valeur est limitée par le codec audio du flux de publication (les valeurs 1 et 2 sont prises en charge, les canaux supplémentaires sont ignorés). |
sampleRate | int | 48000 | Fréquence d'échantillonnage, en Hz |
playoutVolume | int | 100 | Volume de lecture. Valeurs valides : de 0 à 100. |
publishVolume | int | 100 | Volume de publication. Valeurs valides : de 0 à 100. |
maxBufferDuration | int | 600000 | Durée maximale de la mémoire tampon, en millisecondes (soit 10 minutes). Valeurs valides : 100 et plus. Si la durée dépasse cette valeur, l'opération Push échoue. |
enable3A | bool | false | Applique le traitement 3A au flux PCM d'entrée (ne prend pas effet sur Linux, voir 4,3) |
streamId ne fait pas partie du corps de configuration et est transmis en tant que paramètre distinct à addAudioExternalStream.Types vidéo
AoqVideoCanvas
Field | Type | Default value | Description |
|---|---|---|---|
view | void\* | nullptr | Pointeur opaque vers le handle de vue natif de la plateforme. Transmettez nullptr pour supprimer la liaison. |
renderMode | AoqRenderMode | AoqRenderModeAuto | Mode de remplissage du rendu |
view selon la plateforme : NSView* sur Apple, HWND sur Windows et objet adaptateur de vue de rendu interne du SDK sur Android. Vous devez vous assurer que le cycle de vie de view est plus long que la période durant laquelle il est défini par setLocalView / setRemoteView.
AoqVideoCaptureConfig
Field | Type | Default value | Description |
|---|---|---|---|
width | int | 1280 | Largeur de capture, en pixels. Ce paramètre est inefficace lorsque isExternal=true. |
height | int | 720 | Hauteur de capture, en pixels. Ce paramètre est inefficace lorsque isExternal=true. |
fps | int | 15 | Taux de rafraîchissement de la capture. Ce paramètre est inefficace lorsque isExternal=true (le rythme est déterminé par la livraison des images). |
isExternal | bool | false | Indique s'il faut utiliser une capture externe. Si la valeur est true, la caméra n'est pas ouverte et les images sont fournies par pushExternalVideoCapturedFrame. |
cameraDirection est un champ réservé aux appareils mobiles et n'existe pas sur les plateformes de bureau (y compris Linux). Sous Linux, nous vous recommandons de toujours définir isExternal = true.AoqVideoCodecConfig
L'encodage et le décodage partagent la même structure. Pour le décodage, seuls les champs trackType / codecType / width / height / fps / bitrate sont pris en compte et participent à la négociation en tant que proposition d'abonnement. Les paramètres minBitrate / keyframeInterval / mirrorMode / orientationMode / isExternal sont exclusivement utilisés pour l'encodage.
Field | Type | Default value | Description |
|---|---|---|---|
isExternal | bool | false | Mode d'encodage externe. Lorsqu'il est défini sur true, vous poussez les images encodées et le SDK n'effectue ni capture ni encodage. |
trackType | AoqTrackType | AoqTrackTypeVideo | Type de piste |
codecType | AoqEncoderType | AoqEncoderTypeVideoH264 | Type d'encodage |
width | int | 540 | Largeur de la résolution, en pixels |
height | int | 960 | Hauteur de la résolution, en pixels |
fps | int | 5 | Taux de rafraîchissement (images par seconde) |
bitrate | int | 500000 | Débit binaire initial, en bit/s |
minBitrate | int | 128000 | Débit binaire minimal, en bit/s |
keyframeInterval | int | 2 | Intervalle entre les images clés, en secondes |
mirrorMode | AoqMirrorMode | AoqMirrorModeDisabled | Mode miroir |
orientationMode | AoqOrientationMode | AoqOrientationModeAuto | Mode d'orientation |
AoqVideoPixelFormat
Valeur d'énumération | Valeur | Description | Prise en charge sous Linux |
|---|---|---|---|
AoqVideoPixelFormatUnknown | 0 | Format inconnu | - |
AoqVideoPixelFormatI420 | 1 | I420 (format planaire YUV) | Pris en charge |
AoqVideoPixelFormatNV12 | 2 | NV12 (format semi-planaire YUV) | Pris en charge |
AoqVideoPixelFormatNV21 | 3 | NV21 (format semi-planaire YUV) | Pris en charge |
AoqVideoPixelFormatBGRA | 4 | BGRA (32 bits) | Pris en charge |
AoqVideoPixelFormatRGBA | 5 | RGBA (32 bits) | Pris en charge |
AoqVideoPixelFormatCVPixelBuffer | 6 | Efficace uniquement sur les plateformes Apple | Non pris en charge |
AoqVideoPixelFormatTextureOES | 7 | Texture OES externe Android | Non pris en charge |
AoqVideoPixelFormatTexture2D | 8 | Texture 2D standard Android | Non pris en charge |
AoqVideoFrame
Trame vidéo brute externe. Elle est utilisée à la fois par la méthode pushExternalVideoCapturedFrame et le rappel IVideoFrameObserver.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
format | AoqVideoPixelFormat | AoqVideoPixelFormatUnknown | Format de pixel |
width | int | 0 | Largeur, en pixels |
height | int | 0 | Hauteur, en pixels |
dataPtr | void\* | 0 | Données au format packé (NV12 / NV21 / BGRA / RGBA) |
dataSize | int | 0 | Nombre d'octets des données packées |
dataY | void\* | 0 | Plan Y I420 |
dataU | void\* | 0 | Plan U I420 |
dataV | void\* | 0 | Plan V I420 |
strideY | int | 0 | Pas du plan Y |
strideU | int | 0 | Pas du plan U |
strideV | int | 0 | Pas du plan V |
nativePixelBuffer | void\* | 0 | Utilisé pour la copie zéro Apple (CVPixelBufferRef). Ce champ n'est pas utilisé sous Linux. |
textureId | int | 0 | ID de texture Android. Ce champ n'est pas utilisé sous Linux. |
transformMatrix | float array (16 elements) | All zeros | Matrice de transformation de texture (4x4 en ordre ligne majeure). Ce champ n'est pas utilisé sous Linux. |
timeStamp | int64_t | 0 | Horodatage, en millisecondes. S'il est défini sur 0, le SDK le remplit avec l'heure locale. |
AoqVideoCodecType
Valeur d'énumération | Valeur | Description |
|---|---|---|
AoqVideoCodecTypeJPEG | 0 | Encodage JPEG |
AoqVideoEncodedFrame
Trame vidéo encodée en externe. L'appelant effectue l'encodage et le SDK emballe et transmet directement la trame sans ré-encodage.
Field | Type | Default value | Description |
|---|---|---|---|
codec | AoqVideoCodecType | AoqVideoCodecTypeJPEG | Format de codec |
data | void\* | nullptr | Pointeur vers les données encodées |
dataSize | int | 0 | Nombre d'octets des données encodées |
width | int | 0 | Largeur, en pixels |
height | int | 0 | Hauteur, en pixels |
timeStamp | int64_t | 0 | Horodatage, en millisecondes. Si la valeur est 0, le SDK la renseigne avec l'heure locale. |
AoqVideoDeviceStateCode
Enum value | Value | Description |
|---|---|---|
AoqVideoDeviceNone | 0 | Aucun état |
AoqVideoDeviceCaptureStarting | 1 | Démarrage de la caméra |
AoqVideoDeviceCaptureStarted | 2 | Caméra démarrée |
AoqVideoDeviceCaptureStopping | 3 | Arrêt de la caméra |
AoqVideoDeviceCaptureStopped | 4 | Caméra arrêtée |
AoqVideoDeviceCaptureFail | 5 | Échec du démarrage de la caméra (par exemple, autorisation refusée ou périphérique indisponible) |
AoqVideoDeviceState
Field | Type | Default value | Description |
|---|---|---|---|
state | AoqVideoDeviceStateCode | AoqVideoDeviceNone | État de l'opération de capture du périphérique |
reason | int | 0 | Code de la raison de l'erreur. Consultez AoqErrorCode. |
AoqVideoSource
Valeur d'énumération | Valeur | Description |
|---|---|---|
AoqVideoSourceCaptured | 0 | Données vidéo capturées avant le prétraitement |
AoqVideoSourcePreEncode | 1 | Données vidéo après prétraitement, avant l'encodage |
AoqVideoSourceRemote | 2 | Données vidéo distantes après décodage et avant le rendu |
AoqVideoSourceMax | 3 | Espace réservé, ne pas utiliser |
AoqVideoObserverMode
Valeur d'énumération | Valeur | Description |
|---|---|---|
AoqVideoObserverModeReadOnly | 0 | Mode lecture seule |
AoqVideoObserverModeReadWrite | 1 | Mode lecture-écriture (pris en charge uniquement pour I420 / CVPixelBuffer) |
AoqVideoObserverAlignment
Valeur d'énumération | Valeur | Description |
|---|---|---|
AoqVideoObserverAlignmentDefault | 0 | Alignement par défaut |
AoqVideoObserverAlignmentEven | 1 | Alignement sur un nombre pair |
AoqVideoObserverAlignment4 | 2 | Alignement sur 4 octets |
AoqVideoObserverAlignment8 | 3 | Alignement sur 8 octets |
AoqVideoObserverAlignment16 | 4 | Alignement sur 16 octets |
AoqVideoObserverConfig
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
format | AoqVideoPixelFormat | AoqVideoPixelFormatI420 | Format de pixel attendu des données de rappel |
alignment | AoqVideoObserverAlignment | AoqVideoObserverAlignmentDefault | Politique d'alignement de la largeur |
mode | AoqVideoObserverMode | AoqVideoObserverModeReadOnly | Mode de rappel. Le mode ReadWrite est pris en charge uniquement pour I420 / CVPixelBuffer. |
mirrorApplied | bool | false | Indique si les données de rappel doivent être mises en miroir |