Cette rubrique décrit les API Objective-C, les rappels et les types de données du SDK client AOQ pour macOS.
AoqClientEngine et signale les événements asynchrones via le protocole AoqEngineDelegate.
Index API
Cycle de vie du moteur
| API | Description |
|---|---|
| createEngine | Créer une instance de moteur (singleton) |
| destroy | Détruire l'instance du moteur |
| getVersion | Obtenir la version du SDK |
| connect | Se connecter au serveur Relay |
| disconnect | Se déconnecter du serveur |
Gestion des périphériques audio
| API | Description |
|---|---|
| startAudioCapture | Ouvrir le périphérique de capture audio (microphone) |
| stopAudioCapture | Fermer le périphérique de capture audio |
| muteAudioCapture | Mettre en sourdine ou réactiver la capture audio |
| startAudioPlayer | Démarrer le rendu audio (lecture audio distante) |
| stopAudioPlayer | Arrêter le rendu audio |
| pauseAudioPlayer | Mettre en pause le rendu audio, avec fondu sortant optionnel |
| resumeAudioPlayer | Reprendre le rendu audio, avec fondu entrant optionnel |
| interruptAudioPlayer | Interrompre la session audio actuelle |
Configuration de l'encodage audio
| API | Description |
|---|---|
| setAudioEncoderConfig | Définir les paramètres d'encodage audio |
| setAudioDecoderConfig | Définir les paramètres de décodage audio |
Lecture de fichier audio
| API | Description |
|---|---|
| startAudioFile | Démarrer la lecture et la publication d'un fichier audio local |
| stopAudioFile | Arrêter la lecture du fichier audio |
| pauseAudioFile | Mettre en pause la lecture du fichier audio |
| resumeAudioFile | Reprendre la lecture du fichier audio |
| getAudioFileDuration | Obtenir la durée totale du fichier audio |
| getAudioFileCurrentPosition | Obtenir la position de lecture actuelle du fichier audio |
| setAudioFilePositionMillis | Se positionner à un endroit dans le fichier audio |
| setAudioFileVolume | Définir le volume du fichier audio |
| getAudioFileVolume | Obtenir le volume actuel du fichier audio |
Flux audio externes
| API | Description |
|---|---|
| addAudioExternalStream | Ajouter un flux audio externe |
| pushAudioExternalStreamData | Pousser des données audio PCM externes |
| setAudioExternalStreamVolume | Définir le volume du flux audio externe |
| getAudioExternalStreamVolume | Obtenir le volume du flux audio externe |
| clearAudioExternalStreamBuffer | Effacer le tampon du flux audio externe |
| removeAudioExternalStream | Supprimer un flux audio externe |
Callbacks de trames audio
| API | Description |
|---|---|
| setAudioFrameObserver | Définir le délégué de rappel de trame audio |
| enableAudioFrameObserver | Activer ou désactiver les rappels de trames audio à une étape spécifiée |
Indication du volume audio local
| API | Description |
|---|---|
| enableLocalAudioVolumeIndication | Activer ou désactiver l'indication du volume de capture locale |
Gestion des périphériques vidéo
| API | Description |
|---|---|
| startVideoCapture | Ouvrir le périphérique de capture vidéo (caméra) |
| stopVideoCapture | Fermer le périphérique de capture vidéo |
| setLocalView | Définir ou supprimer la fenêtre de rendu vidéo locale |
| setRemoteView | Définir ou supprimer la fenêtre de rendu vidéo distante |
Encodage vidéo et entrée externe
| API | Description |
|---|---|
| setVideoEncoderConfig | Définir les paramètres d'encodage vidéo |
| setVideoDecoderConfig | Définir les paramètres de décodage vidéo |
| pushExternalVideoCapturedFrame | Pousser des trames vidéo capturées en externe |
| pushExternalVideoEncodedFrame | Pousser des trames vidéo encodées en externe |
Capture d'écran
| API | Description |
|---|---|
| getScreenSourceList | Obtenir la liste des sources de capture d'écran (bureau Mac uniquement) |
| startScreenCapture | Démarrer la capture d'écran |
| stopScreenCapture | Arrêter la capture d'écran |
Contrôle de la transmission des flux multimédias
| API | Description |
|---|---|
| enableSendMediaStream | Activer ou désactiver la transmission du flux multimédia local |
Callbacks de trames vidéo
| API | Description |
|---|---|
| setVideoFrameObserver | Définir le délégué de rappel de trame vidéo |
| enableVideoFrameObserver | Activer ou désactiver les rappels de trames vidéo à une étape spécifiée |
Messages temps réel
| API | Description |
|---|---|
| sendDataMsg | Envoyer un message de données en temps réel |
AoqEngineDelegate
| API | Description |
|---|---|
| onError | Callback d'erreur du moteur |
| onWarning | Callback d'avertissement du moteur |
| onConnectionStatusChange | Rappel de changement d'état de connexion |
| onStats | Callback de statistiques du moteur |
| onAudioDeviceStateChanged | Rappel de changement d'état de fonctionnement du périphérique audio |
| onAudioDeviceRouteChanged | Rappel de changement de route de sortie audio |
| onAudioFileState | Rappel d'état de lecture de fichier audio |
| onLocalAudioVolumeIndication | Rappel d'indication de volume de capture locale |
| onVideoDeviceStateChanged | Rappel de changement d'état de fonctionnement du périphérique vidéo |
| onDataMsg | Rappel de message de données en temps réel reçu |
AoqAudioFrameDelegate
| API | Description |
|---|---|
| onCapturedAudioFrame | Appelé lorsqu'une trame audio brute est capturée. La trame contient des données PCM non traitées. |
| onProcessCapturedAudioFrame | Appelé pour une trame audio après traitement 3A, tel que l'annulation d'écho et la suppression du bruit. |
| onPublishAudioFrame | Appelé pour une trame audio avant la publication, immédiatement avant l'encodage et la transmission. |
| onPlaybackAudioFrame | Appelé pour une trame audio distante avant la lecture, après le décodage et le mixage. |
AoqVideoFrameDelegate
| API | Description |
|---|---|
| onCapturedVideoFrame | Appelé lorsqu'une trame vidéo brute est capturée, avant le prétraitement. trackType distingue les pistes Vidéo et Écran. |
| onPreEncodeVideoFrame | Appelé pour une trame vidéo après le prétraitement et avant l'encodage. |
| onRemoteVideoFrame | Appelé 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.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de création du moteur. Pour plus d'informations, voir |
|
| Délégué de callback d'événements du moteur. Pour plus d'informations, voir |
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.
getVersion
Obtient la version du SDK.
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.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de l'authentification de connexion. Pour plus d'informations, voir |
disconnect
Se déconnecte du serveur.
Gestion des périphériques audio
startAudioCapture :
Ouvre le périphérique de capture audio (microphone).
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de capture audio. Pour plus d'informations, voir |
stopAudioCapture
Ferme le périphérique de capture audio.
muteAudioCapture :
Active ou désactive la capture audio.
Paramètres | Type | Description |
|---|---|---|
|
|
|
startAudioPlayer :
Démarre le rendu audio pour lire l'audio distant.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de la lecture audio. Pour plus d'informations, voir |
stopAudioPlayer
Arrête le rendu audio.
pauseAudioPlayer :
Met en pause le rendu audio, avec prise en charge du fondu sortant.
Paramètres | Type | Description |
|---|---|---|
|
| Durée du fondu sortant, en millisecondes. 0 indique une pause immédiate. |
resumeAudioPlayer :
Reprend le rendu audio, avec prise en charge du fondu entrant.
Paramètres | Type | Description |
|---|---|---|
|
| Durée du fondu entrant, en millisecondes. 0 indique une reprise immédiate. |
interruptAudioPlayer:fadeMs:
Interrompt la session audio actuelle et arrête l'audio en cours de lecture.
Paramètres | Type | Description |
|---|---|---|
|
| Type de piste. Pour plus d'informations, voir |
|
| Durée du fondu de sortie, en millisecondes. 0 indique une interruption immédiate. |
Configuration de l'encodage audio
setAudioEncoderConfig :
Définit les paramètres d'encodage audio.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec audio. Pour plus d'informations, voir |
setAudioDecoderConfig :
Définit les paramètres de décodage audio.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec audio. Pour plus d'informations, voir |
Lecture de fichier audio
startAudioFile:config:
Démarre la lecture d'un fichier audio local vers le flux de publication.
Paramètres | Type | Description |
|---|---|---|
|
| ID du fichier audio. La couche métier doit garantir qu'il est unique. |
|
| Configuration du mixage de fichiers audio. Pour plus d'informations, voir |
stopAudioFile :
Arrête la lecture du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
pauseAudioFile :
Met en pause la lecture du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
resumeAudioFile :
Reprend la lecture du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
getAudioFileDuration :
Obtient la durée totale du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
getAudioFileCurrentPosition:
Obtient la position de lecture actuelle du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
setAudioFilePositionMillis:positionMillis:
Définit la position de lecture du fichier audio (recherche).
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
|
| Position de lecture, en millisecondes |
setAudioFileVolume:type:volume:
Définit le volume du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
|
| Direction du flux audio. Pour plus d'informations, voir |
|
| Valeur du volume. Valeurs valides : 0 à 100. |
getAudioFileVolume:type:
Obtient le volume actuel du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| Audio file ID |
|
| Direction du flux audio. Pour plus d'informations, voir |
Flux audio externes
addAudioExternalStream:config:
Ajoute un flux audio externe.
Paramètres | Type | Description |
|---|---|---|
|
| ID de flux audio externe. La couche métier doit garantir son unicité. |
|
| Configuration du flux audio externe. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| Données audio externes brutes. Pour plus d'informations, voir |
AoqECAudioExternalBufferFull.setAudioExternalStreamVolume:type:volume:
Définit le volume d'un flux audio externe.
Paramètres | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| Type de flux audio externe. Pour plus d'informations, voir |
|
| Valeur du volume. Valeurs valides : 0 à 100. |
getAudioExternalStreamVolume:type:
Obtient le volume d'un flux audio externe.
Paramètres | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| Type de flux audio externe. Pour plus d'informations, voir |
clearAudioExternalStreamBuffer:fadeoutMs:
Efface le tampon d'un flux audio externe.
Paramètres | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
|
| 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é. |
removeAudioExternalStream :
Supprime un flux audio externe.
Paramètres | Type | Description |
|---|---|---|
|
| ID du flux audio externe |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Délégué de callback de trame audio. Pour plus d'informations, voir |
enableAudioFrameObserver:audioSource:config:
Active ou désactive le rappel de trame audio à une position spécifiée.
Paramètres | Type | Description |
|---|---|---|
|
| Spécifie s'il faut autoriser les rappels de données |
|
| Type de source de données audio brutes. Pour plus d'informations, voir |
|
| Paramètres de callback. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de l'indication de volume. Pour plus d'informations, voir |
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:.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration de capture vidéo. Pour plus d'informations, voir |
stopVideoCapture
Ferme le périphérique de capture vidéo.
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.
Paramètres | Type | Description |
|---|---|---|
|
| Piste vidéo. Passer |
|
| Canvas de rendu. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Piste vidéo. Passer |
|
| Canvas de rendu. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec vidéo. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Configuration du codec vidéo. Pour plus d'informations, voir |
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é.
Paramètres | Type | Description |
|---|---|---|
|
| Cible de routage. Passer |
|
| Données de trame vidéo externe. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Cible de routage. Passer |
|
| Données de trame encodées externement. Pour plus d'informations, voir |
Capture d'écran
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
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.
Paramètres | Type | Description |
|---|---|---|
|
| Cible de routage. |
|
|
|
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.
Paramètres | Type | Description |
|---|---|---|
|
| Délégué de callback de trame vidéo. Pour plus d'informations, voir |
enableVideoFrameObserver:videoSource:config:
Active ou désactive le rappel de trame vidéo à une position spécifiée.
Paramètres | Type | Description |
|---|---|---|
|
| Spécifie s'il faut activer les rappels de données à une position donnée |
|
| Source de données du callback de trame vidéo (position dans le pipeline). Pour plus d'informations, voir |
|
| Paramètres de callback. Pour plus d'informations, voir |
Messages temps réel
sendDataMsg :
Envoie un message de données en temps réel.
Paramètres | Type | Description |
|---|---|---|
|
| Contenu du message. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Code d'erreur. Pour plus d'informations, voir |
|
| Description de l'erreur |
onWarning:message:
Callback d'avertissement du moteur.
Paramètres | Type | Description |
|---|---|---|
|
| Code d'avertissement. Pour plus d'informations, voir |
|
| Description de l'avertissement |
onConnectionStatusChange :
Rappel de changement d'état de connexion du moteur.
Paramètres | Type | Description |
|---|---|---|
|
| État de la connexion. Pour plus d'informations, voir |
onStats :
Callback de statistiques du moteur.
Paramètres | Type | Description |
|---|---|---|
|
| Données statistiques. Pour plus d'informations, voir |
onAudioDeviceStateChanged :
Callback pour les changements d'état des opérations de capture et de lecture du périphérique audio.
Paramètres | Type | Description |
|---|---|---|
|
| État du périphérique audio. Pour plus d'informations, voir |
onAudioDeviceRouteChanged :
Rappel de changement de route de sortie audio.
Paramètres | Type | Description |
|---|---|---|
|
| Type de route. Pour les valeurs valides, voir |
onAudioFileState :
Rappel pour l'état de lecture du fichier audio.
Paramètres | Type | Description |
|---|---|---|
|
| État de lecture du fichier. Pour plus d'informations, voir |
onLocalAudioVolumeIndication:
Callback d'indication du volume de capture locale. Pour l'activer, appelez enableLocalAudioVolumeIndication:.
Paramètres | Type | Description |
|---|---|---|
|
| Informations sur le volume local. Pour plus d'informations, voir |
onVideoDeviceStateChanged :
Rappel pour les changements d'état de fonctionnement de la capture du périphérique vidéo.
Paramètres | Type | Description |
|---|---|---|
|
| État du périphérique vidéo. Pour plus d'informations, voir |
onDataMsg :
Rappel pour un message de données en temps réel reçu.
Paramètres | Type | Description |
|---|---|---|
|
| Message de données. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Données audio capturées brutes. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Données audio brutes après traitement 3A. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Type de piste. Pour plus d'informations, voir |
|
| Données audio brutes à publier. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Données audio brutes pour la lecture. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Données de trame vidéo capturée. Pour plus d'informations, voir |
| trackType | AoqTrackType | Type de piste vidéo : Vidéo ou Écran. |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Type de piste vidéo. Pour plus d'informations, voir |
|
| Données de trame vidéo avant encodage. Pour plus d'informations, voir |
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.
Paramètres | Type | Description |
|---|---|---|
|
| Type de piste vidéo. Pour plus d'informations, voir |
|
| Données de trame vidéo distante. Pour plus d'informations, voir |
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 |
|---|---|---|---|
|
|
| Répertoire de travail du SDK |
|
|
| Spécifie s'il faut activer le dump des données audio brutes (pour le débogage) |
|
|
| Paramètres étendus |
| maxEncodedVideoFrameBytes | NSInteger | 190 × 1024 | Taille 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. |
| enableDropOversizedVideoFrame | BOOL | NO | Pour 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 |
|---|---|---|
|
| Jeton d'authentification de connexion |
|
| Session ID |
|
| Empreinte du certificat serveur |
|
| Liste des points d'accès relais |
|
| ID de hachage de l'espace de travail |
|
| Tableau des attributs de piste de publication locale |
|
| Tableau des attributs de piste d'abonnement local |
AoqRelayEndpoint
Point d'accès relais.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Path index |
|
|
| Adresse du serveur (nom de domaine ou adresse IP) |
|
|
| Server port |
| tcpPort | NSInteger | 0 | Port 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 |
|---|---|---|---|
|
|
| Track type |
|
|
| 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 |
|---|---|---|
|
| Contenu du message. Il pointe vers la mémoire détenue par l'appelant. |
Types de statistiques
AoqStats
Statistiques du moteur.
Champ | Type | Description |
|---|---|---|
|
| Tableau des statistiques de publication pour l'audio |
|
| Tableau des statistiques de publication pour la vidéo |
|
| Tableau des statistiques de publication pour les messages de données |
|
| Tableau des statistiques d'abonnement pour l'audio |
|
| Tableau des statistiques d'abonnement pour la vidéo |
|
| Tableau des statistiques d'abonnement pour les messages de données |
|
| Statistiques réseau |
AoqNetworkStats
Statistiques réseau.
Champ | Type | Description |
|---|---|---|
|
| Débit binaire d'envoi, en bit/s |
|
| Octets envoyés cumulés |
|
| Débit binaire de réception, en bit/s |
|
| Octets reçus cumulés |
|
| Taux de perte de paquets, de 0 à 100 |
|
| Latence aller-retour, en ms |
AoqAudioPublishStats
Statistiques de publication pour l'audio.
Champ | Type | Description |
|---|---|---|
|
| Track type |
|
| Débit binaire, en bit/s |
|
| Octets cumulés |
|
| Volume d'encodage du flux publié |
AoqVideoPublishStats
Statistiques de publication pour la vidéo.
Champ | Type | Description |
|---|---|---|
|
| Track type |
|
| Débit binaire, en bit/s |
|
| Octets cumulés |
|
| Fréquence d'images d'encodage |
AoqDataMsgPublishStats
Statistiques de publication pour les messages de données.
Champ | Type | Description |
|---|---|---|
|
| Track type |
|
| Débit binaire, en bit/s |
|
| Octets cumulés |
AoqAudioSubscribeStats
Statistiques d'abonnement pour l'audio.
Champ | Type | Description |
|---|---|---|
|
| Track type |
|
| Débit binaire, en bit/s |
|
| Octets cumulés |
|
| Volume de lecture |
AoqVideoSubscribeStats
Statistiques d'abonnement pour la vidéo.
Champ | Type | Description |
|---|---|---|
|
| Track type |
|
| Débit binaire, en bit/s |
|
| Octets cumulés |
|
| Fréquence d'images de décodage |
|
| Fréquence d'images de rendu |
AoqDataMsgSubscribeStats
Statistiques d'abonnement pour les messages de données.
Champ | Type | Description |
|---|---|---|
|
| Track type |
|
| Débit binaire, en bit/s |
|
| Octets cumulés |
Énumérations
AoqErrorCode
Énumération des codes d'erreur.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Succès |
| 1 | Paramètre invalide |
| 2 | Invalid state |
| 3 | L'API n'est pas prise en charge |
| 100 | Erreur audio générique |
| 110 | Le tampon audio externe est plein |
| 120 | Erreur générique de périphérique audio |
| 121 | Autorisation d'enregistrement non accordée |
| 122 | Le périphérique d'enregistrement est en cours d'utilisation |
| 123 | Démarrer l'enregistrement en arrière-plan |
| 124 | Échec du démarrage de l'enregistrement |
| 125 | Le périphérique de lecture est en cours d'utilisation |
| 126 | Démarrer la lecture en arrière-plan |
| 127 | Échec du démarrage de la lecture |
| 200 | Erreur vidéo générique |
| 210 | Le tampon vidéo externe est plein |
| 211 | La capture vidéo externe n'est pas activée |
| 212 | L'encodage vidéo externe n'est pas activé |
| 220 | Erreur générique de périphérique vidéo |
| 221 | Échec de l'ouverture de la caméra |
| 222 | Autorisation de caméra non accordée |
| 223 | La caméra est en cours d'utilisation |
| 224 | Erreur d'exécution de la caméra |
| 230 | Erreur de codec vidéo générique |
| 231 | Échec de l'initialisation de l'encodeur |
| 240 | Erreur générique de rendu vidéo |
| 241 | Échec de la création de la vue de rendu |
| 242 | Erreur de dessin de rendu |
AoqWarningCode
Énumération des codes d'avertissement.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | No warning |
| 100 | Avertissement audio générique |
| 101 | Larsen audio détecté |
| 120 | Avertissement générique de périphérique audio |
| 121 | Erreur d'énumération du microphone |
| 122 | Délai de démarrage du microphone dépassé |
| 123 | Erreur d'enregistrement |
| 124 | Erreur d'énumération du haut-parleur |
| 125 | Délai de démarrage du haut-parleur dépassé |
| 126 | Playback error |
| 200 | Avertissement vidéo générique |
| 201 | Erreur d'énumération de la caméra |
| 202 | Encodeur vidéo changé |
| 203 | Rendu vidéo dégradé |
AoqTrackType
Type de piste.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Audio track |
| 1 | Video track |
| 2 | Piste de messages de données |
| AoqTrackTypeScreen | 3 | Piste de partage d'écran. Prend en charge la liaison montante. |
AoqEncoderType
Type d'encodeur.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Unknown format |
| 1 | Audio PCM |
| 2 | Audio Opus |
| 3 | Vidéo H.264 |
| 4 | Video JPEG |
| 5 | Message text |
AoqTrackMode
Mode streaming ou non-streaming. Efficace uniquement pour le flux descendant audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Segmenté : les données sont empaquetées et livrées en segments sémantiques, tels qu'une phrase. |
| 1 | Streaming : les données sont livrées en continu. |
AoqConnectionStatus
État de connexion du moteur.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Disconnected |
| 1 | Connecting |
| 2 | Connected |
| 3 | Échec de la connexion |
Types audio
AoqAudioCaptureConfig
Configuration de la capture audio.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Spécifie s'il faut utiliser une capture externe |
|
|
| 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 |
|---|---|---|---|
|
|
| Spécifie s'il faut utiliser une lecture externe |
|
|
| 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 |
|---|---|---|---|
|
|
| Track type |
|
|
| Codec format |
|
|
| Taux d'échantillonnage, en Hz |
|
|
| Nombre de canaux |
|
|
| Débit binaire, en bit/s |
AoqAudioDeviceStateCode
Code d'état du périphérique audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | No state |
| 1 | Démarrage de la capture |
| 2 | Capture démarrée |
| 3 | Arrêt de la capture |
| 4 | Capture arrêtée |
| 5 | Capture failed |
| 6 | Démarrage de la lecture |
| 7 | Lecture démarrée |
| 8 | Arrêt de la lecture |
| 9 | Lecture arrêtée |
| 10 | Échec de la lecture |
AoqAudioDeviceState
État du périphérique audio.
Champ | Type | Description |
|---|---|---|
|
| Status code |
|
| Code d'erreur ( |
AoqAudioDeviceRouteType
Type de route du périphérique audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Valeur par défaut |
| 1 | Headphones |
| 2 | Receiver |
| 3 | Écouteurs sans microphone |
| 4 | Haut-parleur intégré |
| 5 | USB |
| 6 | Bluetooth |
| 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 |
|---|---|---|---|
|
| - | Nom du fichier (y compris le chemin). Obligatoire. |
|
|
| Nombre de boucles. -1 indique une boucle illimitée. |
|
|
| Position de début de lecture, en ms |
|
|
| Volume de publication. Valeurs valides : 0 à 100. |
|
|
| Volume de lecture. Valeurs valides : 0 à 100. |
AoqAudioFileStateCode
Code d'état du fichier audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | No state |
| 1 | Started |
| 2 | Arrêté |
| 3 | Paused |
| 4 | Resumed |
| 5 | Lecture terminée |
| 6 | Buffering |
| 7 | Fin de la mise en mémoire tampon |
| 8 | Échec de la lecture |
AoqAudioFileErrorCode
Code d'erreur de lecture de fichier audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | No error |
| 1 | Échec de l'ouverture du fichier |
| 2 | Échec du décodage du fichier |
AoqAudioFileState
État du fichier audio.
Champ | Type | Description |
|---|---|---|
|
| File ID |
|
| Status code |
|
| Code d'erreur |
Types de flux audio externe et de volume
AoqAudioStreamDirection
Direction d'un flux audio externe.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Publication audio |
| 1 | Playback audio |
AoqAudioExternalStreamToggle
État de basculement du flux audio externe.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Recovered |
| 1 | Paused |
AoqAudioExternalStreamConfig
Configuration du flux audio externe.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Type de piste audio |
|
|
| Format de flux audio. Le PCM est pris en charge. |
|
|
| Nombre de canaux |
|
|
| Taux d'échantillonnage, en Hz |
|
|
| Volume de lecture. Valeurs valides : 0 à 100. |
|
|
| Volume de publication. Valeurs valides : 0 à 100. |
|
|
| Durée maximale du tampon, en ms |
|
|
| Spécifie s'il faut appliquer le traitement 3A au PCM d'entrée |
AoqAudioFrameData
Données audio externes.
Champ | Type | Description |
|---|---|---|
|
| Pointeur vers les données PCM audio brutes |
|
| Nombre d'octets des données PCM |
|
| Nombre d'échantillons (par canal) |
|
| Octets par échantillon |
|
| Nombre de canaux |
|
| Nombre d'échantillons par seconde |
|
| Cycle d'entrée PCM |
|
| Timestamp |
|
| Valide dans les callbacks de données. |
AoqAudioSource
Source de données du rappel de trame audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Données audio capturées |
| 1 | Données audio après traitement 3A |
| 2 | Données audio à publier (nécessite une connexion réussie) |
| 3 | Données audio à lire |
AoqAudioObserverMode
Mode de callback de trame audio.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Read-only |
| 1 | Read-write |
AoqAudioObserverConfig
Configuration du rappel de trame audio.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Fréquence d'échantillonnage de l'audio de rappel |
|
|
| Nombre de canaux audio dans le rappel |
|
|
| Mode lecture-écriture |
AoqAudioVolumeIndicationConfig
Configuration de l'indication de volume local.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
| reportSpeech | BOOL | NO | Indique s'il faut détecter la parole. |
| interval | NSInteger | 0 | Intervalle de callback en millisecondes. Les valeurs de 0 ou moins désactivent les callbacks ; les valeurs entre 0 et 10 utilisent 10. |
| smooth | NSInteger | 3 | Facteur de lissage, de 0 à 10. Des valeurs plus élevées produisent des résultats plus lisses. |
AoqAudioVolume
Informations sur le volume local.
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
| isSpeech | BOOL | NO | Indique si la parole est détectée. |
| volume | NSInteger | 0 | Volume instantané lissé, de 0 à 255. |
Types vidéo
AoqVideoCaptureConfig
Configuration de la capture vidéo.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Largeur de capture, en pixels. Ce paramètre est inefficace lorsque |
|
|
| Hauteur de capture, en pixels. Ce paramètre est inefficace lorsque |
|
|
| Fréquence de capture. Ce paramètre est inefficace lorsque |
|
|
| Spécifie s'il faut utiliser une capture externe. Si c'est |
AoqVideoCanvas
Structure de données pour le rendu vidéo.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Vue d'affichage. Passer nil pour supprimer la liaison de rendu. |
|
|
| Mode de rendu |
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 |
|---|---|---|
| 0 | Auto mode |
| 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. |
| 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. |
| 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 |
|---|---|---|
|
| Vue d'affichage utilisée en interne par le moteur |
|
| Largeur de rendu |
|
| Hauteur de rendu |
|
| Spécifie s'il faut activer le rendu Metal |
|
| 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.
Callback | Description |
|---|---|
| Rappel pour les changements de taille de la vue de rendu |
AoqVideoPixelFormat
Format de pixel vidéo.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Unknown format |
| 1 | I420 |
| 2 | NV12 |
| 3 | NV21 |
| 4 | BGRA |
| 5 | RGBA |
| 6 | Chemin zéro copie. Définir le champ |
AoqVideoFrame
Données vidéo externes.
Champ | Type | Description |
|---|---|---|
|
| Pixel format |
|
| Largeur, en pixels |
|
| Hauteur, en pixels |
|
| Données au format packagé (NV12/NV21/BGRA/RGBA) |
|
| Données des trois plans I420 |
|
| Pas des trois plans I420 |
|
| Zéro copie, utilisé lorsque |
|
| 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 |
|---|---|---|
| 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 format |
|
| Encoded data |
|
| Largeur, en pixels |
|
| Hauteur, en pixels |
|
| 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 |
|---|---|---|---|
|
|
| Mode d'encodage externe. Lorsqu'il est défini sur |
|
|
| Track type |
|
|
| Codec format |
|
|
| Largeur de résolution |
|
|
| Hauteur de résolution |
|
|
| Frame rate |
|
|
| Débit binaire initial, en bit/s |
|
|
| Débit binaire minimum, en bit/s |
|
|
| Intervalle d'images clés, en secondes |
|
|
| Mirror mode |
|
|
| Mode d'orientation |
AoqMirrorMode
Mode miroir.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Désactiver l'effet miroir |
| 1 | Activer l'effet miroir |
AoqOrientationMode
Mode d'orientation.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Auto |
| 1 | Portrait |
| 2 | Landscape |
AoqVideoDeviceStateCode
Code d'état du périphérique vidéo.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | No state |
| 1 | Démarrage de la caméra |
| 2 | Caméra démarrée |
| 3 | Arrêt de la caméra |
| 4 | Caméra arrêtée |
| 5 | Échec du démarrage de la caméra |
AoqVideoDeviceState
État du périphérique vidéo.
Champ | Type | Description |
|---|---|---|
|
| Status code |
|
| Code d'erreur ( |
AoqVideoSource
Source de données du rappel de trame vidéo (position dans le pipeline).
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Données vidéo capturées avant le prétraitement |
| 1 | Données vidéo avant l'encodage, après le prétraitement |
| 2 | Données vidéo distantes après décodage et avant rendu |
AoqVideoObserverMode
Mode de callback de trame vidéo.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Read-only |
| 1 | Read-write |
AoqVideoObserverAlignment
Méthode d'alignement de la largeur pour la sortie vidéo.
Valeur d'énumération | Valeur | Description |
|---|---|---|
| 0 | Valeur par défaut |
| 1 | Alignement sur nombre pair |
| 2 | Alignement sur 4 octets |
| 3 | Alignement sur 8 octets |
| 4 | Alignement sur 16 octets |
AoqVideoObserverConfig
Configuration du rappel de trame vidéo.
Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
|
|
| Format de pixel attendu des données de rappel |
|
|
| Politique d'alignement de la largeur |
|
|
| Mode lecture-écriture. ReadWrite est pris en charge uniquement pour I420 / CVPixelBuffer. |
|
|
| Spécifie s'il faut appliquer un effet miroir aux données de rappel |
| trackType | AoqTrackType | AoqTrackTypeVideo | Piste vidéo à observer. Prend en charge uniquement Vidéo et Écran. |
Types de capture d'écran
AoqScreenShareSourceType
| Valeur | Number | Description |
|---|---|---|
| AoqScreenShareSourceTypeDesktop | 0 | Bureau entier |
| AoqScreenShareSourceTypeWindow | 1 | Une fenêtre spécifique |
AoqScreenSourceInfo
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
| sourceType | AoqScreenShareSourceType | Desktop | Source type |
| sourceId | int64_t | 0 | Source ID |
| sourceName | NSString * | — | Source name |
| sourceIsSelf | BOOL | — | Indique si la fenêtre appartient au processus actuel |
AoqScreenSourceList
| Champ | Type | Description |
|---|---|---|
| sourceList | NSArray<AoqScreenSourceInfo *> * | Tableau des sources d'écran |
AoqScreenCaptureConfig
| Champ | Type | Valeur par défaut | Description |
|---|---|---|---|
| isExternal | BOOL | NO | Indique si l'application fournit des trames d'écran brutes. |
| sourceId | int64_t | 0 | ID de la source d'écran. |
| sourceType | AoqScreenShareSourceType | AoqScreenShareSourceTypeWindow | Type de source d'écran. |