Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 1234]

▼NOpenTok
CAudioData	Defines several parameters related to an audio sample batch.
▼CAudioDevice	A class that includes methods for setting the audio device to be used by publishers and subscribers.
CAudioBus	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.
CInputAudioDevice	Represents an input audio device (such as a microphone) available on the Windows system. See EnumerateInputAudioDevices and SetInputAudioDevice.
▼CNotifications	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.
CInputAudioDeviceEventArgs	Contains the arguments for audio input device events.
COutputAudioDeviceEventArgs	Contains the arguments for audio output device events.
COutputAudioDevice	Represents an output audio device (such as headphones or speakers) available on the Windows system. See EnumerateOutputAudioDevices and SetOutputAudioDevice.
CAudioDeviceSettings	Defines the settings retrieved from the IAudioDevice.GetAudioCapturerSettings() and IAudioDevice.GetAudioRendererSettings() methods.
CAudioTransformer	Defines an audio transformation to be used in the Publisher.AudioTransformers array.
CCapabilities	Defines values for the Capabilities property of a Session object, based on the role assigned to the token used to connect to the session.
CConnection	Represents a connection between a client and an OpenTok session.
CContext	Used to manage resources for Session, Publisher, and Subscriber objects.
CDedicatedWorkerDispatcher	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 instance of DedicatedWorkerDispatcher and pass it around to every OpenTok object that accepts an IDispatcher. CPU-intensive or long-running tasks can be executed in the event handlers, as the dedicated thread is not used for any other purpose. UI can't be manipulated directly in the event handlers. If this is required, events must be dispatched first to the UI thread.
CDirectDispatcher	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 presentation frameworks (WinForms, WPF, etc.). Delivery order is guaranteed. Since this is a No-Op IDispatcher, it doesn't matter whether the same DirectDispatcher is always used or a new one is created every time. CPU-intensive or long-running tasks should not be executed in the event handlers, as they would block the native API main thread and affect performance or responsiveness. Also, calling the otkit API functions directly from the event handlers can result in interlocking, so if that's required, first re-scheduled the execution to a different thread. UI can't be manipulated directly in the event handlers. If this is required, events must be scheduled first to the UI thread. IMPORTANT: This type of IDispatcher leaves a lot of responsibility to the application which must not block the calling thread and cannot make any calls to the API directly, requiring a re-scheduling first. At the same time, it provides much more control on how the application handles the callbacks, avoiding re-scheduling where not needed or managing priorities for different types of events. This can result in better performance for the application.
CIAudioDevice	Defines an Audio device to be used by all publishers and subscribers.
CIceConfig	A class for setting custom ICE configuration.
CIceServer	Defines the object to add to the List for the CustomIceServers property of the IceConfig class.
CICustomAudioTransformer	Interface used to define a custom audio transformer to be used in the AudioTransformer(string name, ICustomAudioTransformer transformer) constructor.
CICustomVideoTransformer	Interface used to define a custom vidoe transformer to be used in used in the VideoTransformer.VideoTransformer(string name, ICustomVideoTransformer transformer) constructor.
CIDispatcher	Interface for a class used by Session, Publisher, and Subscriber instances to schedule events to a different thread.
CIVideoCapturer
CIVideoFrameConsumer	Defines a video frame consumer to be used by the VideoCapturer of a Publisher.
CIVideoRenderer	Defines a video renderer to be used by a Publisher or Subscriber object.
CMMAudioDevice	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
COpenTokException	Defines errors thrown by the OpenTok Windows SDK.
CPreferredVideoCodecs	Defines a preferred video codec configuration for a Publisher's stream.
▼CPublisher	A publisher captures an audio-video stream from the sources you specify.
CAudioLevelArgs	Defines arguments for AudioLevel events.
CAudioNetworkStats	Defines an audio statistics object for the Stats property of a AudioNetworkStatsEventArgs object.
CAudioNetworkStatsEventArgs	Defines arguments for AudioStatsUpdated events.
CBuilder	Used to create a Publisher instance.
CErrorEventArgs	Defines arguments for the Error event.
CNetworkConditionChangedEventArgs	Defines arguments for NetworkConditionChanged events raised by the publisher.
CPublisherMediaLinkStats	Provides publisher media link statistics including local transport metrics.
CPublisherMediaLinkStatsEventArgs	Defines arguments for MediaLinkStatsUpdated events.
CPublisherRtcStats	Represents RTC statistics for a media stream published by the publisher.
CRtcStatsReportArgs	Defines arguments for RtcStatsReport events.
CStreamEventArgs	Defines arguments for the StreamCreated and StreamDestroyed events.
CVideoEventArgs	Defines arguments for the VideoEnabled and VideoDisabled events.
CVideoLayerStats	Represents the statistics for a single published video layer.
CVideoNetworkStats	Defines a video statistics object for the Stats property of a VideoNetworkStatsEventArgs object.
CVideoNetworkStatsEventArgs	Defines arguments for VideoStatsUpdated events.
CVideoQualityChangedEventArgs	Defines arguments for VideoQualityChanged events.
▼CSession	Represents an OpenTok session in which the client is participating.
CArchiveStartedEventArgs	Defines arguments for the ArchiveStarted event.
CArchiveStoppedEventArgs	Defines arguments for the ArchiveStopped event.
CBuilder	Used to create a Session instance.
CConnectionEventArgs	Defines arguments for the ConnectionCreated and ConnectionDroppedevents.
CErrorEventArgs	Defines arguments for the Error event.
CMuteForcedEventArgs	Defines arguments for the MuteForced event.
CSignalEventArgs	Defines arguments for the Session.Signal event.
CStreamEventArgs	Defines arguments for the StreamReceived and StreamDropped events.
CStream	Represents the state of an audio-video stream in an OpenTok 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.
▼CSubscriber	Used to consume an audio-video stream in the OpenTok session.
CAudioDataEventArgs	Defines parameters for OpenTok.AudioData events.
CAudioLevelArgs	Defines arguments for AudioLevel events.
CAudioNetworkStatsEventArgs	Defines arguments for AudioStatsUpdated events.
CBuilder	Used to create a Subscriber instance.
CCaptionTextArgs	Defines arguments for CaptionText events.
CErrorEventArgs	Defines arguments for the Error event.
CNetworkConditionChangedEventArgs	Defines arguments for NetworkConditionChanged events raised by the subscriber.
CRtcStatsReportArgs	Defines arguments for RtcStatsReport events.
CSenderStats	Sender-side network statistics.
CSubscriberMediaLinkStats	Provides subscriber media link statistics including local and remote transport metrics and network degradation information.
CSubscriberMediaLinkStatsEventArgs	Defines arguments for MediaLinkStatsUpdated events.
CVideoEventArgs	Defines arguments for the VideoEnabled and VideoDisabled events.
CVideoNetworkStatsEventArgs	Defines arguments for VideoStatsUpdated events.
CVideoQualityChangedEventArgs	Defines arguments for VideoQualityChanged events raised by the subscriber.
CThreadPoolDispatcher	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 doesn't matter whether the same ThreadPoolDispatcher is always used or a new one is created every time an IDispatcher is required. CPU-intensive or long-running tasks can be executed in the event handlers, as the underlying thread pool system is prepared to handle this. UI can't be manipulated directly in the event handlers. If this is required, events must be scheduled first to the UI thread.
▼CVideoCapturer	A video capturer implementation that captures video from on of the cameras available on the system.
CVideoDevice	Defines a video device (such as a camera).
CVideoFormat	Defines a video format available to a video device.
CVideoCaptureSettings	Defines the settings passed into the VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings) method.
CVideoFrame	Defines a video frame for the IVideoRenderer.RenderFrame(VideoFrame) and IVideoFrameConsumer.Consume(VideoFrame) methods.
CVideoTransformer	Defines a video transformation to be used in the Publisher.VideoTransformers array.
CWinFormsDispatcher	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 WinFormsDispatcher is always used or a new one is created every time an IDispatcher is required. 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.
CWPFDispatcher	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 new one is created every time an IDispatcher is required. 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.