OpenTok Windows SDK reference
The OpenTok Windows SDK includes the following classes:
| Class | Description |
|---|---|
| AudioData | Defines several parameters related to an audio sample batch. |
| mf_capturer_format | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTok | Describes the policy that the video engine will try to follow when adapting frame rate and resolution to limited bandwidth and CPU. This is a best effort policy. There are no guarantees on the frame rate and some frames can still be skipped for other reasons. |
| OpenTok.AudioCapturer | Includes static methods for listing available audio input devices and for setting the audio input devices for Publisher objects. |
| OpenTok.AudioCapturer.AudioDevice | Represents an audio device available on the system. See EnumerateDevices and SetAudioInputDevice(AudioDevice audioInput) . |
| OpenTok.AudioData | Defines several parameters related to an audio sample batch. |
| OpenTok.AudioDevice | A class that includes methods for setting the audio device to be used by publishers and subscribers. |
| OpenTok.AudioDevice.AudioBus | An audio bus used for all publisher and subscribers. This class is used to both read and write audio samples in order for them to be rendered or sent to remote peers. |
| OpenTok.AudioDevice.InputAudioDevice | Represents an input audio device (such as a microphone) available on the Windows system. See EnumerateInputAudioDevices and SetInputAudioDevice . |
| OpenTok.AudioDevice.Notifications | Represents a subscription to system audio device notifications. This object sends events when a system input or output audio device is added or removed, and when the default system input or output audio device changes. This instance can be disposed when no longer used to release unmanaged resources. |
| OpenTok.AudioDevice.Notifications.InputAudioDeviceEventArgs | Contains the arguments for audio input device events. |
| OpenTok.AudioDevice.Notifications.OutputAudioDeviceEventArgs | Contains the arguments for audio output device events. |
| OpenTok.AudioDevice.OutputAudioDevice | Represents an output audio device (such as headphones or speakers) available on the Windows system. See EnumerateOutputAudioDevices and SetOutputAudioDevice . |
| OpenTok.AudioDeviceSettings | Defines the settings retrieved from the IAudioDevice.GetAudioCapturerSettings() and IAudioDevice.GetAudioRendererSettings() methods. |
| OpenTok.AudioTransformer | Defines an audio transformation to be used in the Publisher.AudioTransformers array. |
| OpenTok.Builder | Used to create a Subscriber instance. |
| OpenTok.Capabilities | Defines values for the Capabilities property of a Session object, based on the role assigned to the token used to connect to the session. |
| OpenTok.Capturer.DshowCapturer.CapturerFormat | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTok.Capturer.DshowCapturer.Device | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTok.CapturerFormat | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTok.Connection | Represents a connection between a client and an Vonage Video API session. |
| OpenTok.Context | Used to manage resources for Session , Publisher , and Subscriber objects. |
| OpenTok.DedicatedWorkerDispatcher | Implementation of IDispatcher that uses a dedicated worker thread to deliver events. Available for all presentation frameworks (WinForms, WPF, etc.). Delivery order is guaranteed. Each instance of this IDispatcher uses a different thread so if using the same queue is required, create only one instan |
| OpenTok.DirectDispatcher | Implementation of IDispatcher that doesn't schedule events at all. It uses the same thread used by the lower layer to deliver events. Available for all application types. Delivery order is guaranteed. CPU-intensive or long-running tasks should not be executed in the handlers, as they would block the |
| OpenTok.IAudioDevice | Defines an Audio device to be used by all publishers and subscribers. |
| OpenTok.IAudioDeviceExtension | Defines additional methods and events for an IAudioDevice . When implementing a Custom Audio Device, this interface can be optionally implemented and if done so, once the CustomAudioDevice is assigned via AudioDevice.SetCustomAudioDevice , other static AudioDevice methods (like enumerating devices, |
| OpenTok.IceConfig | A class for setting custom ICE configuration. |
| OpenTok.IceServer | Defines the object to add to the List for the CustomIceServers property of the IceConfig class. |
| OpenTok.ICustomAudioTransformer | Interface used to define a custom audio transformer to be used in the AudioTransformer(string name, ICustomAudioTransformer transformer) constructor. |
| OpenTok.ICustomVideoTransformer | Interface used to define a custom vidoe transformer to be used in used in the VideoTransformer.VideoTransformer(string name, ICustomVideoTransformer transformer) constructor. |
| OpenTok.IDispatcher | Interface for a class used by Session , Publisher , and Subscriber instances to schedule events to a different thread. |
| OpenTok.IVideoCapturer | Inherited by OpenTok.VideoCapturer . |
| OpenTok.IVideoFrameConsumer | Defines a video frame consumer to be used by the VideoCapturer of a Publisher . |
| OpenTok.IVideoRenderer | Defines a video renderer to be used by a Publisher or Subscriber object. |
| OpenTok.MMAudioDevice | Custom audio device implementation based on mmdeviceapi. This custom audio device can be used instead of the default internal audio device provided by OpenTok.AudioDevice . |
| OpenTok.OpenTokException | Defines errors thrown by the Vonage Video API Windows SDK. |
| OpenTok.OpenTokFrameConsumer | Inherits OpenTok.IVideoFrameConsumer . |
| OpenTok.PreferredVideoCodecs | Defines a preferred video codec configuration for a Publisher 's stream. |
| OpenTok.Publisher | A publisher captures an audio-video stream from the sources you specify. |
| OpenTok.Publisher.AudioLevelArgs | Defines arguments for AudioLevel events. |
| OpenTok.Publisher.AudioNetworkStats | Defines an audio statistics object for the Stats property of a AudioNetworkStatsEventArgs object. |
| OpenTok.Publisher.AudioNetworkStatsEventArgs | Defines arguments for AudioStatsUpdated events. |
| OpenTok.Publisher.Builder | Used to create a Publisher instance. |
| OpenTok.Publisher.ErrorEventArgs | Defines arguments for the Error event. |
| OpenTok.Publisher.MuteForcedEventArgs | Defines arguments for the MuteForced event. |
| OpenTok.Publisher.NetworkConditionChangedEventArgs | Defines arguments for NetworkConditionChanged events raised by the publisher. |
| OpenTok.Publisher.PublisherMediaLinkStats | Provides publisher media link statistics including local transport metrics. |
| OpenTok.Publisher.PublisherMediaLinkStatsEventArgs | Defines arguments for MediaLinkStatsUpdated events. |
| OpenTok.Publisher.PublisherRtcStats | Represents RTC statistics for a media stream published by the publisher. |
| OpenTok.Publisher.RtcStatsReportArgs | Defines arguments for RtcStatsReport events. |
| OpenTok.Publisher.StreamCreatedEventArgs | Defines arguments for the StreamCreated event. |
| OpenTok.Publisher.StreamDestroyedEventArgs | Defines arguments for the StreamDestroyed event. |
| OpenTok.Publisher.StreamEventArgs | Defines arguments for the StreamCreated and StreamDestroyed events. |
| OpenTok.Publisher.VideoEventArgs | Defines arguments for the VideoEnabled and VideoDisabled events. |
| OpenTok.Publisher.VideoLayerStats | Represents the statistics for a single published video layer. |
| OpenTok.Publisher.VideoNetworkStats | Defines a video statistics object for the Stats property of a VideoNetworkStatsEventArgs object. |
| OpenTok.Publisher.VideoNetworkStatsEventArgs | Defines arguments for VideoStatsUpdated events. |
| OpenTok.Publisher.VideoQualityChangedEventArgs | Defines arguments for VideoQualityChanged events. |
| OpenTok.Session | Represents an Vonage Video API session in which the client is participating. |
| OpenTok.Session.ArchiveStartedEventArgs | Defines arguments for the ArchiveStarted event. |
| OpenTok.Session.ArchiveStoppedEventArgs | Defines arguments for the ArchiveStopped event. |
| OpenTok.Session.Builder | Used to create a Session instance. |
| OpenTok.Session.ConnectionEventArgs | Defines arguments for the ConnectionCreated and ConnectionDropped events. |
| OpenTok.Session.ErrorEventArgs | Defines arguments for the Error event. |
| OpenTok.Session.MuteForcedEventArgs | Defines arguments for the MuteForced event. |
| OpenTok.Session.SignalEventArgs | Defines arguments for the Session.Signal event. |
| OpenTok.Session.StreamDimensionsEventArgs | Defines arguments for the StreamDimensionsChanged event. |
| OpenTok.Session.StreamEventArgs | Defines arguments for the StreamReceived and StreamDropped events. |
| OpenTok.Session.StreamHasAudioEventArgs | Defines arguments for the StreamHasAudioChanged event. |
| OpenTok.Session.StreamHasVideoEventArgs | Defines arguments for the StreamHasVideoChanged event. |
| OpenTok.Stream | Represents the state of an audio-video stream in an Vonage Video API session. To get the most updated information, use the Stream property of a Publisher or Subscriber before accessing any of the properties of the stream. |
| OpenTok.Subscriber | Used to consume an audio-video stream in the Vonage Video API session. |
| OpenTok.Subscriber.AudioDataEventArgs | Defines parameters for OpenTok.AudioData events. |
| OpenTok.Subscriber.AudioLevelArgs | Defines arguments for AudioLevel events. |
| OpenTok.Subscriber.AudioNetworkStatsEventArgs | Defines arguments for AudioStatsUpdated events. |
| OpenTok.Subscriber.Builder | Used to create a Subscriber instance. |
| OpenTok.Subscriber.CaptionTextArgs | Defines arguments for CaptionText events. |
| OpenTok.Subscriber.ErrorEventArgs | Defines arguments for the Error event. |
| OpenTok.Subscriber.NetworkConditionChangedEventArgs | Defines arguments for NetworkConditionChanged events raised by the subscriber. |
| OpenTok.Subscriber.RtcStatsReportArgs | Defines arguments for RtcStatsReport events. |
| OpenTok.Subscriber.SenderStats | Sender-side network statistics. |
| OpenTok.Subscriber.SubscriberMediaLinkStats | Provides subscriber media link statistics including local and remote transport metrics and network degradation information. |
| OpenTok.Subscriber.SubscriberMediaLinkStatsEventArgs | Defines arguments for MediaLinkStatsUpdated events. |
| OpenTok.Subscriber.VideoDisabledEventArgs | Defines arguments for the VideoDisabled event. |
| OpenTok.Subscriber.VideoEnabledEventArgs | Defines arguments for the VideoEnabled event. |
| OpenTok.Subscriber.VideoEventArgs | Defines arguments for the VideoEnabled and VideoDisabled events. |
| OpenTok.Subscriber.VideoNetworkStatsEventArgs | Defines arguments for VideoStatsUpdated events. |
| OpenTok.Subscriber.VideoQualityChangedEventArgs | Defines arguments for VideoQualityChanged events raised by the subscriber. |
| OpenTok.SubscriberCallbacks | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTok.ThreadPoolDispatcher | Implementation of IDispatcher that uses different threads from the managed ThreadPool to deliver events. Available for all presentation frameworks (WinForms, WPF, etc.). Important: Delivery order is not guaranteed. All instances of ThreadPoolDispatcher dispatch events to the same thread pool, so it |
| OpenTok.UWPDispatcher | Implementation of IDispatcher that uses UWP Main/UI thread to dispatch events. Available only for UWP applications. Delivery order is guaranteed. CPU-intensive or long-running tasks should not be executed in the handlers, as they would block the UI thread and affect performance or responsiveness. |
| OpenTok.UWPVideoRenderer | Inherits UserControl, and OpenTok.IVideoRenderer . |
| OpenTok.VideoCapturer | A video capturer implementation that captures video from on of the cameras available on the system. |
| OpenTok.VideoCapturer.VideoDevice | Defines a video device (such as a camera). |
| OpenTok.VideoCapturer.VideoFormat | Defines a video format available to a video device. |
| OpenTok.VideoCaptureSettings | Defines the settings passed into the VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings) method. |
| OpenTok.VideoCaptureSettings | Defines the settings passed into the VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings) method. |
| OpenTok.VideoFrame | Defines a video frame for the IVideoRenderer.RenderFrame(VideoFrame) and IVideoFrameConsumer.Consume(VideoFrame) methods. |
| OpenTok.VideoRenderer | Used to render a video for Subscriber and Publisher objects. |
| OpenTok.VideoTransformer | Defines a video transformation to be used in the Publisher.VideoTransformers array. |
| OpenTok.WinFormsDispatcher | Implementation of IDispatcher that uses the Windows Forms Main/UI thread to dispatch events. Available only for Windows Forms applications. Delivery order is guaranteed. All instances of WinFormsDispatcher dispatch events to the Main Application thread, so it doesn't matter whether the same WinForms |
| OpenTok.WPFDispatcher | Implementation of IDispatcher that uses the WPF Main/UI thread to dispatch events. Available only for WPF applications. Delivery order is guaranteed. All instances of WPFDispatcher dispatch events to the Main Application thread, so it doesn't matter whether the same WPFDispatcher is always used or a |
| Package OpenTok.Capturer | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| Package OpenTok.Utils | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| WinFormsRenderer | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| WinFormsRenderer.WinFormsVideoRenderer | Inherits UserControl, and IVideoRenderer. |