Skip to main content

Référence de l'API macOS du SDK client AOQ

Cette rubrique décrit les API Objective-C, les rappels et les types de données du SDK client AOQ pour macOS.

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 sous forme de singleton global, fournit des API via la classe AoqClientEngine et signale les événements asynchrones via le protocole AoqEngineDelegate.

Index API

Cycle de vie du moteur

APIDescription
createEngineCréer une instance de moteur (singleton)
destroyDétruire l'instance du moteur
getVersionObtenir la version du SDK
connectSe connecter au serveur Relay
disconnectSe déconnecter du serveur

Gestion des périphériques audio

APIDescription
startAudioCaptureOuvrir le périphérique de capture audio (microphone)
stopAudioCaptureFermer le périphérique de capture audio
muteAudioCaptureMettre en sourdine ou réactiver la capture audio
startAudioPlayerDémarrer le rendu audio (lecture audio distante)
stopAudioPlayerArrêter le rendu audio
pauseAudioPlayerMettre en pause le rendu audio, avec fondu sortant optionnel
resumeAudioPlayerReprendre le rendu audio, avec fondu entrant optionnel
interruptAudioPlayerInterrompre la session audio actuelle

Configuration de l'encodage audio

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

Lecture de fichier audio

APIDescription
startAudioFileDémarrer la lecture et la publication d'un fichier audio local
stopAudioFileArrêter la lecture du fichier audio
pauseAudioFileMettre en pause la lecture du fichier audio
resumeAudioFileReprendre la lecture du fichier audio
getAudioFileDurationObtenir la durée totale du fichier audio
getAudioFileCurrentPositionObtenir la position de lecture actuelle du fichier audio
setAudioFilePositionMillisSe positionner à un endroit dans le fichier audio
setAudioFileVolumeDéfinir le volume du fichier audio
getAudioFileVolumeObtenir le volume actuel du fichier audio

Flux audio externes

APIDescription
addAudioExternalStreamAjouter un flux audio externe
pushAudioExternalStreamDataPousser des données audio PCM externes
setAudioExternalStreamVolumeDéfinir le volume du flux audio externe
getAudioExternalStreamVolumeObtenir le volume du flux audio externe
clearAudioExternalStreamBufferEffacer le tampon du flux audio externe
removeAudioExternalStreamSupprimer un flux audio externe

Callbacks de trames audio

APIDescription
setAudioFrameObserverDéfinir le délégué de rappel de trame audio
enableAudioFrameObserverActiver ou désactiver les rappels de trames audio à une étape spécifiée

Indication du volume audio local

APIDescription
enableLocalAudioVolumeIndicationActiver ou désactiver l'indication du volume de capture locale

Gestion des périphériques vidéo

APIDescription
startVideoCaptureOuvrir le périphérique de capture vidéo (caméra)
stopVideoCaptureFermer le périphérique de capture vidéo
setLocalViewDéfinir ou supprimer la fenêtre de rendu vidéo locale
setRemoteViewDéfinir ou supprimer la fenêtre de rendu vidéo distante

Encodage vidéo et entrée externe

APIDescription
setVideoEncoderConfigDéfinir les paramètres d'encodage vidéo
setVideoDecoderConfigDéfinir les paramètres de décodage vidéo
pushExternalVideoCapturedFramePousser des trames vidéo capturées en externe
pushExternalVideoEncodedFramePousser des trames vidéo encodées en externe

Capture d'écran

APIDescription
getScreenSourceListObtenir la liste des sources de capture d'écran (bureau Mac uniquement)
startScreenCaptureDémarrer la capture d'écran
stopScreenCaptureArrêter la capture d'écran

Contrôle de la transmission des flux multimédias

APIDescription
enableSendMediaStreamActiver ou désactiver la transmission du flux multimédia local

Callbacks de trames vidéo

APIDescription
setVideoFrameObserverDéfinir le délégué de rappel de trame vidéo
enableVideoFrameObserverActiver ou désactiver les rappels de trames vidéo à une étape spécifiée

Messages temps réel

APIDescription
sendDataMsgEnvoyer un message de données en temps réel

AoqEngineDelegate

APIDescription
onErrorCallback d'erreur du moteur
onWarningCallback d'avertissement du moteur
onConnectionStatusChangeRappel de changement d'état de connexion
onStatsCallback de statistiques du moteur
onAudioDeviceStateChangedRappel de changement d'état de fonctionnement du périphérique audio
onAudioDeviceRouteChangedRappel de changement de route de sortie audio
onAudioFileStateRappel d'état de lecture de fichier audio
onLocalAudioVolumeIndicationRappel d'indication de volume de capture locale
onVideoDeviceStateChangedRappel de changement d'état de fonctionnement du périphérique vidéo
onDataMsgRappel de message de données en temps réel reçu

AoqAudioFrameDelegate

APIDescription
onCapturedAudioFrameAppelé lorsqu'une trame audio brute est capturée. La trame contient des données PCM non traitées.
onProcessCapturedAudioFrameAppelé pour une trame audio après traitement 3A, tel que l'annulation d'écho et la suppression du bruit.
onPublishAudioFrameAppelé pour une trame audio avant la publication, immédiatement avant l'encodage et la transmission.
onPlaybackAudioFrameAppelé pour une trame audio distante avant la lecture, après le décodage et le mixage.

AoqVideoFrameDelegate

APIDescription
onCapturedVideoFrameAppelé lorsqu'une trame vidéo brute est capturée, avant le prétraitement. trackType distingue les pistes Vidéo et Écran.
onPreEncodeVideoFrameAppelé pour une trame vidéo après le prétraitement et avant l'encodage.
onRemoteVideoFrameAppelé pour une trame vidéo distante après décodage et avant rendu.

Détails de l'API

Cycle de vie du moteur

createEngine:delegate:

Crée l'instance du moteur. Le SDK conserve le moteur sous forme de singleton global, donc appeler cette méthode à nouveau retourne l'instance existante.
+ (instancetype _Nonnull)createEngine:(AoqCreateConfig * _Nonnull)config
                             delegate:(id<AoqEngineDelegate> _Nonnull)delegate;
Paramètres

Paramètres

Type

Description

config

AoqCreateConfig *

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

delegate

id<AoqEngineDelegate>

Délégué de callback d'événements du moteur. Pour plus d'informations, voir AoqEngineDelegate.

Retourne : L'instance du moteur. nil n'est jamais retourné.

destroy

Détruit l'instance du moteur. Après la destruction du moteur, vous devez appeler createEngine:delegate: à nouveau avant de pouvoir continuer à l'utiliser.
+ (int)destroy;
Retourne : 0 en cas de succès ; valeur non nulle en cas d'échec.

getVersion

Obtient la version du SDK.
+ (NSString * _Nonnull)getVersion;
Retourne : La chaîne de version.

connect :

