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

Le SDK OpenTok pour Windows comprend les classes suivantes :

Classe Description
Données audio Définit plusieurs paramètres liés à un lot d'échantillons audio.
mf_capturer_format Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
OpenTok Décrit la stratégie que le moteur vidéo s'efforcera de suivre pour adapter la fréquence d'images et la résolution à une bande passante et à une puissance de calcul limitées. Il s'agit d'une stratégie « au mieux ». Aucune garantie n'est donnée quant à la fréquence d'images et certaines images peuvent tout de même être sautées pour d'autres raisons.
OpenTok.AudioCapturer Comprend des méthodes statiques permettant de répertorier les périphériques d'entrée audio disponibles et de configurer les périphériques d'entrée audio pour les objets Publisher.
OpenTok.AudioCapturer.AudioDevice Représente un périphérique audio disponible sur le système. Voir EnumerateDevices et SetAudioInputDevice(AudioDevice audioInput).
OpenTok.AudioData Définit plusieurs paramètres liés à un lot d'échantillons audio.
OpenTok.AudioDevice Classe comprenant des méthodes permettant de définir le périphérique audio à utiliser par les éditeurs et les abonnés.
OpenTok.AudioDevice.AudioBus Bus audio utilisé par tous les éditeurs et abonnés. Cette classe sert à la fois à lire et à écrire des échantillons audio afin qu'ils puissent être restitués ou envoyés à des pairs distants.
OpenTok.AudioDevice.InputAudioDevice Représente un périphérique audio d'entrée (tel qu'un microphone) disponible sur le système Windows. Voir EnumerateInputAudioDevices et SetInputAudioDevice.
OpenTok.AudioDevice.Notifications Représente un abonnement aux notifications relatives aux périphériques audio du système. Cet objet envoie des événements lorsqu'un périphérique audio d'entrée ou de sortie du système est ajouté ou supprimé, ainsi que lorsque le périphérique audio d'entrée ou de sortie par défaut du système change. Cette instance peut être supprimée lorsqu'elle n'est plus utilisée afin de libérer les ressources non gérées.
OpenTok.AudioDevice.Notifications.InputAudioDeviceEventArgs Contient les arguments relatifs aux événements du périphérique d'entrée audio.
OpenTok.AudioDevice.Notifications.OutputAudioDeviceEventArgs Contient les arguments relatifs aux événements du périphérique de sortie audio.
OpenTok.AudioDevice.OutputAudioDevice Représente un périphérique audio de sortie (tel qu'un casque ou des haut-parleurs) disponible sur le système Windows. Voir EnumerateOutputAudioDevices et SetOutputAudioDevice.
OpenTok.AudioDeviceSettings Définit les paramètres récupérés à partir des méthodes IAudioDevice.GetAudioCapturerSettings() et IAudioDevice.GetAudioRendererSettings().
OpenTok.AudioTransformer Définit une transformation audio à utiliser dans le tableau Publisher.AudioTransformers.
OpenTok.Builder Permet de créer une instance de « Subscriber ».
OpenTok.Fonctionnalités Définit les valeurs de la propriété « Capabilities » d'un objet Session, en fonction du rôle attribué au jeton utilisé pour se connecter à la session.
OpenTok.Capturer.DshowCapturer.CapturerFormat Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
OpenTok.Capturer.DshowCapturer.Device Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
OpenTok.CapturerFormat Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
OpenTok.Connection Représente une connexion entre un client et une session de la Video API Vonage.
OpenTok.Context Permet de gérer les ressources des objets « Session », « Publisher » et « Subscriber ».
OpenTok.DedicatedWorkerDispatcher Implémentation de l'interface IDispatcher qui utilise un thread de travail dédié pour transmettre les événements. Compatible avec tous les frameworks de présentation (WinForms, WPF, etc.). L'ordre de transmission est garanti. Chaque instance de cette interface IDispatcher utilise un thread différent ; par conséquent, si vous devez utiliser la même file d'attente, ne créez qu'une seule instance.
OpenTok.DirectDispatcher Implémentation de l'interface IDispatcher qui ne planifie aucun événement. Elle utilise le même thread que celui utilisé par la couche inférieure pour transmettre les événements. Disponible pour tous les types d'applications. L'ordre de transmission est garanti. Les tâches gourmandes en ressources CPU ou de longue durée ne doivent pas être exécutées dans les gestionnaires, car elles bloqueraient le
OpenTok.IAudioDevice Définit un périphérique audio destiné à être utilisé par tous les émetteurs et abonnés.
OpenTok.IAudioDeviceExtension Définit des méthodes et des événements supplémentaires pour un IAudioDevice. Lors de l'implémentation d'un périphérique audio personnalisé, cette interface peut être implémentée de manière facultative ; si tel est le cas, une fois que le CustomAudioDevice a été attribué via AudioDevice.SetCustomAudioDevice, d'autres méthodes statiques d'AudioDevice (telles que l'énumération des périphériques,
OpenTok.IceConfig Classe permettant de définir une configuration ICE personnalisée.
OpenTok.IceServer Définit l'objet à ajouter à la liste de la propriété `CustomIceServers` de la classe `IceConfig`.
OpenTok.ICustomAudioTransformer Interface permettant de définir un transformateur audio personnalisé destiné à être utilisé dans le constructeur AudioTransformer(string name, ICustomAudioTransformer transformer).
OpenTok.ICustomVideoTransformer Interface permettant de définir un transformateur vidéo personnalisé destiné à être utilisé dans le constructeur VideoTransformer.VideoTransformer(string name, ICustomVideoTransformer transformer).
OpenTok.IDispatcher Interface d'une classe utilisée par les instances de Session, Publisher et Subscriber pour planifier des événements sur un autre thread.
OpenTok.IVideoCapturer Hérité de OpenTok.VideoCapturer.
OpenTok.IVideoFrameConsumer Définit un consommateur d'images vidéo destiné à être utilisé par le VideoCapturer d'un éditeur.
OpenTok.IVideoRenderer Définit un moteur de rendu vidéo destiné à être utilisé par un objet « Publisher » ou « Subscriber ».
OpenTok.MMAudioDevice Implémentation d'un périphérique audio personnalisé basé sur mmdeviceapi. Ce périphérique audio personnalisé peut être utilisé à la place du périphérique audio interne par défaut fourni par OpenTok.AudioDevice.
OpenTok.OpenTokException Définit les erreurs générées par le SDK Windows de la Video API Vonage.
OpenTok.OpenTokFrameConsumer Hérite de la classe OpenTok.IVideoFrameConsumer.
OpenTok.Codecs vidéo préférés Définit une configuration de codec vidéo recommandée pour le flux d'un éditeur.
OpenTok.Publisher Un diffuseur capture un flux audio-vidéo à partir des sources que vous spécifiez.
OpenTok.Publisher.AudioLevelArgs Définit les arguments des événements AudioLevel.
OpenTok.Publisher.AudioNetworkStats Définit un objet de statistiques audio pour la propriété Stats d'un objet AudioNetworkStatsEventArgs.
OpenTok.Publisher.AudioNetworkStatsEventArgs Définit les arguments des événements « AudioStatsUpdated ».
OpenTok.Publisher.Builder Permet de créer une instance de Publisher.
OpenTok.Publisher.ErrorEventArgs Définit les arguments de l'événement « Error ».
OpenTok.Publisher.MuteForcedEventArgs Définit les arguments de l'événement MuteForced.
OpenTok.Publisher.NetworkConditionChangedEventArgs Définit les arguments des événements `NetworkConditionChanged` déclenchés par l'éditeur.
OpenTok.Publisher.PublisherMediaLinkStats Fournit des statistiques sur les liens multimédias des éditeurs, y compris des indicateurs de trafic local.
OpenTok.Publisher.PublisherMediaLinkStatsEventArgs Définit les arguments des événements MediaLinkStatsUpdated.
OpenTok.Publisher.PublisherRtcStats Représente les statistiques RTC relatives à un flux multimédia publié par l'éditeur.
OpenTok.Publisher.RtcStatsReportArgs Définit les arguments des événements RtcStatsReport.
OpenTok.Publisher.StreamCreatedEventArgs Définit les arguments de l'événement StreamCreated.
OpenTok.Publisher.StreamDestroyedEventArgs Définit les arguments de l'événement StreamDestroyed.
OpenTok.Publisher.StreamEventArgs Définit les arguments des événements StreamCreated et StreamDestroyed.
OpenTok.Publisher.VideoEventArgs Définit les arguments des événements VideoEnabled et VideoDisabled.
OpenTok.Publisher.VideoLayerStats Représente les statistiques relatives à une seule couche vidéo publiée.
OpenTok.Publisher.VideoNetworkStats Définit un objet de statistiques vidéo pour la propriété Stats d'un objet VideoNetworkStatsEventArgs.
OpenTok.Publisher.VideoNetworkStatsEventArgs Définit les arguments des événements « VideoStatsUpdated ».
OpenTok.Publisher.VideoQualityChangedEventArgs Définit les arguments des événements « VideoQualityChanged ».
OpenTok.Session Représente une session de la Video API Vonage à laquelle le client participe.
OpenTok.Session.ArchiveStartedEventArgs Définit les arguments de l'événement ArchiveStarted.
OpenTok.Session.ArchiveStoppedEventArgs Définit les arguments de l'événement ArchiveStopped.
OpenTok.Session.Builder Permet de créer une instance de Session.
OpenTok.Session.ConnectionEventArgs Définit les arguments des événements ConnectionCreated et ConnectionDropped.
OpenTok.Session.ErrorEventArgs Définit les arguments de l'événement « Error ».
OpenTok.Session.MuteForcedEventArgs Définit les arguments de l'événement MuteForced.
OpenTok.Session.SignalEventArgs Définit les arguments de l'événement Session.Signal.
OpenTok.Session.StreamDimensionsEventArgs Définit les arguments de l'événement StreamDimensionsChanged.
OpenTok.Session.StreamEventArgs Définit les arguments des événements StreamReceived et StreamDropped.
OpenTok.Session.StreamHasAudioEventArgs Définit les arguments de l'événement StreamHasAudioChanged.
OpenTok.Session.StreamHasVideoEventArgs Définit les arguments de l'événement StreamHasVideoChanged.
OpenTok.Stream Représente l'état d'un flux audio-vidéo dans une session de la Video API. Pour obtenir les informations les plus récentes, utilisez la propriété `Stream` d'un `Publisher` ou d'un `Subscriber` avant d'accéder à l'une des propriétés du flux.
OpenTok.Abonné Permet de lire un flux audio-vidéo dans le cadre d'une session de la Video API.
OpenTok.Subscriber.AudioDataEventArgs Définit les paramètres des événements OpenTok.AudioData.
OpenTok.Subscriber.AudioLevelArgs Définit les arguments des événements AudioLevel.
OpenTok.Subscriber.AudioNetworkStatsEventArgs Définit les arguments des événements « AudioStatsUpdated ».
OpenTok.Subscriber.Builder Permet de créer une instance de « Subscriber ».
OpenTok.Subscriber.CaptionTextArgs Définit les arguments des événements CaptionText.
OpenTok.Subscriber.ErrorEventArgs Définit les arguments de l'événement « Error ».
OpenTok.Subscriber.NetworkConditionChangedEventArgs Définit les arguments des événements `NetworkConditionChanged` déclenchés par l'abonné.
OpenTok.Subscriber.RtcStatsReportArgs Définit les arguments des événements RtcStatsReport.
OpenTok.Subscriber.SenderStats Statistiques réseau côté expéditeur.
OpenTok.Subscriber.SubscriberMediaLinkStats 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.
OpenTok.Subscriber.SubscriberMediaLinkStatsEventArgs Définit les arguments des événements MediaLinkStatsUpdated.
OpenTok.Subscriber.VideoDisabledEventArgs Définit les arguments de l'événement VideoDisabled.
OpenTok.Subscriber.VideoEnabledEventArgs Définit les arguments de l'événement VideoEnabled.
OpenTok.Subscriber.VideoEventArgs Définit les arguments des événements VideoEnabled et VideoDisabled.
OpenTok.Subscriber.VideoNetworkStatsEventArgs Définit les arguments des événements « VideoStatsUpdated ».
OpenTok.Subscriber.VideoQualityChangedEventArgs Définit les arguments des événements « VideoQualityChanged » déclenchés par l'abonné.
OpenTok.SubscriberCallbacks Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
OpenTok.ThreadPoolDispatcher Implémentation de l'interface IDispatcher qui utilise différents threads du ThreadPool géré pour diffuser des événements. Disponible pour tous les frameworks de présentation (WinForms, WPF, etc.). Important : l'ordre de diffusion n'est pas garanti. Toutes les instances de ThreadPoolDispatcher diffusent les événements vers le même pool de threads, donc cela
OpenTok.UWPDispatcher Implémentation de l'interface IDispatcher qui utilise le thread principal/UI de l'UWP pour diffuser les événements. Disponible uniquement pour les applications UWP. L'ordre de diffusion est garanti. Les tâches gourmandes en ressources CPU ou de longue durée ne doivent pas être exécutées dans les gestionnaires d'événements, car elles bloqueraient le thread UI et affecteraient les performances ou la réactivité.
OpenTok.UWPVideoRenderer Hérite de UserControl et d'OpenTok.IVideoRenderer.
OpenTok.VideoCapturer Une implémentation de capture vidéo qui permet de capturer des séquences vidéo à partir de l'une des caméras disponibles sur le système.
OpenTok.VideoCapturer.VideoDevice Définit un périphérique vidéo (tel qu'une caméra).
OpenTok.VideoCapturer.VideoFormat Définit un format vidéo pris en charge par un périphérique vidéo.
OpenTok.ParamètresDeCaptureVidéo Définit les paramètres transmis à la méthode VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings).
OpenTok.ParamètresDeCaptureVidéo Définit les paramètres transmis à la méthode VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings).
OpenTok.VideoFrame Définit une image vidéo pour les méthodes IVideoRenderer.RenderFrame(VideoFrame) et IVideoFrameConsumer.Consume(VideoFrame).
OpenTok.VideoRenderer Utilisé pour afficher une vidéo pour les objets « Abonné » et « Éditeur ».
OpenTok.VideoTransformer Définit une transformation vidéo à utiliser dans le tableau Publisher.VideoTransformers.
OpenTok.WinFormsDispatcher Implémentation de l'interface IDispatcher qui utilise le thread principal/UI de Windows Forms pour diffuser les événements. Disponible uniquement pour les applications Windows Forms. L'ordre de diffusion est garanti. Toutes les instances de WinFormsDispatcher diffusent les événements vers le thread principal de l'application ; il importe donc peu que le même WinForms
OpenTok.WPFDispatcher Implémentation de l'interface IDispatcher qui utilise le thread principal/UI de WPF pour diffuser les événements. Disponible uniquement pour les applications WPF. L'ordre de diffusion est garanti. Toutes les instances de WPFDispatcher diffusent les événements vers le thread principal de l'application ; il importe donc peu que l'on utilise toujours le même WPFDispatcher ou un
Module OpenTok.Capturer Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
Module OpenTok.Utils Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
WinFormsRenderer Utilisez la bibliothèque OpenTok.js pour développer des applications de communication WebRTC (vidéo, voix et messagerie) basées sur la Video API de Vonage sur les appareils iOS.
WinFormsRenderer.WinFormsVideoRenderer Hérite de UserControl et de IVideoRenderer.