Skip to main content

Référence de l'API AOQ Client SDK Windows

Cette rubrique décrit les API C++, les rappels et les types de données d'AOQ Client SDK pour Windows.

Le SDK AOQ fournit des API vidéo générales. Qwen-Audio-Realtime ne prend pas en charge l’entrée ni la sortie vidéo. Pour les capacités de médias des autres modèles, consultez leur documentation de connexion.
Le SDK conserve l'instance du moteur en tant que singleton global, expose les API via la classe 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.
L'appelant est responsable du cycle de vie de toutes les chaînes 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.
static AoqClientEngine* createEngine(const AoqCreateConfig& config,
                                     AoqEngineEventListener* listener);
Paramètres

Paramètres

Type

Description

config

const AoqCreateConfig&

Configuration de création du moteur. Pour plus d'informations, consultez AoqCreateConfig.

listener

AoqEngineEventListener*

Écouteur de rappel d'événements. Pour plus d'informations, consultez AoqEngineEventListener.

Valeur de retour : un pointeur vers l'instance du moteur. 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.
static int destroy();
Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

getVersion

Obtenez la version du SDK.
static const char* getVersion();
Valeur de retour : la chaîne de version.

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.
virtual int connect(const AoqConnectConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqConnectConfig&

Configuration d'authentification de la connexion. Pour plus d'informations, consultez AoqConnectConfig.

Valeur de retour : 0 indique que l'appel est distribué et s'exécute de manière asynchrone ; une valeur non nulle indique un échec de la validation des paramètres.

disconnect

Déconnectez-vous du serveur.
virtual int disconnect();
Valeur de retour : 0 indique que l'appel est distribué et s'exécute de manière asynchrone ; une valeur non nulle indique un échec.

Gestion des périphériques audio

startAudioCapture

Ouvrez le périphérique de capture audio (microphone).
virtual int startAudioCapture(const AoqAudioCaptureConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqAudioCaptureConfig&

Configuration de capture audio. Pour plus d'informations, consultez AoqAudioCaptureConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

stopAudioCapture

Fermez le périphérique de capture audio.
virtual int stopAudioCapture();
Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

muteAudioCapture

Coupez ou rétablissez le son de la capture audio.
virtual int muteAudioCapture(bool mute);
Paramètres

Paramètres

Type

Description

mute

bool

true coupe le son ; false rétablit le son

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

startAudioPlayer

Démarrez le rendu audio pour lire l'audio distant.
virtual int startAudioPlayer(const AoqAudioPlaybackConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqAudioPlaybackConfig&

Configuration de lecture audio. Pour plus d'informations, consultez AoqAudioPlaybackConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

stopAudioPlayer

Arrêtez le rendu audio.
virtual int stopAudioPlayer();
Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

pauseAudioPlayer

Mettez en pause le rendu audio, avec prise en charge du fondu sortant.
virtual int pauseAudioPlayer(int fadeMs);
Paramètres

Paramètres

Type

Description

fadeMs

int

Durée du fondu sortant, en millisecondes. 0 indique une pause immédiate.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

resumeAudioPlayer

Reprenez le rendu audio, avec prise en charge du fondu entrant.
virtual int resumeAudioPlayer(int fadeMs);
Paramètres

Paramètres

Type

Description

fadeMs

int

Durée du fondu entrant, en millisecondes. 0 indique une reprise immédiate.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

interruptAudioPlayer

Interrompez la session audio en cours et arrêtez l'audio en cours de lecture.
virtual int interruptAudioPlayer(AoqTrackType trackType, int fadeMs);
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Type de piste. Pour plus d'informations, consultez AoqTrackType.

fadeMs

int

Durée du fondu sortant, en millisecondes. 0 indique une interruption immédiate.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int enableLocalAudioVolumeIndication(const AoqAudioVolumeIndicationConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqAudioVolumeIndicationConfig&

Configuration d'indication de volume. Pour plus d'informations, consultez AoqAudioVolumeIndicationConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

Configuration de l'encodage audio

setAudioEncoderConfig

Définissez les paramètres d'encodage audio.
virtual int setAudioEncoderConfig(const AoqAudioCodecConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqAudioCodecConfig&

Configuration du codec audio. Pour plus d'informations, consultez AoqAudioCodecConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

setAudioDecoderConfig

Définissez les paramètres de décodage audio.
virtual int setAudioDecoderConfig(const AoqAudioCodecConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqAudioCodecConfig&

Configuration du codec audio. Pour plus d'informations, consultez AoqAudioCodecConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int startVideoCapture(const AoqVideoCaptureConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqVideoCaptureConfig&

Configuration de capture vidéo. Pour plus d'informations, consultez AoqVideoCaptureConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

stopVideoCapture

Fermez le périphérique de capture vidéo.
virtual int stopVideoCapture();
Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

setLocalView

Définissez ou supprimez la fenêtre de rendu vidéo local. Si canvas.view == nullptr, la liaison est supprimée.
virtual int setLocalView(AoqTrackType trackType, const AoqVideoCanvas& canvas);
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Piste vidéo. Transmettez AoqTrackTypeVideo.

canvas

const AoqVideoCanvas&

Toile de rendu. Pour plus d'informations, consultez AoqVideoCanvas. Si view est nullptr, la liaison est supprimée.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

setRemoteView

Définissez ou supprimez la fenêtre de rendu vidéo distant. Si canvas.view == nullptr, la liaison est supprimée.
virtual int setRemoteView(AoqTrackType trackType, const AoqVideoCanvas& canvas);
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Piste vidéo. Transmettez AoqTrackTypeVideo.

canvas

const AoqVideoCanvas&

Toile de rendu. Pour plus d'informations, consultez AoqVideoCanvas. Si view est nullptr, la liaison est supprimée.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int setVideoEncoderConfig(const AoqVideoCodecConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqVideoCodecConfig&

Configuration du codec vidéo. Pour plus d'informations, consultez AoqVideoCodecConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int setVideoDecoderConfig(const AoqVideoCodecConfig& config);
Paramètres

Paramètres

Type

Description

config

const AoqVideoCodecConfig&

Configuration du codec vidéo. Pour plus d'informations, consultez AoqVideoCodecConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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é.
virtual int pushExternalVideoCapturedFrame(AoqTrackType trackType, const AoqVideoFrame& frame);
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Cible d'acheminement. Transmettez AoqTrackTypeVideo.

frame

const AoqVideoFrame&

Données de l'image vidéo externe. Pour plus d'informations, consultez AoqVideoFrame.

Valeur de retour : 0 en cas de succès ; 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.
virtual int pushExternalVideoEncodedFrame(AoqTrackType trackType, const AoqVideoEncodedFrame& frame);
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Cible d'acheminement. Transmettez AoqTrackTypeVideo.

frame

const AoqVideoEncodedFrame&

Données de l'image encodée en externe. Pour plus d'informations, consultez AoqVideoEncodedFrame.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int enableSendMediaStream(AoqTrackType trackType, bool enable);
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Cible d'acheminement. AoqTrackTypeAudio et AoqTrackTypeVideo sont pris en charge.

enable

bool

true active l'envoi ; false désactive l'envoi

Valeur de retour : 0 indique que l'appel est distribué et s'exécute de manière asynchrone ; une valeur non nulle indique un échec.

Lecture de fichiers audio

startAudioFile

Démarrez la lecture d'un fichier audio local vers le flux de publication.
virtual int startAudioFile(const char* fileId, const AoqAudioFileMixConfig& config);
Paramètres

Paramètres

Type

Description

fileId

const char*

ID du fichier audio. La couche métier doit garantir son unicité.

config

const AoqAudioFileMixConfig&

Configuration de mixage du fichier audio. Pour plus d'informations, consultez AoqAudioFileMixConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

stopAudioFile

Arrêtez la lecture du fichier audio.
virtual int stopAudioFile(const char* fileId);
Paramètres

Paramètres

Type

Description

fileId

const char*

ID du fichier audio

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

pauseAudioFile

Mettez en pause la lecture du fichier audio.
virtual int pauseAudioFile(const char* fileId);
Paramètres

Paramètres

Type

Description

fileId

const char*

ID du fichier audio

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

resumeAudioFile

Reprenez la lecture du fichier audio.
virtual int resumeAudioFile(const char* fileId);
Paramètres

Paramètres

Type

Description

fileId

const char*

ID du fichier audio

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

getAudioFileDuration

Obtenez la durée totale du fichier audio.
virtual int64_t getAudioFileDuration(const char* fileId);
Paramètres

Paramètres

Type

Description

fileId

const char*

ID du fichier audio

Valeur de retour : une valeur supérieure ou égale à 0 indique la durée du fichier audio, en millisecondes ; une valeur inférieure à 0 indique un échec (-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

workDir

const char*

nullptr

Répertoire de travail du SDK

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)

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

token

const char*

Jeton d'authentification de la connexion

sid

const char*

ID de session

certFingerprint

const char*

Empreinte du certificat du serveur

workspaceIdHash

const char*

ID de hachage de l'espace de travail

relayEndpoints

const AoqRelayEndpoint*

Tableau des points d'accès relais

relayEndpointsCount

size_t

Nombre de points d'accès relais

publishTracks

const AoqTrackParam*

Tableau des attributs des pistes de publication locales

publishTracksCount

size_t

Nombre de pistes de publication

subscribeTracks

const AoqTrackParam*

Tableau des attributs des pistes d'abonnement locales

subscribeTracksCount

size_t

Nombre de pistes d'abonnement

AoqRelayEndpoint

Point d'accès relais.

Champ

Type

Valeur par défaut

Description

route_index

int

-1

Index du chemin

endpoint

const char*

nullptr

Adresse du serveur (nom de domaine ou adresse IP)

port

int

0

Port du serveur

AoqTrackParam

Attribut de piste.

Champ

Type

Valeur par défaut

Description

trackType

AoqTrackType

Audio

Type de piste

trackMode

AoqTrackMode

Segment

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

data

const uint8_t*

Contenu du message. Pointe vers la mémoire détenue par l'appelant.

dataSize

size_t

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

audioPublishStats / audioPublishStatsCount

const AoqAudioPublishStats* / unsigned int

Tableau des statistiques de publication audio et nombre d'entrées

videoPublishStats / videoPublishStatsCount

const AoqVideoPublishStats* / unsigned int

Tableau des statistiques de publication vidéo et nombre d'entrées

dataMsgPublishStats / dataMsgPublishStatsCount

const AoqDataMsgPublishStats* / unsigned int

Tableau des statistiques de publication des messages de données et nombre d'entrées

audioSubscribeStats / audioSubscribeStatsCount

const AoqAudioSubscribeStats* / unsigned int

Tableau des statistiques d'abonnement audio et nombre d'entrées

videoSubscribeStats / videoSubscribeStatsCount

const AoqVideoSubscribeStats* / unsigned int

Tableau des statistiques d'abonnement vidéo et nombre d'entrées

dataMsgSubscribeStats / dataMsgSubscribeStatsCount

const AoqDataMsgSubscribeStats* / unsigned int

Tableau des statistiques d'abonnement aux messages de données et nombre d'entrées

networkStats

const AoqNetworkStats*

Statistiques réseau

AoqNetworkStats

Statistiques réseau.

Field

Type

Description

sendBitrate

unsigned int

Débit d'envoi, en bit/s

sendBytes

uint64_t

Nombre cumulé d'octets envoyés

recvBitrate

unsigned int

Débit de réception, en bit/s

recvBytes

uint64_t

Nombre cumulé d'octets reçus

loss

unsigned int

Taux de perte de paquets, de 0 à 100

rtt

unsigned int

Latence aller-retour, en ms

AoqAudioPublishStats

Statistiques de publication audio.

Field

Type

Description

trackType

AoqTrackType

Type de piste

bitrate

unsigned int

Débit binaire, en bit/s

bytes

uint64_t

Nombre cumulé d'octets

encodeVolume

unsigned int

Volume d'encodage du flux publié

AoqVideoPublishStats

Statistiques de publication vidéo.

Field

Type

Description

trackType

AoqTrackType

Type de piste

bitrate

unsigned int

Débit binaire, en bit/s

bytes

uint64_t

Nombre cumulé d'octets

encodeFps

unsigned int

Fréquence d'images d'encodage

AoqDataMsgPublishStats

Statistiques de publication des messages de données.

Field

Type

Description

trackType

AoqTrackType

Type de piste

bitrate

unsigned int

Débit binaire, en bit/s

bytes

uint64_t

Nombre cumulé d'octets

AoqAudioSubscribeStats

Statistiques d'abonnement audio.

Field

Type

Description

trackType

AoqTrackType

Type de piste

bitrate

unsigned int

Débit binaire, en bit/s

bytes

uint64_t

Nombre cumulé d'octets

playVolume

unsigned int

Volume de lecture

AoqVideoSubscribeStats

Statistiques d'abonnement vidéo.

Field

Type

Description

trackType

AoqTrackType

Type de piste

bitrate

unsigned int

Débit binaire, en bit/s

bytes

uint64_t

Nombre cumulé d'octets

decodeFps

unsigned int

Fréquence d'images de décodage

renderFps

unsigned int

Fréquence d'images de rendu

AoqDataMsgSubscribeStats

Statistiques d'abonnement aux messages de données.

Field

Type

Description

trackType

AoqTrackType

Type de piste

bitrate

unsigned int

Débit binaire, en bit/s

bytes

uint64_t

Nombre cumulé d'octets

Enumerations

AoqErrorCode

Énumération des codes d'erreur.

Enum value

Value

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 en cours d'utilisation

AoqECAudioDeviceRecordingBackgroundStart

123

Démarrer l'enregistrement en arrière-plan

AoqECAudioDeviceRecordingStartFail

124

Échec du démarrage de l'enregistrement

AoqECAudioDevicePlayoutOccupied

125

Le périphérique de lecture est en cours d'utilisation

AoqECAudioDevicePlayoutBackgroundStart

126

Démarrer la lecture en arrière-plan

AoqECAudioDevicePlayoutStartFail

127

Échec du démarrage de la lecture

AoqECAudioDeviceEarpieceRequiresVoipMode

128

Le mode écouteur nécessite l'activation de la VoIP

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 en cours d'utilisation

AoqECVideoDeviceCameraRunningError

224

Erreur 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

AoqECVideoRender

240

Erreur générique de rendu vidéo

AoqECVideoRenderCreateFail

241

Échec de la création de la vue de rendu

AoqECVideoRenderDrawError

242

Erreur de dessin lors du rendu

AoqWarningCode

Énumération des codes d'avertissement.

Enum value

Value

Description

AoqWCOK

0

Aucun avertissement

AoqWCAudio

100

Avertissement audio générique

AoqWCAudioHowling

101

Détection d'un effet Larsen audio

AoqWCAudioDevice

120

Avertissement générique du périphérique audio

AoqWCAudioDeviceMicEnumerateError

121

Erreur d'énumération du microphone

AoqWCAudioDeviceMicStartTimeout

122

Délai dépassé lors du démarrage du microphone

AoqWCAudioDeviceRecordingError

123

Erreur d'enregistrement

AoqWCAudioDeviceSpeakerEnumerateError

124

Erreur d'énumération du haut-parleur

AoqWCAudioDeviceSpeakerStartTimeout

125

Délai dépassé lors du démarrage du haut-parleur

AoqWCAudioDevicePlayoutError

126

Erreur de lecture

AoqWCVideo

200

Avertissement vidéo générique

AoqWCVideoCameraEnumerateError

201

Erreur d'énumération de la caméra

AoqWCVideoEncoderSwitched

202

Changement d'encodeur vidéo

AoqWCVideoRenderDowngrade

203

Rétrogradation du rendu vidéo

AoqTrackType

Type de piste.

Enum value

Value

Description

AoqTrackTypeAudio

0

Piste audio

AoqTrackTypeVideo

1

Piste vidéo

AoqTrackTypeData

2

Piste de messages de données

AoqEncoderType

Type d'encodeur.

Enum value

Value

Description

AoqEncoderTypeUnknown

0

Format inconnu

AoqEncoderTypeAudioPCM

1

Audio PCM

AoqEncoderTypeAudioOpus

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)

AoqEncoderTypeVideoH264

3

Vidéo H.264

AoqEncoderTypeVideoJpeg

4

Vidéo JPEG

AoqEncoderTypeDataText

5

Texte du message

AoqTrackMode

Mode de diffusion en continu ou non. S'applique uniquement à la liaison descendante audio.

Enum value

Value

Description

AoqTrackModeSegment

0

Segmented : les données sont encapsulées et transmises par segments sémantiques, tels qu'une phrase.

AoqTrackModeStream

1

Streaming : les données sont transmises en continu.

AoqConnectionStatus

Statut de la connexion au moteur.

Enum value

Value

Description

AoqConnectionStatusDisconnected

0

Déconnecté

AoqConnectionStatusConnecting

1

Connexion en cours

AoqConnectionStatusConnected

2

Connecté

AoqConnectionStatusFailed

3

Échec de la connexion

Types audio

AoqAudioCaptureConfig

Configuration de la capture audio.

Field

Type

Default value

Description

isExternal

bool

false

Indique s'il faut utiliser une capture externe

channel

int

1

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

isExternal

bool

false

Indique s'il faut utiliser une lecture externe

channel

int

1

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

trackType

AoqTrackType

Audio

Type de piste

codecType

AoqEncoderType

AudioPCM

Format du codec

sampleRate

int

48000

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.

channel

int

1

Nombre de canaux. Les valeurs 1 et 2 sont prises en charge.

bitrate

int

32000

Débit binaire, en bit/s

AoqAudioDeviceState

État du périphérique audio.

Field

Type

Description

state

AoqAudioDeviceStateCode

Code d'état

reason

int

Code d'erreur (AoqErrorCode)

AoqAudioDeviceStateCode

Code d'état du périphérique audio.

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

AoqAudioDeviceRouteType

Type de routage du périphérique audio.

Enum value

Value

Description

AoqAudioDeviceRouteDefault

0

Par défaut

AoqAudioDeviceRouteHeadset

1

Casque

AoqAudioDeviceRouteEarpiece

2

Écouteur

AoqAudioDeviceRouteHeadsetNoMic

3

Casque sans microphone

AoqAudioDeviceRouteSpeakerPhone

4

Haut-parleur intégré

AoqAudioDeviceRouteUsb

5

USB

AoqAudioDeviceRouteBluetooth

6

Bluetooth

AoqAudioDeviceRouteBluetoothA2dp

7

Bluetooth A2DP

AoqAudioFileMixConfig

Configuration de lecture d'un fichier audio vers le flux de publication.

Field

Type

Default value

Description

fileName

const char*

nullptr

Nom du fichier (incluant le chemin). Obligatoire.

cycles

int

-1

Nombre de boucles. La valeur -1 indique une boucle illimitée.

startPosMs

long

0

Position de démarrage de la lecture, en ms

publishVolume

int

100

Volume de publication. Valeurs valides : 0 à 100.

playoutVolume

int

100

Volume de lecture. Valeurs valides : 0 à 100.

AoqAudioFileState

État du fichier audio.

Field

Type

Description

fileId

const char*

ID du fichier

stateCode

AoqAudioFileStateCode

Code d'état

errorCode

AoqAudioFileErrorCode

Code d'erreur

AoqAudioFileStateCode

Code d'état du fichier audio.

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

Code d'erreur de lecture du fichier audio.

Enum value

Value

Description

AoqAudioFileNoError

0

Aucune erreur

AoqAudioFileOpenFailed

1

Échec de l'ouverture du fichier

AoqAudioFileDecodeFailed

2

Échec du décodage du fichier

AoqAudioExternalStreamConfig

Configuration du flux audio externe.

Field

Type

Default value

Description

trackType

AoqTrackType

Audio

Type de piste audio

codecType

AoqEncoderType

AudioPCM

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, qui prend en charge 1 et 2. Les canaux supplémentaires sont ignorés.

sampleRate

int

48000

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.

playoutVolume

int

100

Volume de lecture. Valeurs valides : 0 à 100.

publishVolume

int

100

Volume de publication. Valeurs valides : 0 à 100.

maxBufferDuration

int

600000

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.

enable3A

bool

false

Indique s'il faut appliquer le traitement 3A au PCM d'entrée

AoqAudioFrameData

Données audio.

Field

Type

Description

dataPtr

void*

Pointeur vers les données audio

numOfSamples

int

Nombre d'échantillons (par canal)

bytesPerSample

int

Octets par échantillon

numOfChannels

int

Nombre de canaux

samplesPerSec

int

Nombre d'échantillons par seconde

pushSequence

int

Tour d'entrée PCM (utilisé pour la notification de fin de consommation de pushAudioExternalStreamData)

timeStamp

int64_t

Horodatage

dataSize

int

Longueur des données

autoGenMute

bool

Valide dans les rappels de données. La valeur true indique des données silencieuses générées par le SDK.

AoqAudioStreamDirection

Sens du flux audio.

Valeur d'énumération

Valeur

Description

AoqAudioStreamPublish

0

Publication de l'audio

AoqAudioStreamPlayout

1

Lecture de l'audio

AoqAudioExternalStreamToggle

Contrôle du flux audio externe.

Valeur d'énumération

Valeur

Description

AoqAudioExternalStreamToggleNormal

0

Récupéré

AoqAudioExternalStreamTogglePause

1

En pause

AoqAudioSource

Type de source des données audio.

Valeur d'énumération

Valeur

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 établie avec succès)

AoqAudioSourcePlayback

3

Données audio à lire

AoqAudioObserverMode

Mode de rappel des trames audio.

Valeur d'énumération

Valeur

Description

AoqAudioObserverModeReadOnly

0

Lecture seule

AoqAudioObserverModeReadWrite

1

Lecture-écriture

AoqAudioObserverConfig

Paramètres de configuration pour les rappels de données audio.

Champ

Type

Valeur par défaut

Description

sampleRate

int

48000

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.

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 de codec du flux d'abonnement.

mode

AoqAudioObserverMode

ReadOnly

Mode de rappel

AoqAudioVolumeIndicationConfig

Configuration de l'indication du volume local.

Champ

Type

Valeur par défaut

Description

interval

int

0

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.

smooth

int

3

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

int

Volume instantané lissé. Valeurs valides : 0 à 255.

Types vidéo

AoqVideoCaptureConfig

Configuration de la capture vidéo.

Champ

Type

Valeur par défaut

Description

width

int

1280

Largeur de capture, en pixels. Ce paramètre n'a aucun effet lorsque isExternal=true.

height

int

720

Hauteur de capture, en pixels. Ce paramètre n'a aucun effet lorsque isExternal=true.

fps

int

15

Taux de rafraîchissement de la capture. Ce paramètre n'a aucun effet lorsque isExternal=true (le rythme est déterminé par la livraison des trames).

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 trames sont fournies par pushExternalVideoCapturedFrame.

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

view

void*

nullptr

Handle de la vue d'affichage (HWND). Transmettez nullptr pour supprimer la liaison de rendu.

renderMode

AoqRenderMode

Auto

Mode de rendu

AoqRenderMode

Mode d'affichage du rendu.

Valeur d'énumération

Valeur

Description

AoqRenderModeAuto

0

Mode automatique

AoqRenderModeStretch

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.

AoqRenderModeFill

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.

AoqRenderModeCrop

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

AoqVideoPixelFormatUnknown

0

Format inconnu

AoqVideoPixelFormatI420

1

I420

AoqVideoPixelFormatNV12

2

NV12

AoqVideoPixelFormatNV21

3

NV21

AoqVideoPixelFormatBGRA

4

BGRA

AoqVideoPixelFormatRGBA

5

RGBA

AoqVideoFrame

Données vidéo externes.

Champ

type

description

format

AoqVideoPixelFormat

Format de pixel

width

int

width, en pixels

height

int

Hauteur, en pixels

dataPtr

void*

Pointeur vers les données au format packé (NV12/NV21/BGRA/RGBA)

dataSize

int

Nombre d'octets des données packées

dataY / dataU / dataV

void*

Pointeurs vers les données des trois plans I420

strideY / strideU / strideV

int

Pas (stride) des trois plans I420

timeStamp

int64_t

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

codec

AoqVideoCodecType

format de codec

data

void*

Pointeur vers les données encodées

dataSize

int

Nombre d'octets des données encodées

width

int

width, en pixels

height

int

Hauteur, en pixels

timeStamp

int64_t

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

AoqVideoCodecTypeJPEG

0

JPEG

AoqVideoDeviceState

État du périphérique vidéo.

Champ

type

description

state

AoqVideoDeviceStateCode

<!--@p {"id":"77c5611f15a1"}--br>code d'état

reason

int

code d'erreur (AoqErrorCode)

AoqVideoDeviceStateCode

code d'état du périphérique vidéo.

Valeur d'énumération

Valeur

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)

AoqMirrorMode

Mode miroir.

Valeur d'énumération

Valeur

description

AoqMirrorModeDisabled

0

Désactiver le mode miroir

AoqMirrorModeEnabled

1

activez le mode miroir

AoqOrientationMode

Mode d'orientation.

Valeur d'énumération

Valeur

description

AoqOrientationModeAuto

0

Automatique

AoqOrientationModePortrait

1

Portrait

AoqOrientationModeLandscape

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

isExternal

bool

false

Mode d'encodage externe. Lorsque la valeur est true, vous poussez les images encodées et le SDK n'effectue ni capture ni encodage.

trackType

AoqTrackType

Video

Type de piste

codecType

AoqEncoderType

VideoH264

Format du codec

width

int

540

Largeur de la résolution

height

int

960

Hauteur de la résolution

fps

int

5

Fréquence d'images

bitrate

int

500000

Débit initial, en bit/s

minBitrate

int

128000

Débit minimal, en bit/s

keyframeInterval

int

2

Intervalle entre les images clés, en secondes

mirrorMode

AoqMirrorMode

Disabled

Mode miroir

orientationMode

AoqOrientationMode

Auto

Mode d'orientation

AoqVideoSource

source de données pour le rappel des images vidéo (position dans le pipeline).

Enum value

Value

Description

AoqVideoSourceCaptured

0

Données vidéo capturées avant le prétraitement

AoqVideoSourcePreEncode

1

Données vidéo avant l'encodage, après le prétraitement

AoqVideoSourceRemote

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

AoqVideoObserverModeReadOnly

0

Lecture seule

AoqVideoObserverModeReadWrite

1

Lecture-écriture

AoqVideoObserverAlignment

Méthode d'alignement de la width pour la sortie vidéo.

Enum value

Value

Description

AoqVideoObserverAlignmentDefault

0

Valeur 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

Paramètres pour les rappels de données vidéo.

Field

Type

Default value

Description

format

AoqVideoPixelFormat

I420

Format de pixel attendu pour les données de rappel

alignment

AoqVideoObserverAlignment

Default

Politique d'alignement de la largeur

mode

AoqVideoObserverMode

ReadOnly

Mode de rappel. Le mode ReadWrite est pris en charge uniquement pour le format I420.

mirrorApplied

bool

false

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.
virtual int64_t getAudioFileCurrentPosition(const char* fileId);
Paramètres

Parameters

Type

Description

fileId

const char*

ID du fichier audio

Valeur renvoyée : une valeur supérieure ou égale à 0 indique la position de lecture actuelle, en millisecondes ; une valeur inférieure à 0 indique un échec (-AoqErrorCode).

setAudioFilePositionMillis

définissez la position de lecture du fichier audio (recherche).
virtual int setAudioFilePositionMillis(const char* fileId, int64_t positionMillis);
Paramètres

Parameters

Type

Description

fileId

const char*

ID du fichier audio

positionMillis

int64_t

Position de lecture, en millisecondes

Valeur renvoyée : 0 en cas de succès ; valeur non nulle en cas d'échec.

setAudioFileVolume

Définit le volume du fichier audio.
virtual int setAudioFileVolume(const char* fileId, AoqAudioStreamDirection type, int volume);
Paramètres

Parameters

Type

Description

fileId

const char*

ID du fichier audio

type

AoqAudioStreamDirection

Direction du flux audio. Pour plus d'informations, consultez AoqAudioStreamDirection.

volume

int

Valeur du volume. Valeurs valides : 0 à 100.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

getAudioFileVolume

Récupère le volume actuel du fichier audio.
virtual int getAudioFileVolume(const char* fileId, AoqAudioStreamDirection type);
Paramètres

Parameters

Type

Description

fileId

const char*

ID du fichier audio

type

AoqAudioStreamDirection

Direction du flux audio. Pour plus d'informations, consultez AoqAudioStreamDirection.

Valeur de retour : une valeur comprise entre 0 et 100 indique le volume ; une valeur inférieure à 0 indique un échec (-AoqErrorCode).

Flux audio externes

addAudioExternalStream

Ajoute un flux audio externe.
virtual int addAudioExternalStream(const char* streamId, const AoqAudioExternalStreamConfig& config);
Paramètres

Parameters

Type

Description

streamId

const char*

ID du flux audio externe. La couche métier doit garantir son unicité.

config

const AoqAudioExternalStreamConfig&

Configuration du flux audio externe. Pour plus d'informations, consultez AoqAudioExternalStreamConfig.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int pushAudioExternalStreamData(const char* streamId, AoqAudioFrameData& data);
Paramètres

Parameters

Type

Description

streamId

const char*

ID du flux audio externe

data

AoqAudioFrameData&

Données audio externes brutes. Pour plus d'informations, consultez AoqAudioFrameData.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.
Bonnes pratiques : dans les scénarios de capture en temps réel, envoyez des blocs de 10 ms dès que les données sont disponibles. Lorsque les données proviennent d'un fichier, envoyez des blocs de 40 ms toutes les 30 ms et gérez la valeur de retour AoqECAudioExternalBufferFull.

setAudioExternalStreamVolume

Définit le volume d'un flux audio externe.
virtual int setAudioExternalStreamVolume(const char* streamId, AoqAudioStreamDirection type, int vol);
Paramètres

Parameters

Type

Description

streamId

const char*

ID du flux audio externe

type

AoqAudioStreamDirection

Type de flux audio externe. Pour plus d'informations, consultez AoqAudioStreamDirection.

vol

int

Valeur du volume. Valeurs valides : 0 à 100.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

getAudioExternalStreamVolume

Récupère le volume d'un flux audio externe.
virtual int getAudioExternalStreamVolume(const char* streamId, AoqAudioStreamDirection type);
Paramètres

Parameters

Type

Description

streamId

const char*

ID du flux audio externe

type

AoqAudioStreamDirection

Type de flux audio externe. Pour plus d'informations, consultez AoqAudioStreamDirection.

Valeur de retour : une valeur comprise entre 0 et 100 indique le volume ; une valeur inférieure à 0 indique un échec (-AoqErrorCode).

clearAudioExternalStreamBuffer

Vide le tampon d'un flux audio externe.
virtual void clearAudioExternalStreamBuffer(const char* streamId, int fadeoutMs);
Paramètres

Parameters

Type

Description

streamId

const char*

ID du flux audio externe

fadeoutMs

int

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é.

Valeur de retour : aucune.

removeAudioExternalStream

Supprime un flux audio externe.
virtual int removeAudioExternalStream(const char* streamId);
Paramètres

Parameters

Type

Description

streamId

const char*

ID du flux audio externe

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

Messagerie en temps réel

sendDataMsg

Envoie un message de données en temps réel.
virtual int sendDataMsg(const AoqDataMsg& msg);
Paramètres

Parameters

Type

Description

msg

const AoqDataMsg&

Contenu du message. Pour plus d'informations, consultez AoqDataMsg.

Valeur de retour : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int setAudioFrameObserver(IAudioFrameObserver* observer) = 0;
Paramètres

Paramètres

Type

Description

observer

IAudioFrameObserver*

Écouteur de rappel de trame audio. Pour plus d'informations, consultez IAudioFrameObserver. Transmettez nullptr pour arrêter les rappels.

Valeur renvoyée : 0 en cas de succès ; valeur non nulle en cas d'échec.

enableAudioFrameObserver

Active ou désactive le rappel de trame audio à une position spécifiée.
virtual int enableAudioFrameObserver(bool enabled, AoqAudioSource audioSource,
                                     const AoqAudioObserverConfig& config) = 0;
Paramètres

Paramètres

Type

Description

enabled

bool

Indique s'il faut autoriser les rappels de données

audioSource

AoqAudioSource

Type de la source de données audio brutes. Pour plus d'informations, consultez AoqAudioSource.

config

const AoqAudioObserverConfig&

Paramètres du rappel. Pour plus d'informations, consultez AoqAudioObserverConfig.

Valeur renvoyée : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual int setVideoFrameObserver(IVideoFrameObserver* observer) = 0;
Paramètres

Paramètres

Type

Description

observer

IVideoFrameObserver*

Écouteur de rappel de trame vidéo. Pour plus d'informations, consultez IVideoFrameObserver. Transmettez nullptr pour arrêter les rappels.

Valeur renvoyée : 0 en cas de succès ; valeur non nulle en cas d'échec.

enableVideoFrameObserver

Active ou désactive le rappel de trame vidéo à une position spécifiée.
virtual int enableVideoFrameObserver(bool enabled, AoqVideoSource videoSource,
                                     const AoqVideoObserverConfig& config) = 0;
Paramètres

Paramètres

Type

Description

enabled

bool

Indique s'il faut activer les rappels de données à une position donnée

videoSource

AoqVideoSource

Source de données du rappel de trame vidéo (position dans le pipeline). Pour plus d'informations, consultez AoqVideoSource.

config

const AoqVideoObserverConfig&

Paramètres du rappel. Pour plus d'informations, consultez AoqVideoObserverConfig.

Valeur renvoyée : 0 en cas de succès ; valeur non nulle en cas d'échec.

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.
virtual void onError(int code, const char* message) = 0;
Paramètres

Paramètres

Type

Description

code

int

Code d'erreur. Pour plus d'informations, consultez AoqErrorCode.

message

const char*

Description de l'erreur

onWarning

Rappel d'avertissement du moteur.
virtual void onWarning(int code, const char* message) = 0;
Paramètres

Paramètres

Type

Description

code

int

Code d'avertissement. Pour plus d'informations, consultez AoqWarningCode.

message

const char*

Description de l'avertissement

onConnectionStatusChange

Rappel de changement d'état de la connexion du moteur.
virtual void onConnectionStatusChange(AoqConnectionStatus status) = 0;
Paramètres

Paramètres

Type

Description

status

AoqConnectionStatus

État de la connexion. Pour plus d'informations, consultez AoqConnectionStatus.

onStats

Rappel de statistiques du moteur.
virtual void onStats(const AoqStats& stats) = 0;
Paramètres

Paramètres

Type

Description

stats

const AoqStats&

Données statistiques. Pour plus d'informations, consultez AoqStats.

onAudioDeviceStateChanged

Rappel indiquant les changements d'état des opérations de capture et de lecture des périphériques audio.
virtual void onAudioDeviceStateChanged(const AoqAudioDeviceState& state) = 0;
Paramètres

Paramètres

Type

Description

state

const AoqAudioDeviceState&

État du périphérique audio. Pour plus d'informations, consultez AoqAudioDeviceState.

onAudioDeviceRouteChanged

Rappel de modification du chemin de sortie audio.
virtual void onAudioDeviceRouteChanged(int routeType) = 0;
Paramètres

Parameters

Type

Description

routeType

int

Type de chemin. Pour connaître les valeurs valides, consultez AoqAudioDeviceRouteType.

onAudioFileState

Rappel d'état de lecture d'un fichier audio.
virtual void onAudioFileState(const AoqAudioFileState& state) = 0;
Paramètres

Parameters

Type

Description

state

const AoqAudioFileState&

État de lecture du fichier. Pour plus d'informations, consultez AoqAudioFileState.

onLocalAudioVolumeIndication

Rappel d'indication du volume de capture local. Pour l'activer, appelez enableLocalAudioVolumeIndication.
virtual void onLocalAudioVolumeIndication(const AoqAudioVolume& volume) = 0;
Paramètres

Parameters

Type

Description

volume

const AoqAudioVolume&

Informations sur le volume local. Pour plus d'informations, consultez AoqAudioVolume.

onVideoDeviceStateChanged

Rappel des modifications d'état des opérations de capture du périphérique vidéo.
virtual void onVideoDeviceStateChanged(const AoqVideoDeviceState& state) = 0;
Paramètres

Parameters

Type

Description

state

const AoqVideoDeviceState&

État du périphérique vidéo. Pour plus d'informations, consultez AoqVideoDeviceState.

onDataMsg

Rappel de réception d'un message de données en temps réel.
virtual void onDataMsg(const AoqDataMsg& msg) = 0;
Paramètres

Parameters

Type

Description

msg

const AoqDataMsg&

Message de données. Pour plus d'informations, consultez AoqDataMsg.

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.
virtual void onCapturedAudioFrame(const AoqAudioFrameData& data) = 0;
Paramètres

Parameters

Type

Description

data

const AoqAudioFrameData&

Données audio brutes capturées. Pour plus d'informations, consultez AoqAudioFrameData.

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.
virtual void onProcessCapturedAudioFrame(const AoqAudioFrameData& data) = 0;
Paramètres

Parameters

Type

Description

data

const AoqAudioFrameData&

Données audio brutes après traitement 3A. Pour plus d'informations, consultez AoqAudioFrameData.

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.
virtual void onPublishAudioFrame(AoqTrackType trackType, const AoqAudioFrameData& data) = 0;
Paramètres

Parameters

Type

Description

trackType

AoqTrackType

Type de piste. Pour plus d'informations, consultez AoqTrackType.

data

const AoqAudioFrameData&

Données audio brutes à publier. Pour plus d'informations, consultez AoqAudioFrameData.

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.
virtual void onPlaybackAudioFrame(const AoqAudioFrameData& data) = 0;
Paramètres

Parameters

Type

Description

data

const AoqAudioFrameData&

Données audio brutes pour la lecture. Pour plus d'informations, consultez AoqAudioFrameData.

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.
virtual bool onCapturedVideoFrame(AoqVideoFrame& frame) = 0;
Paramètres

Parameters

Type

Description

frame

AoqVideoFrame&

Données de trame vidéo capturée. Pour plus d'informations, consultez AoqVideoFrame.

Valeur de retour : 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.
virtual bool onPreEncodeVideoFrame(AoqTrackType trackType, AoqVideoFrame& frame) = 0;
Paramètres

Parameters

Type

Description

trackType

AoqTrackType

Type de piste vidéo. Pour plus d'informations, consultez AoqTrackType.

frame

AoqVideoFrame&

Données de trame vidéo avant encodage. Pour plus d'informations, consultez AoqVideoFrame.

Valeur de retour : 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.
virtual bool onRemoteVideoFrame(AoqTrackType trackType, AoqVideoFrame& frame) = 0;
Paramètres

Parameters

Type

Description

trackType

AoqTrackType

Type de piste vidéo. Pour plus d'informations, consultez AoqTrackType.

frame

AoqVideoFrame&

Données de trame vidéo distante. Pour plus d'informations, consultez AoqVideoFrame.

Valeur de retour : 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.