Se connecte 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, voir Authentification par jeton.
- (int)connect:(AoqConnectConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqConnectConfig *

Configuration de l'authentification de connexion. Pour plus d'informations, voir AoqConnectConfig.

Retour : 0 indique que l'appel est dispatché et s'exécute de manière asynchrone ; une valeur non nulle indique que la validation des paramètres a échoué.

disconnect

Se déconnecte du serveur.
- (int)disconnect;
Retour : 0 indique que l'appel est dispatché et s'exécute de manière asynchrone ; une valeur non nulle indique un échec.

Gestion des périphériques audio

startAudioCapture :

Ouvre le périphérique de capture audio (microphone).
- (int)startAudioCapture:(AoqAudioCaptureConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqAudioCaptureConfig *

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

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

stopAudioCapture

Ferme le périphérique de capture audio.
- (int)stopAudioCapture;
Retourne : 0 en cas de succès ; valeur non nulle en cas d'échec.

muteAudioCapture :

Active ou désactive la capture audio.
- (int)muteAudioCapture:(BOOL)mute;
Paramètres

Paramètres

Type

Description

mute

BOOL

YES coupe le son ; NO rétablit le son

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

startAudioPlayer :

Démarre le rendu audio pour lire l'audio distant.
- (int)startAudioPlayer:(AoqAudioPlaybackConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqAudioPlaybackConfig *

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

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

stopAudioPlayer

Arrête le rendu audio.
- (int)stopAudioPlayer;
Retourne : 0 en cas de succès ; valeur non nulle en cas d'échec.

pauseAudioPlayer :

Met en pause le rendu audio, avec prise en charge du fondu sortant.
- (int)pauseAudioPlayer:(NSInteger)fadeMs;
Paramètres

Paramètres

Type

Description

fadeMs

NSInteger

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

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

resumeAudioPlayer :

Reprend le rendu audio, avec prise en charge du fondu entrant.
- (int)resumeAudioPlayer:(NSInteger)fadeMs;
Paramètres

Paramètres

Type

Description

fadeMs

NSInteger

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

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

interruptAudioPlayer:fadeMs:

Interrompt la session audio actuelle et arrête l'audio en cours de lecture.
- (int)interruptAudioPlayer:(AoqTrackType)trackType fadeMs:(NSInteger)fadeMs;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

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

fadeMs

NSInteger

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

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

Configuration de l'encodage audio

setAudioEncoderConfig :

Définit les paramètres d'encodage audio.
- (int)setAudioEncoderConfig:(AoqAudioCodecConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqAudioCodecConfig *

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

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

setAudioDecoderConfig :

Définit les paramètres de décodage audio.
- (int)setAudioDecoderConfig:(AoqAudioCodecConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqAudioCodecConfig *

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

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

Lecture de fichier audio

startAudioFile:config:

Démarre la lecture d'un fichier audio local vers le flux de publication.
- (int)startAudioFile:(NSString * _Nonnull)fileId
               config:(AoqAudioFileMixConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

fileId

NSString *

ID du fichier audio. La couche métier doit garantir qu'il est unique.

config

AoqAudioFileMixConfig *

Configuration du mixage de fichiers audio. Pour plus d'informations, voir AoqAudioFileMixConfig.

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

stopAudioFile :

Arrête la lecture du fichier audio.
- (int)stopAudioFile:(NSString * _Nonnull)fileId;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

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

pauseAudioFile :

Met en pause la lecture du fichier audio.
- (int)pauseAudioFile:(NSString * _Nonnull)fileId;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

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

resumeAudioFile :

Reprend la lecture du fichier audio.
- (int)resumeAudioFile:(NSString * _Nonnull)fileId;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

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

getAudioFileDuration :

Obtient la durée totale du fichier audio.
- (long long)getAudioFileDuration:(NSString * _Nonnull)fileId;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

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.

getAudioFileCurrentPosition:

Obtient la position de lecture actuelle du fichier audio.
- (long long)getAudioFileCurrentPosition:(NSString * _Nonnull)fileId;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

Retour : une valeur supérieure ou égale à 0 indique la position de lecture actuelle, en millisecondes ; une valeur inférieure à 0 indique un échec.

setAudioFilePositionMillis:positionMillis:

Définit la position de lecture du fichier audio (recherche).
- (int)setAudioFilePositionMillis:(NSString * _Nonnull)fileId
                  positionMillis:(long long)positionMillis;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

positionMillis

long long

Position de lecture, en millisecondes

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

setAudioFileVolume:type:volume:

Définit le volume du fichier audio.
- (int)setAudioFileVolume:(NSString * _Nonnull)fileId
                     type:(AoqAudioStreamDirection)type
                   volume:(NSInteger)volume;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

type

AoqAudioStreamDirection

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

volume

NSInteger

Valeur du volume. Valeurs valides : 0 à 100.

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

getAudioFileVolume:type:

Obtient le volume actuel du fichier audio.
- (int)getAudioFileVolume:(NSString * _Nonnull)fileId
                     type:(AoqAudioStreamDirection)type;
Paramètres

Paramètres

Type

Description

fileId

NSString *

Audio file ID

type

AoqAudioStreamDirection

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

Retour : une valeur de 0 à 100 indique le volume ; une valeur inférieure à 0 indique un échec.

Flux audio externes

addAudioExternalStream:config:

Ajoute un flux audio externe.
- (int)addAudioExternalStream:(NSString * _Nonnull)streamId
                       config:(AoqAudioExternalStreamConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

streamId

NSString *

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

config

AoqAudioExternalStreamConfig *

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

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

pushAudioExternalStreamData:data:

Fournit des données PCM audio externes. Si AoqECAudioExternalBufferFull (110) est retourné, le tampon du SDK est plein, et nous vous recommandons d'attendre environ 20 ms avant de renvoyer la trame de données actuelle.
- (int)pushAudioExternalStreamData:(NSString * _Nonnull)streamId
                              data:(AoqAudioFrameData * _Nonnull)data;
Paramètres

Paramètres

Type

Description

streamId

NSString *

ID du flux audio externe

data

AoqAudioFrameData *

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

Retourne : 0 en cas de succès ; valeur non nulle en cas d'échec.
Meilleure pratique : dans les scénarios de capture en temps réel, poussez 10 ms de données à la fois et poussez dès que des données sont disponibles. Lorsque les données proviennent d'un fichier, poussez 40 ms de données à la fois à des intervalles de 30 ms, et gérez la valeur de retour AoqECAudioExternalBufferFull.

setAudioExternalStreamVolume:type:volume:

Définit le volume d'un flux audio externe.
- (int)setAudioExternalStreamVolume:(NSString * _Nonnull)streamId
                               type:(AoqAudioStreamDirection)type
                             volume:(NSInteger)volume;
Paramètres

Paramètres

Type

Description

streamId

NSString *

ID du flux audio externe

type

AoqAudioStreamDirection

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

volume

NSInteger

Valeur du volume. Valeurs valides : 0 à 100.

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

getAudioExternalStreamVolume:type:

Obtient le volume d'un flux audio externe.
- (int)getAudioExternalStreamVolume:(NSString * _Nonnull)streamId
                               type:(AoqAudioStreamDirection)type;
Paramètres

Paramètres

Type

Description

streamId

NSString *

ID du flux audio externe

type

AoqAudioStreamDirection

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

Retour : une valeur de 0 à 100 indique le volume ; une valeur inférieure à 0 indique un échec.

clearAudioExternalStreamBuffer:fadeoutMs:

Efface le tampon d'un flux audio externe.
- (void)clearAudioExternalStreamBuffer:(NSString * _Nonnull)streamId
                              fadeoutMs:(NSInteger)fadeoutMs;
Paramètres

Paramètres

Type

Description

streamId

NSString *

ID du flux audio externe

fadeoutMs

NSInteger

Durée du fondu sortant. -1 utilise le fondu sortant par défaut du SDK, 0 efface tout sans fondu sortant, et une valeur supérieure à 0 maintient un fondu sortant du nombre de millisecondes spécifié.

Retourne : None.

removeAudioExternalStream :

Supprime un flux audio externe.
- (int)removeAudioExternalStream:(NSString * _Nonnull)streamId;
Paramètres

Paramètres

Type

Description

streamId

NSString *

ID du flux audio externe

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

Callbacks de trames audio

setAudioFrameObserver :

Définit le délégué de callback des données de trame audio. Passez nil pour arrêter les callbacks. Après avoir défini le délégué, appelez enableAudioFrameObserver:audioSource:config: pour activer le callback pour la source de données correspondante.
- (int)setAudioFrameObserver:(id<AoqAudioFrameDelegate> _Nullable)delegate;
Paramètres

Paramètres

Type

Description

delegate

id<AoqAudioFrameDelegate>

Délégué de callback de trame audio. Pour plus d'informations, voir AoqAudioFrameDelegate. Passez nil pour arrêter les callbacks.

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

enableAudioFrameObserver:audioSource:config:

Active ou désactive le rappel de trame audio à une position spécifiée.
- (int)enableAudioFrameObserver:(BOOL)enabled
                   audioSource:(AoqAudioSource)audioSource
                        config:(AoqAudioObserverConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

enabled

BOOL

Spécifie s'il faut autoriser les rappels de données

audioSource

AoqAudioSource

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

config

AoqAudioObserverConfig *

Paramètres de callback. Pour plus d'informations, voir AoqAudioObserverConfig.

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

Indication du volume audio local

enableLocalAudioVolumeIndication:

Active ou désactive l'indication du volume de capture locale. Une fois activée, le callback onLocalAudioVolumeIndication: est déclenché à l'intervalle spécifié par config.interval. Si config.interval <= 0, le callback est désactivé. Vous devez appeler cette méthode après startAudioCapture: pour obtenir les données de volume.
- (int)enableLocalAudioVolumeIndication:(AoqAudioVolumeIndicationConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqAudioVolumeIndicationConfig *

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

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

Gestion des périphériques vidéo

startVideoCapture :

Ouvre le périphérique de capture vidéo (caméra). Lorsque isExternal=YES est configuré, la caméra n'est pas ouverte et les trames sont fournies par pushExternalVideoCapturedFrame:frame:.
- (int)startVideoCapture:(AoqVideoCaptureConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqVideoCaptureConfig *

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

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

stopVideoCapture

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

setLocalView:canvas:

Définit ou supprime la fenêtre de rendu vidéo locale. Si vous passez nil pour canvas ou si canvas.view est nil, la liaison est supprimée.
- (int)setLocalView:(AoqTrackType)trackType canvas:(AoqVideoCanvas * _Nullable)canvas;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Piste vidéo. Passer AoqTrackTypeVideo.

canvas

AoqVideoCanvas *

Canvas de rendu. Pour plus d'informations, voir AoqVideoCanvas. Passez nil pour supprimer la liaison.

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

setRemoteView:canvas:

Définit ou supprime la fenêtre de rendu vidéo distante. Si vous passez nil pour canvas ou si canvas.view est nil, la liaison est supprimée.
- (int)setRemoteView:(AoqTrackType)trackType canvas:(AoqVideoCanvas * _Nullable)canvas;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Piste vidéo. Passer AoqTrackTypeVideo.

canvas

AoqVideoCanvas *

Canvas de rendu. Pour plus d'informations, voir AoqVideoCanvas. Passez nil pour supprimer la liaison.

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

Encodage vidéo et entrée externe

setVideoEncoderConfig :

Définit les paramètres d'encodage vidéo et les route en fonction de config.trackType.
- (int)setVideoEncoderConfig:(AoqVideoCodecConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqVideoCodecConfig *

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

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

setVideoDecoderConfig :

Définit les paramètres de décodage vidéo (une proposition de codec côté abonnement, qui doit être appelée avant connect:). L'appel est routé en fonction de config.trackType.
- (int)setVideoDecoderConfig:(AoqVideoCodecConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

config

AoqVideoCodecConfig *

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

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

pushExternalVideoCapturedFrame:frame:

Pousse une trame vidéo externe. Vous devez d'abord appeler startVideoCapture: et configurer isExternal=YES. Si la capture vidéo externe n'est pas démarrée ou si le format n'est pas pris en charge, AoqECParamInvalid est retourné.
- (int)pushExternalVideoCapturedFrame:(AoqTrackType)trackType
                                frame:(AoqVideoFrame * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Cible de routage. Passer AoqTrackTypeVideo.

; AoqTrackTypeScreen est également pris en charge

frame

AoqVideoFrame *

Données de trame vidéo externe. Pour plus d'informations, voir AoqVideoFrame.

Retour : 0 en cas de succès ; AoqECVideoExternalBufferFull (210) indique que le tampon est plein ; une valeur inférieure à 0 indique une autre erreur.

pushExternalVideoEncodedFrame:frame:

Pousse une trame vidéo encodée externement directement, en contournant l'encodeur. Vous devez d'abord appeler setVideoEncoderConfig: et configurer isExternal=YES. Seul le format JPEG est actuellement pris en charge.
- (int)pushExternalVideoEncodedFrame:(AoqTrackType)trackType
                               frame:(AoqVideoEncodedFrame * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Cible de routage. Passer AoqTrackTypeVideo.

; AoqTrackTypeScreen est également pris en charge

frame

AoqVideoEncodedFrame *

Données de trame encodées externement. Pour plus d'informations, voir AoqVideoEncodedFrame.

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

Capture d'écran

- (int)startScreenCapture:(AoqScreenCaptureConfig * _Nonnull)config;
- (int)stopScreenCapture;
config spécifie les paramètres de capture d'écran. Le contenu de l'écran est envoyé sur la piste AoqTrackTypeScreen. Retourne 0 en cas de succès ou une valeur non nulle en cas d'échec. Ces méthodes retournent de manière synchrone et ne fournissent pas de callback onScreenCaptureStateChanged. Appelez getScreenSourceList pour énumérer les écrans et les fenêtres, puis transmettez les sourceId et sourceType sélectionnés dans la configuration de capture. Pour les trames brutes externes, définissez isExternal=YES et fournissez des trames d'écran brutes via pushExternalVideoCapturedFrame pour l'encodage par le SDK. Pour les trames encodées externes, configurez la piste Écran pour l'encodage externe avec setVideoEncoderConfig, puis appelez pushExternalVideoEncodedFrame.

getScreenSourceList

- (AoqScreenSourceList * _Nullable)getScreenSourceList;
Retourne une liste de sources d'écran, ou nil en cas d'échec.

Contrôle de la transmission des flux multimédias

enableSendMediaStream:enable:

Active ou désactive l'envoi d'un flux multimédia local. Nous vous recommandons de désactiver l'envoi après l'initialisation et de ne l'activer qu'après que le callback onConnectionStatusChange: signale AoqConnectionStatusConnected.
- (int)enableSendMediaStream:(AoqTrackType)trackType enable:(BOOL)enable;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

Cible de routage. AoqTrackTypeAudio et AoqTrackTypeVideo sont pris en charge.

; prend également en charge AoqTrackTypeScreen

enable

BOOL

YES active l'envoi ; NO désactive l'envoi

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

Callbacks de trames vidéo

setVideoFrameObserver :

Définit le délégué de callback des données de trame vidéo. Passez nil pour arrêter les callbacks. Après avoir défini le délégué, appelez enableVideoFrameObserver:videoSource:config: pour activer le callback pour la source de données correspondante.
- (int)setVideoFrameObserver:(id<AoqVideoFrameDelegate> _Nullable)delegate;
Paramètres

Paramètres

Type

Description

delegate

id<AoqVideoFrameDelegate>

Délégué de callback de trame vidéo. Pour plus d'informations, voir AoqVideoFrameDelegate. Passez nil pour arrêter les callbacks.

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

enableVideoFrameObserver:videoSource:config:

Active ou désactive le rappel de trame vidéo à une position spécifiée.
- (int)enableVideoFrameObserver:(BOOL)enabled
                    videoSource:(AoqVideoSource)videoSource
                         config:(AoqVideoObserverConfig * _Nonnull)config;
Paramètres

Paramètres

Type

Description

enabled

BOOL

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

videoSource

AoqVideoSource

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

config

AoqVideoObserverConfig *

Paramètres de callback. Pour plus d'informations, voir AoqVideoObserverConfig.

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

Messages temps réel

sendDataMsg :

Envoie un message de données en temps réel.
- (int)sendDataMsg:(AoqDataMsg * _Nonnull)msg;
Paramètres

Paramètres

Type

Description

msg

AoqDataMsg *

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

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

AoqEngineDelegate

AoqEngineDelegate est le point d'entrée unique pour toutes les notifications d'événements asynchrones du SDK. Il est transmis lorsque vous appelez createEngine:delegate:. Toutes les méthodes de callback sont @required. Transitions d'état : Disconnected → Connecting → Connected/Failed → Disconnected.

onError:message:

Callback d'erreur du moteur.
- (void)onError:(NSInteger)code message:(NSString * _Nonnull)message;
Paramètres

Paramètres

Type

Description

code

NSInteger

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

message

NSString *

Description de l'erreur

onWarning:message:

Callback d'avertissement du moteur.
- (void)onWarning:(NSInteger)code message:(NSString * _Nonnull)message;
Paramètres

Paramètres

Type

Description

code

NSInteger

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

message

NSString *

Description de l'avertissement

onConnectionStatusChange :

Rappel de changement d'état de connexion du moteur.
- (void)onConnectionStatusChange:(AoqConnectionStatus)status;
Paramètres

Paramètres

Type

Description

status

AoqConnectionStatus

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

onStats :

Callback de statistiques du moteur.
- (void)onStats:(AoqStats * _Nonnull)stats;
Paramètres

Paramètres

Type

Description

stats

AoqStats *

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

onAudioDeviceStateChanged :

Callback pour les changements d'état des opérations de capture et de lecture du périphérique audio.
- (void)onAudioDeviceStateChanged:(AoqAudioDeviceState * _Nonnull)state;
Paramètres

Paramètres

Type

Description

state

AoqAudioDeviceState *

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

onAudioDeviceRouteChanged :

Rappel de changement de route de sortie audio.
- (void)onAudioDeviceRouteChanged:(NSInteger)routeType;
Paramètres

Paramètres

Type

Description

routeType

NSInteger

Type de route. Pour les valeurs valides, voir AoqAudioDeviceRouteType.

onAudioFileState :

Rappel pour l'état de lecture du fichier audio.
- (void)onAudioFileState:(AoqAudioFileState * _Nonnull)state;
Paramètres

Paramètres

Type

Description

state

AoqAudioFileState *

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

onLocalAudioVolumeIndication:

Callback d'indication du volume de capture locale. Pour l'activer, appelez enableLocalAudioVolumeIndication:.
- (void)onLocalAudioVolumeIndication:(AoqAudioVolume * _Nonnull)volume;
Paramètres

Paramètres

Type

Description

volume

AoqAudioVolume *

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

onVideoDeviceStateChanged :

Rappel pour les changements d'état de fonctionnement de la capture du périphérique vidéo.
- (void)onVideoDeviceStateChanged:(AoqVideoDeviceState * _Nonnull)state;
Paramètres

Paramètres

Type

Description

state

AoqVideoDeviceState *

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

onDataMsg :

Rappel pour un message de données en temps réel reçu.
- (void)onDataMsg:(AoqDataMsg * _Nonnull)msg;
Paramètres

Paramètres

Type

Description

msg

AoqDataMsg *

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

AoqAudioFrameDelegate

Protocole pour les callbacks de données de trame audio. Toutes les méthodes sont @optional. N'effectuez aucune opération chronophage dans les callbacks. Sinon, des anomalies audio peuvent survenir.

onCapturedAudioFrame :

Callback pour les données capturées brutes. Pour l'activer, appelez enableAudioFrameObserver: et définissez audioSource = AoqAudioSourceCaptured. Vous pouvez définir la fréquence d'échantillonnage et le nombre de canaux, et le mode lecture-écriture est pris en charge.
- (void)onCapturedAudioFrame:(AoqAudioFrameData * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

frame

AoqAudioFrameData *

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

onProcessCapturedAudioFrame:

Callback pour les données après traitement 3A. Pour l'activer, appelez enableAudioFrameObserver: et définissez audioSource = AoqAudioSourceProcessCaptured. Vous pouvez définir la fréquence d'échantillonnage et le nombre de canaux, et le mode lecture-écriture est pris en charge.
- (void)onProcessCapturedAudioFrame:(AoqAudioFrameData * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

frame

AoqAudioFrameData *

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

onPublishAudioFrame:frame:

Callback pour les données de publication. Pour l'activer, appelez enableAudioFrameObserver: et définissez audioSource = AoqAudioSourcePublish. Vous pouvez définir la fréquence d'échantillonnage et le nombre de canaux, et seul le mode lecture seule est pris en charge.
- (void)onPublishAudioFrame:(AoqTrackType)trackType
                      frame:(AoqAudioFrameData * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

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

frame

AoqAudioFrameData *

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

onPlaybackAudioFrame :

Callback pour les données de lecture. Pour l'activer, appelez enableAudioFrameObserver: et définissez audioSource = AoqAudioSourcePlayback. Vous pouvez définir la fréquence d'échantillonnage et le nombre de canaux, et le mode lecture-écriture est pris en charge.
- (void)onPlaybackAudioFrame:(AoqAudioFrameData * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

frame

AoqAudioFrameData *

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

AoqVideoFrameDelegate

Protocole pour les callbacks de données de trame vidéo. Toutes les méthodes sont @optional. N'effectuez aucune opération chronophage dans les callbacks. Sinon, des saccades vidéo peuvent survenir. Une valeur de retour de YES indique que les données sont modifiées et doivent être réécrites dans le SDK. La réécriture ne prend effet que pour I420 et CVPixelBuffer. Une valeur de retour de NO indique un accès en lecture seule. Les données dans frame ne sont valides que pendant le callback. Pour les utiliser de manière asynchrone, copiez-les vous-même.

onCapturedVideoFrame :

Callback pour les données brutes locales après capture, avant prétraitement. Pour l'activer, appelez enableVideoFrameObserver: et définissez videoSource = AoqVideoSourceCaptured.
- (BOOL)onCapturedVideoFrame:(AoqTrackType)trackType frame:(AoqVideoFrame * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

frame

AoqVideoFrame *

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

trackTypeAoqTrackTypeType de piste vidéo : Vidéo ou Écran.
Retour : YES indique que les données sont modifiées et doivent être réécrites dans le SDK ; NO indique un accès en lecture seule.

onPreEncodeVideoFrame:frame:

Callback pour les données brutes locales avant encodage, après prétraitement. Pour l'activer, appelez enableVideoFrameObserver: et définissez videoSource = AoqVideoSourcePreEncode.
- (BOOL)onPreEncodeVideoFrame:(AoqTrackType)trackType
                        frame:(AoqVideoFrame * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

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

frame

AoqVideoFrame *

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

Retour : YES indique que les données sont modifiées et doivent être réécrites dans le SDK ; NO indique un accès en lecture seule.

onRemoteVideoFrame:frame:

Callback pour les données brutes distantes après décodage et avant rendu. Pour l'activer, appelez enableVideoFrameObserver: et définissez videoSource = AoqVideoSourceRemote.
- (BOOL)onRemoteVideoFrame:(AoqTrackType)trackType
                     frame:(AoqVideoFrame * _Nonnull)frame;
Paramètres

Paramètres

Type

Description

trackType

AoqTrackType

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

frame

AoqVideoFrame *

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

Retour : YES indique que les données sont modifiées et doivent être réécrites dans le SDK ; NO indique un accès en lecture seule.

Types de données et énumérations

Types courants

AoqCreateConfig

Configuration de création du moteur.

Champ

Type

Valeur par défaut

Description

workDir

NSString *

""

Répertoire de travail du SDK

enableDumpAudio

BOOL

NO

Spécifie s'il faut activer le dump des données audio brutes (pour le débogage)

extras

NSString *

""

Paramètres étendus

maxEncodedVideoFrameBytesNSInteger190 × 1024Taille maximale de la trame encodée en octets. S'applique uniquement à l'encodeur JPEG interne du SDK. Une valeur de 0 désactive la limite.
enableDropOversizedVideoFrameBOOLNOPour l'encodeur JPEG interne au SDK, indique s'il faut abandonner une trame qui reste trop volumineuse même à la qualité la plus basse.

AoqConnectConfig

Configuration pour la connexion au serveur relais.

Champ

Type

Description

token

NSString *

Jeton d'authentification de connexion

sid

NSString *

Session ID

certFingerprint

NSString *

Empreinte du certificat serveur

relayEndpoints

NSArray<AoqRelayEndpoint *> *

Liste des points d'accès relais

workspaceIdHash

NSString *

ID de hachage de l'espace de travail

publishTracks

NSArray<AoqTrackParam *> *

Tableau des attributs de piste de publication locale

subscribeTracks

NSArray<AoqTrackParam *> *

Tableau des attributs de piste d'abonnement local

AoqRelayEndpoint

Point d'accès relais.

Champ

Type

Valeur par défaut

Description

routeIndex

NSInteger

-1

Path index

endpoint

NSString *

""

Adresse du serveur (nom de domaine ou adresse IP)

port

NSInteger

0

Server port

tcpPortNSInteger0Port de secours TCP. Une valeur de 0 utilise le port par défaut du SDK, 443.

AoqTrackParam

Attribut de la piste.

Champ

Type

Valeur par défaut

Description

trackType

AoqTrackType

Audio

Track type

trackMode

AoqTrackMode

Segment

Mode streaming ou non-streaming. Efficace uniquement pour le flux descendant audio.

AoqDataMsg

Structure de données d'un message en temps réel.

Champ

Type

Description

data

NSData *

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

Types de statistiques

AoqStats

Statistiques du moteur.

Champ

Type

Description

audioPublishStats

NSArray<AoqAudioPublishStats *> *

Tableau des statistiques de publication pour l'audio

videoPublishStats

NSArray<AoqVideoPublishStats *> *

Tableau des statistiques de publication pour la vidéo

dataMsgPublishStats

NSArray<AoqDataMsgPublishStats *> *

Tableau des statistiques de publication pour les messages de données

audioSubscribeStats

NSArray<AoqAudioSubscribeStats *> *

Tableau des statistiques d'abonnement pour l'audio

videoSubscribeStats

NSArray<AoqVideoSubscribeStats *> *

Tableau des statistiques d'abonnement pour la vidéo

dataMsgSubscribeStats

NSArray<AoqDataMsgSubscribeStats *> *

Tableau des statistiques d'abonnement pour les messages de données

networkStats

AoqNetworkStats *

Statistiques réseau

AoqNetworkStats

Statistiques réseau.

Champ

Type

Description

sendBitrate

NSUInteger

Débit binaire d'envoi, en bit/s

sendBytes

NSUInteger

Octets envoyés cumulés

recvBitrate

NSUInteger

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

recvBytes

NSUInteger

Octets reçus cumulés

loss

NSUInteger

Taux de perte de paquets, de 0 à 100

rtt

NSUInteger

Latence aller-retour, en ms

AoqAudioPublishStats

Statistiques de publication pour l'audio.

Champ

Type

Description

trackType

AoqTrackType

Track type

bitrate

NSUInteger

Débit binaire, en bit/s

bytes

NSUInteger

Octets cumulés

encodeVolume

NSUInteger

Volume d'encodage du flux publié

AoqVideoPublishStats

Statistiques de publication pour la vidéo.

Champ

Type

Description

trackType

AoqTrackType

Track type

bitrate

NSUInteger

Débit binaire, en bit/s

bytes

NSUInteger

Octets cumulés

encodeFps

NSUInteger

Fréquence d'images d'encodage

AoqDataMsgPublishStats

Statistiques de publication pour les messages de données.

Champ

Type

Description

trackType

AoqTrackType

Track type

bitrate

NSUInteger

Débit binaire, en bit/s

bytes

NSUInteger

Octets cumulés

AoqAudioSubscribeStats

Statistiques d'abonnement pour l'audio.

Champ

Type

Description

trackType

AoqTrackType

Track type

bitrate

NSUInteger

Débit binaire, en bit/s

bytes

NSUInteger

Octets cumulés

playVolume

NSUInteger

Volume de lecture

AoqVideoSubscribeStats

Statistiques d'abonnement pour la vidéo.

Champ

Type

Description

trackType

AoqTrackType

Track type

bitrate

NSUInteger

Débit binaire, en bit/s

bytes

NSUInteger

Octets cumulés

decodeFps

NSUInteger

Fréquence d'images de décodage

renderFps

NSUInteger

Fréquence d'images de rendu

AoqDataMsgSubscribeStats

Statistiques d'abonnement pour les messages de données.

Champ

Type

Description

trackType

AoqTrackType

Track type

bitrate

NSUInteger

Débit binaire, en bit/s

bytes

NSUInteger

Octets cumulés

Énumérations

AoqErrorCode

Énumération des codes d'erreur.

Valeur d'énumération

Valeur

Description

AoqECOK

0

Succès

AoqECParamInvalid

1

Paramètre invalide

AoqECStateInvalid

2

Invalid state

AoqECUnSupport

3

L'API n'est pas prise en charge

AoqECAudio

100

Erreur audio générique

AoqECAudioExternalBufferFull

110

Le tampon audio externe est plein

AoqECAudioDevice

120

Erreur générique de 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

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 de périphérique vidéo

AoqECVideoDeviceCameraOpenFail

221

Échec de l'ouverture de la caméra

AoqECVideoDeviceCameraAuthFailed

222

Autorisation de 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 de codec vidéo générique

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 de rendu

AoqWarningCode

Énumération des codes d'avertissement.

Valeur d'énumération

Valeur

Description

AoqWCOK

0

No warning

AoqWCAudio

100

Avertissement audio générique

AoqWCAudioHowling

101

Larsen audio détecté

AoqWCAudioDevice

120

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

AoqWCAudioDeviceMicEnumerateError

121

Erreur d'énumération du microphone

AoqWCAudioDeviceMicStartTimeout

122

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

AoqWCAudioDeviceRecordingError

123

Erreur d'enregistrement

AoqWCAudioDeviceSpeakerEnumerateError

124

Erreur d'énumération du haut-parleur

AoqWCAudioDeviceSpeakerStartTimeout

125

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

AoqWCAudioDevicePlayoutError

126

Playback error

AoqWCVideo

200

Avertissement vidéo générique

AoqWCVideoCameraEnumerateError

201

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

AoqWCVideoEncoderSwitched

202

Encodeur vidéo changé

AoqWCVideoRenderDowngrade

203

Rendu vidéo dégradé

AoqTrackType

Type de piste.

Valeur d'énumération

Valeur

Description

AoqTrackTypeAudio

0

Audio track

AoqTrackTypeVideo

1

Video track

AoqTrackTypeData

2

Piste de messages de données

AoqTrackTypeScreen3Piste de partage d'écran. Prend en charge la liaison montante.

AoqEncoderType

Type d'encodeur.

Valeur d'énumération

Valeur

Description

AoqEncoderTypeUnknown

0

Unknown format

AoqEncoderTypeAudioPCM

1

Audio PCM

AoqEncoderTypeAudioOpus

2

Audio Opus

AoqEncoderTypeVideoH264

3

Vidéo H.264

AoqEncoderTypeVideoJpeg

4

Video JPEG

AoqEncoderTypeDataText

5

Message text

AoqTrackMode

Mode streaming ou non-streaming. Efficace uniquement pour le flux descendant audio.

Valeur d'énumération

Valeur

Description

AoqTrackModeSegment

0

Segmenté : les données sont empaquetées et livrées en segments sémantiques, tels qu'une phrase.

AoqTrackModeStream

1

Streaming : les données sont livrées en continu.

AoqConnectionStatus

État de connexion du moteur.

Valeur d'énumération

Valeur

Description

AoqConnectionStatusDisconnected

0

Disconnected

AoqConnectionStatusConnecting

1

Connecting

AoqConnectionStatusConnected

2

Connected

AoqConnectionStatusFailed

3

Échec de la connexion

Types audio

AoqAudioCaptureConfig

Configuration de la capture audio.

Champ

Type

Valeur par défaut

Description

isExternal

BOOL

NO

Spécifie s'il faut utiliser une capture externe

channel

NSInteger

1

Nombre de canaux de capture audio. 1 et 2 sont pris en charge.

AoqAudioPlaybackConfig

Configuration de la lecture audio.

Champ

Type

Valeur par défaut

Description

isExternal

BOOL

NO

Spécifie s'il faut utiliser une lecture externe

channel

NSInteger

1

Nombre de canaux de lecture audio. 1 et 2 sont pris en charge.

AoqAudioCodecConfig

Configuration du codec audio.

Champ

Type

Valeur par défaut

Description

trackType

AoqTrackType

Audio

Track type

codecType

AoqEncoderType

AudioOpus

Codec format

sampleRate

NSInteger

48000

Taux d'échantillonnage, en Hz

channel

NSInteger

1

Nombre de canaux

bitrate

NSInteger

32000

Débit binaire, en bit/s

AoqAudioDeviceStateCode

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

Valeur d'énumération

Valeur

Description

AoqAudioDeviceNone

0

No state

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

Capture failed

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

État du périphérique audio.

Champ

Type

Description

state

AoqAudioDeviceStateCode

Status code

reason

NSInteger

Code d'erreur (AoqErrorCode)

AoqAudioDeviceRouteType

Type de route du périphérique audio.

Valeur d'énumération

Valeur

Description

AoqAudioDeviceRouteDefault

0

Valeur par défaut

AoqAudioDeviceRouteHeadset

1

Headphones

AoqAudioDeviceRouteEarpiece

2

Receiver

AoqAudioDeviceRouteHeadsetNoMic

3

Écouteurs sans microphone

AoqAudioDeviceRouteSpeakerPhone

4

Haut-parleur intégré

AoqAudioDeviceRouteUsb

5

USB

AoqAudioDeviceRouteBluetooth

6

Bluetooth

AoqAudioDeviceRouteBluetoothA2dp

7

Bluetooth A2DP

Types de fichiers audio

AoqAudioFileMixConfig

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

Champ

Type

Valeur par défaut

Description

fileName

NSString *

-

Nom du fichier (y compris le chemin). Obligatoire.

cycles

NSInteger

-1

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

startPosMs

NSInteger

0

Position de début de lecture, en ms

publishVolume

NSInteger

100

Volume de publication. Valeurs valides : 0 à 100.

playoutVolume

NSInteger

100

Volume de lecture. Valeurs valides : 0 à 100.

AoqAudioFileStateCode

Code d'état du fichier audio.

Valeur d'énumération

Valeur

Description

AoqAudioFileNone

0

No state

AoqAudioFileStarted

1

Started

AoqAudioFileStopped

2

Arrêté

AoqAudioFilePaused

3

Paused

AoqAudioFileResumed

4

Resumed

AoqAudioFileEnded

5

Lecture terminée

AoqAudioFileBuffering

6

Buffering

AoqAudioFileBufferingEnd

7

Fin de la mise en mémoire tampon

AoqAudioFileFailed

8

Échec de la lecture

AoqAudioFileErrorCode

Code d'erreur de lecture de fichier audio.

Valeur d'énumération

Valeur

Description

AoqAudioFileNoError

0

No error

AoqAudioFileOpenFailed

1

Échec de l'ouverture du fichier

AoqAudioFileDecodeFailed

2

Échec du décodage du fichier

AoqAudioFileState

État du fichier audio.

Champ

Type

Description

fileId

NSString *

File ID

stateCode

AoqAudioFileStateCode

Status code

errorCode

AoqAudioFileErrorCode

Code d'erreur

Types de flux audio externe et de volume

AoqAudioStreamDirection

Direction d'un flux audio externe.

Valeur d'énumération

Valeur

Description

AoqAudioStreamPublish

0

Publication audio

AoqAudioStreamPlayout

1

Playback audio

AoqAudioExternalStreamToggle

État de basculement du flux audio externe.

Valeur d'énumération

Valeur

Description

AoqAudioExternalStreamToggleNormal

0

Recovered

AoqAudioExternalStreamTogglePause

1

Paused

AoqAudioExternalStreamConfig

Configuration du flux audio externe.

Champ

Type

Valeur par défaut

Description

trackType

AoqTrackType

Audio

Type de piste audio

codecType

AoqEncoderType

AudioPCM

Format de flux audio. Le PCM est pris en charge.

channels

NSInteger

1

Nombre de canaux

sampleRate

NSInteger

48000

Taux d'échantillonnage, en Hz

playoutVolume

NSInteger

100

Volume de lecture. Valeurs valides : 0 à 100.

publishVolume

NSInteger

100

Volume de publication. Valeurs valides : 0 à 100.

maxBufferDuration

NSInteger

1000

Durée maximale du tampon, en ms

enable3A

BOOL

NO

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

AoqAudioFrameData

Données audio externes.

Champ

Type

Description

dataPtr

void *

Pointeur vers les données PCM audio brutes

dataSize

NSInteger

Nombre d'octets des données PCM

numOfSamples

NSInteger

Nombre d'échantillons (par canal)

bytesPerSample

NSInteger

Octets par échantillon

numOfChannels

NSInteger

Nombre de canaux

samplesPerSec

NSInteger

Nombre d'échantillons par seconde

pushSequence

int32_t

Cycle d'entrée PCM

timeStamp

int64_t

Timestamp

autoGenMute

BOOL

Valide dans les callbacks de données. YES indique des données silencieuses générées par le SDK.

AoqAudioSource

Source de données du rappel de trame 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 réussie)

AoqAudioSourcePlayback

3

Données audio à lire

AoqAudioObserverMode

Mode de callback de trame audio.

Valeur d'énumération

Valeur

Description

AoqAudioObserverModeReadOnly

0

Read-only

AoqAudioObserverModeReadWrite

1

Read-write

AoqAudioObserverConfig

Configuration du rappel de trame audio.

Champ

Type

Valeur par défaut

Description

sampleRate

NSInteger

48000

Fréquence d'échantillonnage de l'audio de rappel

channels

NSInteger

1

Nombre de canaux audio dans le rappel

mode

AoqAudioObserverMode

ReadOnly

Mode lecture-écriture

AoqAudioVolumeIndicationConfig

Configuration de l'indication de volume local.
ChampTypeValeur par défautDescription
reportSpeechBOOLNOIndique s'il faut détecter la parole.
intervalNSInteger0Intervalle de callback en millisecondes. Les valeurs de 0 ou moins désactivent les callbacks ; les valeurs entre 0 et 10 utilisent 10.
smoothNSInteger3Facteur de lissage, de 0 à 10. Des valeurs plus élevées produisent des résultats plus lisses.

AoqAudioVolume

Informations sur le volume local.
ChampTypeValeur par défautDescription
isSpeechBOOLNOIndique si la parole est détectée.
volumeNSInteger0Volume instantané lissé, de 0 à 255.

Types vidéo

AoqVideoCaptureConfig

Configuration de la capture vidéo.

Champ

Type

Valeur par défaut

Description

width

NSInteger

1280

Largeur de capture, en pixels. Ce paramètre est inefficace lorsque isExternal=YES.

height

NSInteger

720

Hauteur de capture, en pixels. Ce paramètre est inefficace lorsque isExternal=YES.

fps

NSInteger

15

Fréquence de capture. Ce paramètre est inefficace lorsque isExternal=YES (le rythme est déterminé par la livraison des trames).

isExternal

BOOL

NO

Spécifie s'il faut utiliser une capture externe. Si c'est YES, la caméra n'est pas ouverte et les trames sont fournies par pushExternalVideoCapturedFrame:.

AoqVideoCanvas

Structure de données pour le rendu vidéo.

Champ

Type

Valeur par défaut

Description

view

NSView *

nil

Vue d'affichage. Passer nil pour supprimer la liaison de rendu.

renderMode

AoqRenderMode

Auto

Mode de rendu

L'appelant doit s'assurer que le cycle de vie de view dépasse la période pendant laquelle il est défini par setLocalView: / setRemoteView:.

AoqRenderMode

Mode d'affichage du rendu.

Valeur d'énumération

Valeur

Description

AoqRenderModeAuto

0

Auto mode

AoqRenderModeStretch

1

Mode étirement 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 bandes 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.

AoqRenderView

Le contrôle de vue de rendu, qui hérite de NSView et peut être utilisé comme AoqVideoCanvas.view.

Attribut

Type

Description

engineDisplayView

NSView * (lecture seule)

Vue d'affichage utilisée en interne par le moteur

renderWidth

int (lecture seule)

Largeur de rendu

renderHeight

int (lecture seule)

Hauteur de rendu

enableMetal

BOOL (lecture seule)

Spécifie s'il faut activer le rendu Metal

delegate

id<AoqRenderViewDelegate>

Délégué d'événement de la vue de rendu

AoqRenderViewDelegate

Le protocole délégué d'événement de la vue de rendu.
- (void)onRenderViewSizeChanged:(AoqRenderView * _Nonnull)view;

Callback

Description

onRenderViewSizeChanged:

Rappel pour les changements de taille de la vue de rendu

AoqVideoPixelFormat

Format de pixel vidéo.

Valeur d'énumération

Valeur

Description

AoqVideoPixelFormatUnknown

0

Unknown format

AoqVideoPixelFormatI420

1

I420

AoqVideoPixelFormatNV12

2

NV12

AoqVideoPixelFormatNV21

3

NV21

AoqVideoPixelFormatBGRA

4

BGRA

AoqVideoPixelFormatRGBA

5

RGBA

AoqVideoPixelFormatCVPixelBuffer

6

Chemin zéro copie. Définir le champ pixelBuffer sur CVPixelBufferRef.

AoqVideoFrame

Données vidéo externes.

Champ

Type

Description

format

AoqVideoPixelFormat

Pixel format

width

NSInteger

Largeur, en pixels

height

NSInteger

Hauteur, en pixels

data

NSData *

Données au format packagé (NV12/NV21/BGRA/RGBA)

dataY / dataU / dataV

NSData *

Données des trois plans I420

strideY / strideU / strideV

NSInteger

Pas des trois plans I420

pixelBuffer

CVPixelBufferRef

Zéro copie, utilisé lorsque format=AoqVideoPixelFormatCVPixelBuffer

timeStamp

int64_t

Horodatage, en ms. S'il est égal à 0, le SDK le renseigne avec l'horloge locale.

AoqVideoCodecType

Type de codec de la trame encodée en externe.

Valeur d'énumération

Valeur

Description

AoqVideoCodecTypeJPEG

0

JPEG

AoqVideoEncodedFrame

Une trame vidéo encodée externement. L'appelant effectue l'encodage, et le SDK empaquette et envoie la trame directement sans réencodage.

Champ

Type

Description

codec

AoqVideoCodecType

Codec format

data

NSData *

Encoded data

width

NSInteger

Largeur, en pixels

height

NSInteger

Hauteur, en pixels

timeStamp

int64_t

Horodatage, en ms. S'il est égal à 0, le SDK le renseigne avec l'horloge locale.

AoqVideoCodecConfig

Paramètres de codec vidéo, partagés par l'encodage et le décodage. Pour le décodage, seuls trackType / codecType / width / height / fps / bitrate prennent effet et participent à la négociation en tant que proposition d'abonnement, tandis que les autres champs sont utilisés uniquement pour l'encodage.

Champ

Type

Valeur par défaut

Description

isExternal

BOOL

NO

Mode d'encodage externe. Lorsqu'il est défini sur YES, vous poussez des trames encodées et le SDK n'effectue ni capture ni encodage.

trackType

AoqTrackType

Video

Track type

codecType

AoqEncoderType

VideoH264

Codec format

width

NSInteger

540

Largeur de résolution

height

NSInteger

960

Hauteur de résolution

fps

NSInteger

5

Frame rate

bitrate

NSInteger

500000

Débit binaire initial, en bit/s

minBitrate

NSInteger

128000

Débit binaire minimum, en bit/s

keyframeInterval

NSInteger

2

Intervalle d'images clés, en secondes

mirrorMode

AoqMirrorMode

Disabled

Mirror mode

orientationMode

AoqOrientationMode

Auto

Mode d'orientation

AoqMirrorMode

Mode miroir.

Valeur d'énumération

Valeur

Description

AoqMirrorModeDisabled

0

Désactiver l'effet miroir

AoqMirrorModeEnabled

1

Activer l'effet miroir

AoqOrientationMode

Mode d'orientation.

Valeur d'énumération

Valeur

Description

AoqOrientationModeAuto

0

Auto

AoqOrientationModePortrait

1

Portrait

AoqOrientationModeLandscape

2

Landscape

AoqVideoDeviceStateCode

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

Valeur d'énumération

Valeur

Description

AoqVideoDeviceNone

0

No state

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

AoqVideoDeviceState

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

Champ

Type

Description

state

AoqVideoDeviceStateCode

Status code

reason

NSInteger

Code d'erreur (AoqErrorCode)

AoqVideoSource

Source de données du rappel de trame vidéo (position dans le pipeline).

Valeur d'énumération

Valeur

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 décodage et avant rendu

AoqVideoObserverMode

Mode de callback de trame vidéo.

Valeur d'énumération

Valeur

Description

AoqVideoObserverModeReadOnly

0

Read-only

AoqVideoObserverModeReadWrite

1

Read-write

AoqVideoObserverAlignment

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

Valeur d'énumération

Valeur

Description

AoqVideoObserverAlignmentDefault

0

Valeur par défaut

AoqVideoObserverAlignmentEven

1

Alignement sur nombre pair

AoqVideoObserverAlignment4

2

Alignement sur 4 octets

AoqVideoObserverAlignment8

3

Alignement sur 8 octets

AoqVideoObserverAlignment16

4

Alignement sur 16 octets

AoqVideoObserverConfig

Configuration du rappel de trame vidéo.

Champ

Type

Valeur par défaut

Description

format

AoqVideoPixelFormat

I420

Format de pixel attendu des données de rappel

alignment

AoqVideoObserverAlignment

Default

Politique d'alignement de la largeur

mode

AoqVideoObserverMode

ReadOnly

Mode lecture-écriture. ReadWrite est pris en charge uniquement pour I420 / CVPixelBuffer.

mirrorApplied

BOOL

NO

Spécifie s'il faut appliquer un effet miroir aux données de rappel

trackTypeAoqTrackTypeAoqTrackTypeVideoPiste vidéo à observer. Prend en charge uniquement Vidéo et Écran.

Types de capture d'écran

AoqScreenShareSourceType

ValeurNumberDescription
AoqScreenShareSourceTypeDesktop0Bureau entier
AoqScreenShareSourceTypeWindow1Une fenêtre spécifique

AoqScreenSourceInfo

ChampTypeValeur par défautDescription
sourceTypeAoqScreenShareSourceTypeDesktopSource type
sourceIdint64_t0Source ID
sourceNameNSString *—Source name
sourceIsSelfBOOL—Indique si la fenêtre appartient au processus actuel

AoqScreenSourceList

ChampTypeDescription
sourceListNSArray<AoqScreenSourceInfo *> *Tableau des sources d'écran

AoqScreenCaptureConfig

ChampTypeValeur par défautDescription
isExternalBOOLNOIndique si l'application fournit des trames d'écran brutes.
sourceIdint64_t0ID de la source d'écran.
sourceTypeAoqScreenShareSourceTypeAoqScreenShareSourceTypeWindowType de source d'écran.