Documentation de référence du SDK OpenTok pour iOS

Le SDK OpenTok pour iOS comprend les classes suivantes :

Classe	Description
OTAudioBus	Le bus audio achemine les données audio entre le réseau et le périphérique audio. Appelez la méthode [OTAudioDevice setAudioBus:] pour définir l'objet qui implémente le protocole OTAudioBus. Le périphérique audio envoie les échantillons audio capturés vers le bus audio et récupère les échantillons audio non traités à partir de celui-ci.
OTAudioData	Définit les données audio transmises à la méthode [OTCustomAudioTransformer transform:].
OTAudioDevice	Définit un périphérique audio à utiliser dans une session. Voir [OTAudioDeviceManager setAudioDevice:].
OTAudioDeviceManager	Utilisez AudioDeviceManager pour configurer un périphérique audio personnalisé que l'application utilisera. Ce périphérique audio gère l'accès au matériel de capture et de restitution audio.
OTAudioFormat	Définit le format audio lorsqu'un pilote audio personnalisé est utilisé.
OTAudioSessionManager	Définit un gestionnaire de session audio destiné à être utilisé avec des services d'appel tels que CallKit. L'implémentation de ce protocole est facultative. Les périphériques audio personnalisés peuvent implémenter ces méthodes pour gérer l'AVAudioSession. Le périphérique audio par défaut du SDK fournit une implémentation fonctionnelle.
OTAudioTransformer	Définit un transformateur d'un flux audio.
OTCameraCaptureFrameRate	Définit les valeurs du paramètre `cameraFrameRate` de la méthode [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:].
OTCameraCaptureResolution	Définit les valeurs du paramètre `cameraResolution` de la méthode [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:].
OTConnection	Représente une connexion à une session OpenTok. La classe `OTSession` comporte une propriété `connection`, qui est un objet `OTConnection`. De même, la classe `OTStream` comporte une propriété `connection`, qui est un objet `OTConnection`.
OTCustomAudioTransformer	Définit un transformateur personnalisé pour un flux audio, destiné à être transmis à la méthode [OTAudioTransformer initWithName:transformer:].
OTCustomVideoTransformer	Définit un transformateur personnalisé pour un flux vidéo, destiné à être transmis à la méthode [OTVideoTransformer initWithName:transformer:].
OTDégradationPréférence	Valeur par défaut. Le moteur vidéo déterminera le niveau de dégradation optimal.
OTError	Définit les erreurs pour le SDK OpenTok pour iOS.
OTMuteForcedInfo	Définit le paramètre « muteForced » du message [OTSessionDelegate session:muteForced:].
État du réseau	Note estimée de l'état du réseau pour un transport.
Source de dégradation du réseau	Indique la source de la dégradation de la qualité vidéo ou du réseau au cours de la session.
Motif du réseau OT	Décrit la cause principale ayant une incidence sur l'état du réseau.
OTPixelFormat	Définit les valeurs du format de pixel pour la propriété `pixelFormat` d'un objet `OTVideoFrame`.
OTP éditeur	Un éditeur capture un flux audio-vidéo à partir du microphone et de la caméra de l'appareil. Vous pouvez ensuite publier ce flux audio-vidéo dans une session OpenTok en envoyant le message [OTSession publish:error:].
OTPublisherDelegate	Permet d'envoyer des messages à une instance OTPublisher.
OTPublisherErrorCode	Énumérations des valeurs de codes d'erreur utilisées par la méthode [OTPublisherKitDelegate publisher:didFailWithError:].
OTPublisherKit	Un éditeur capture un flux audio-vidéo à partir des sources que vous spécifiez. Vous pouvez ensuite publier ce flux audio-vidéo dans une session OpenTok en envoyant le message [OTSession publish:error:].
OTPublisherKitAudioLevelDelegate	Sert à surveiller les niveaux audio de l'éditeur.
OTPublisherKitStatistiques du réseau audio	Décrit les statistiques audio d'un éditeur. Voir [OTPublisherKit setNetworkStatsDelegate:].
OTPublisherKitDelegate	Permet d'envoyer des messages à une instance d'OTPublisher. La classe OTPublisher comprend une propriété de délégué. Lorsque vous envoyez le message [OTPublisherKit initWithDelegate:] ou le message [OTPublisherKit initWithDelegate:settings:], vous spécifiez un objet OTPublisherKitDelegate.
OTPublisherKitMediaLinkStats	Fournit des statistiques sur les liens multimédias des éditeurs, y compris des indicateurs de trafic local.
OTPublisherKitNetworkStatsDelegate	Permet de surveiller les statistiques audio et vidéo pour l'éditeur. Voir [OTPublisherKit networkStatsDelegate].
OTPublisherKitRtcStatsReportDelegate	Utilisé pour envoyer des messages rapportant les statistiques RTC de l'éditeur. Définissez la propriété [OTPublisherKit rtcStatsReportDelegate] pour utiliser ce délégué. Après avoir appelé la méthode [OTPublisherKit getRtcStatsReport], le message [OTPublisherKitRtcStatsReportDelegate publisher:rtcStatsReport:] est envoyé pour signaler les
OTPublisherKitSettings	Définit les paramètres à utiliser lors de l'initialisation d'un éditeur à l'aide de la méthode [OTPublisherKit initWithDelegate:settings:].
OTPublisherKitVideoLayerStats	Décrit les statistiques relatives à une seule couche vidéo publiée.
OTPublisherKitStatistiques du réseau vidéo	Décrit les statistiques vidéo d'un éditeur. Voir [OTPublisherKit setNetworkStatsDelegate:].
OTPublisherKitVideoType	Définit les valeurs de la propriété [OTPublisherKit videoType].
OTPublisherRtcStats	Représente les statistiques RTC relatives à un flux multimédia publié par l'éditeur.
OTPublisherSettings	Définit les paramètres à utiliser lors de l'initialisation d'un éditeur à l'aide de la méthode [OTPublisher initWithDelegate:settings:].
OTÉditeurVidéoÉvénementMotif	Les événements d'activation et de désactivation de la vidéo sont accompagnés d'un code de motif, permettant de déterminer pourquoi la piste vidéo a été activée ou désactivée.
OTSenderStats	Représente les statistiques vidéo communiquées par l'expéditeur, telles que les estimations de débit binaire.
OTSession	La première étape pour utiliser le SDK OpenTok pour iOS consiste à initialiser un objet OTSession avec votre clé API et un identifiant de session valide. Utilisez l'objet OTSession pour vous connecter à OpenTok à l'aide de votre clé API de développeur et d'un jeton valide.
OTSessionCapabilities	Définit la propriété [OTSession capabilities]. Une fois que vous vous êtes connecté à une session et que la méthode [OTSessionDelegate sessionDidConnect:] a été appelée, cette propriété indique si le client peut publier et s'abonner à des flux au sein de la session, en fonction du rôle attribué au jeton utilisé pour
OTSessionConnectionStatus	Les codes d'état de connexion, accessibles via [OTSession sessionConnectionStatus].
OTSessionDelegate	Permet d'envoyer des messages à une instance OTSession. La classe OTSession dispose d'une propriété « delegate ». Lorsque vous envoyez le message [OTSession initWithApiKey:sessionId:delegate:], vous spécifiez un objet OTSessionDelegate.
OTSessionErrorCode	Liste des valeurs des codes d'erreur utilisées par la méthode [OTSessionDelegate session:didFailWithError:].
OTSessionICEConfig	Définit la propriété. Cela permet de définir les serveurs TURN que le client doit utiliser au cours de la session.
OTSessionICEIncludeServers	Permet de définir si vous souhaitez utiliser uniquement vos serveurs TURN personnalisés ou si vous souhaitez les utiliser en complément des serveurs TURN d'OpenTok. Permet de définir les valeurs de la propriété.
OTSessionICETransportPolicy	Définit les paramètres permettant de choisir entre l'utilisation de tous les types de transport ICE (tels que host, srflx et TURN) pour établir la connectivité multimédia, ou l'utilisation exclusive de TURN. Utilisé dans le paramètre [OTSessionICEConfig transportPolicy].
OTSessionSettings	Définit les paramètres à utiliser lors de l'initialisation d'un objet OTSession à l'aide de la méthode [OTSession initWithApiKey:sessionId:delegate:settings:].
OTStream	Un objet OTStream représente un flux multimédia pouvant contenir des données vidéo et/ou audio.
OTStreamVideoType	Définit les valeurs de la propriété [OTStream videoType].
Abonné OTS	Affiche les flux OpenTok et fournit une vue UIView qui affiche la vidéo et propose quelques commandes simples destinées à l'utilisateur final.
OTSubscriberDelegate	OTSubscriberDelegate étend OTSubscriberKitDelegate en proposant des rappels optionnels supplémentaires spécifiques à l'implémentation d'OTSubscriber. Actuellement, il n'existe qu'un seul rappel supplémentaire, mais d'autres pourraient être ajoutés dans une prochaine version.
OTSubscriberErrorCode	Liste des valeurs des codes d'erreur utilisées par la méthode [OTSubscriberKitDelegate subscriber:didFailWithError:].
OTSubscriberKit	Un objet OTSubscriberKit (abonné) assure le rendu des données multimédias associées à un OTStream. La classe OTSubscriberKit vous permet de définir un moteur de rendu vidéo personnalisé pour le flux vidéo. Utilisez cette classe si vous souhaitez mettre en œuvre votre propre traitement et rendu vidéo. Sinon, utilisez l'OTSubscriberKit
OTSubscriberKitAudioLevelDelegate	Sert à surveiller les niveaux audio de l'abonné.
OTSubscriberKitAudioNetworkStats	Décrit les statistiques audio d'un abonné. Voir [OTSubscriberKit setNetworkStatsDelegate:].
OTSubscriberKitCaptionsDelegate	Sert à recevoir les sous-titres du flux d'un abonné.
OTSubscriberKitDelegate	Permet d'envoyer des messages à une instance OTSubscriber. Lorsque vous envoyez le message [OTSubscriberKit initWithStream:delegate:], vous spécifiez un objet OTSubscriberKitDelegate.
OTSubscriberKitMediaLinkStats	Fournit des statistiques sur les liaisons réseau des abonnés, notamment des indicateurs de transport locaux et distants, ainsi que des informations sur la dégradation du réseau.
OTSubscriberKitNetworkStatsDelegate	Permet de surveiller les statistiques audio et vidéo de l'abonné. Voir [OTSubscriberKit networkStatsDelegate].
OTSubscriberKitRtcStatsReportDelegate	Utilisé pour envoyer des messages contenant les statistiques RTC des abonnés. Définissez la propriété [OTSubscriberKit rtcStatsReportDelegate] pour utiliser ce délégué. Après avoir appelé la méthode [OTSubscriberKit getRtcStatsReport], le message [OTSubscriberKitRtcStatsReportDelegate subscriber:rtcStatsReport:] est envoyé à repo.
OTSubscriberKitStatistiques du réseau vidéo	Décrit les statistiques vidéo d'un abonné. Voir [OTSubscriberKit setNetworkStatsDelegate:].
OTSubscriberVideoEventReason	Les événements d'activation et de désactivation de la vidéo sont accompagnés d'un code de motif, permettant de déterminer pourquoi la piste vidéo a été activée ou désactivée.
OTTransportStats	Fournit des statistiques de transport au niveau du réseau.
OTVideoBitratePreset	Stratégies prédéfinies pour contrôler le débit binaire vidéo dans le flux d'un éditeur.
OTVideoCapture	Définit un module de capture vidéo destiné à être utilisé par un objet OTPublisherKit. Voir la propriété videoCapture d'un objet OTPublisherKit.
OTVideoCaptureConsumer	Définit un consommateur d'un objet OTVideoCapture.
OTVideoCodecPreference	@class OTVideoCodecPreference
OTVideoCodecType	Définissez les valeurs de la propriété [OTVideoCodecPreference codecs], ainsi que les éléments du tableau utilisé par la méthode [OTVideoCodecPreference manualWithCodecs:].
OTVideoContentHint	Définit les valeurs de la méthode.
OTVideoFormat	Définit le format vidéo attribué à une instance d'un objet OTVideoFrame.
OTVideoFrame	Définit une image d'une vidéo. Voir [OTVideoRender renderVideoFrame:] et [OTVideoCaptureConsumer consumeFrame:].
OTVideoOrientation	Définit les valeurs d'orientation vidéo (haut, bas, gauche, droite) pour la propriété « orieintation » d'un objet OTVideoFrame.
OTVideoRender	Définit un moteur de rendu vidéo destiné à être utilisé par un objet OTPublisherKit ou un objet OTSubscriberKit. Voir les propriétés videoRender des objets OTPublisherKit et OTSubscriberKit.
OTVideoTransformer	Définit un transformateur de flux vidéo.
OTVideoViewScaleBehavior	Définit les valeurs des propriétés [OTSubscriber viewScaleBehavior] et [OTPublisher viewScaleBehavior].