Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs
Visit the Vonage API Developer PortalClasses | |
| struct | AudioData |
| Defines several parameters related to an audio sample batch. More... | |
| class | AudioDevice |
| A class that includes methods for setting the audio device to be used by publishers and subscribers. More... | |
| class | AudioDeviceSettings |
| Defines the settings retrieved from the IAudioDevice.GetAudioCapturerSettings() and IAudioDevice.GetAudioRendererSettings() methods. More... | |
| class | AudioTransformer |
| Defines an audio transformation to be used in the Publisher.AudioTransformers array. More... | |
| class | 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. More... | |
| class | Connection |
| Represents a connection between a client and an Vonage Video API session. More... | |
| class | Context |
| Used to manage resources for Session, Publisher, and Subscriber objects. More... | |
| class | DedicatedWorkerDispatcher |
| Implementation of IDispatcher that uses a dedicated worker thread to deliver events. Available for all application types. Delivery order is guaranteed. CPU-intensive or long-running tasks can be executed in the handlers, as the dedicated thread is not used for any other purpose. UI can't be manipulated directly in the handlers. If this is required, events must be scheduled first to the UI thread. More... | |
| class | 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 native API main thread and affect performance or responsiveness. UI can't be manipulated directly in the handlers. If this is required, events must be scheduled first to the UI thread. More... | |
| interface | IAudioDevice |
| Defines an Audio device to be used by all publishers and subscribers. More... | |
| class | IceConfig |
| A class for setting custom ICE configuration. More... | |
| struct | IceServer |
Defines the object to add to the List for the CustomIceServers property of the IceConfig class. More... | |
| interface | ICustomAudioTransformer |
| Interface used to define a custom audio transformer to be used in the AudioTransformer(string name, ICustomAudioTransformer transformer) constructor. More... | |
| interface | ICustomVideoTransformer |
| Interface used to define a custom vidoe transformer to be used in used in the VideoTransformer.VideoTransformer(string name, ICustomVideoTransformer transformer) constructor. More... | |
| interface | IDispatcher |
| Interface for a class used by Session, Publisher, and Subscriber instances to schedule events to a different thread. More... | |
| interface | IVideoCapturer |
| interface | IVideoFrameConsumer |
| Defines a video frame consumer to be used by the VideoCapturer of a Publisher. More... | |
| interface | IVideoRenderer |
| Defines a video renderer to be used by a Publisher or Subscriber object. More... | |
| class | Logger |
| Helper class that allows setting log level used by the SDK optionally providing a custom callback for log handling. This class provides a safer way manage native logging than directly invoking the native C API via DllImport. WARNING: DO call Disable() before closing the application to avoid closing exceptions. | |
| class | 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. More... | |
| class | OpenTokException |
| Defines errors thrown by the Vonage Video API Windows SDK. More... | |
| class | Publisher |
| A publisher captures an audio-video stream from the sources you specify. More... | |
| class | Session |
| Represents an Vonage Video API session in which the client is participating. More... | |
| class | 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. More... | |
| class | Subscriber |
| Used to consume an audio-video stream in the Vonage Video API session. More... | |
| class | ThreadPoolDispatcher |
| Implementation of IDispatcher that uses different threads from the managed ThreadPool to deliver events. Available for all application types. Important: Delivery order is not guaranteed. CPU-intensive or long-running tasks can be executed in the handlers, as the underlying thread system is prepared to handle this. UI can't be manipulated directly in the handlers. If this is required, events must be scheduled first to the UI thread. More... | |
| class | VideoCapturer |
| A video capturer implementation that captures video from on of the cameras available on the system. More... | |
| class | VideoCaptureSettings |
| Defines the settings passed into the VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings) method. More... | |
| class | VideoFrame |
| Defines a video frame for the IVideoRenderer.RenderFrame(VideoFrame) and IVideoFrameConsumer.Consume(VideoFrame) methods. More... | |
| class | VideoTransformer |
| Defines a video transformation to be used in the Publisher.VideoTransformers array. More... | |
| class | 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. 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. More... | |
| class | WPFDispatcher |
| Implementation of IDispatcher that uses the WPF Main/UI thread to dispatch events. Available only for WPF 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. More... | |
Functions | |
| delegate void | OnFrame (IntPtr frame) |
|
Defines error code values for OpenTokException objects.
| Enumerator | |
|---|---|
| UnknownError | Used for an unknown error. |
| GenericSDKError | Used for generic error. See provided error description. |
| AuthorizationFailure | An invalid API key or token was provided. |
| InvalidSessionId | Unable to connect: an invalid session ID was provided. |
| ConnectionFailed | The session failed to connect. |
| NoMessagingServer | There was an error connecting to the OpenTok messaging server. |
| ConnectionRefused | A socket could not be opened to OpenTok the messaging server. Check that outbound ports 443 and 8080 are accessible. |
| SessionStateFailed | The connection timed out while attempting to get the session's state. Check the network connection. |
| P2PSessionMaxParticipants | A peer-to-peer enabled session can only have two participants. |
| SessionConnectionTimeout | The connection timed out while attempting to connect to the session. Check the network connection. |
| SessionInternalError | Internal error connecting to the session. Try connecting again. |
| SessionInvalidSignalType | Invalid signal type. |
| SessionSignalDataTooLong | Invalid signal – the data string is too long. The maximum length is 8196. |
| SessionSignalTypeTooLong | Invalid signal – the type string is too long. The maximum length is 128. |
| ConnectionDropped | The connection to the OpenTok messaging server was dropped. Check the network connection. |
| SessionDisconnected | Attempting to publish to a disconnected session. |
| PublisherInternalError | Internal error when publishing. Try publishing again. |
| PublisherWebRTCError | Publisher WebRTC failure. |
| PublisherUnableToPublish | The publisher is unable to publish. |
| PublisherUnexpectedPeerConnectionDisconnection | The PeerConnection for the publisher's stream unexpectedly disconnected. |
| PublisherCannotAccessCamera | The publisher cannot access the specified camera. |
| PublisherCameraAccessDenied | The user denied access to the camera. |
| ConnectionTimedOut | Subscriber timed out while attempting to connect to the stream. Try resubscribing to the stream. |
| SubscriberWebRTCError | Subscriber WebRTC failure. |
| SubscriberServerCannotFindStream | The subscriber failed due to the stream being missing. This can happen if the subscriber is created at the same time the stream is removed from the session. |
| SubscriberStreamLimitExceeded | The subscriber failed due to the the limit to the number of subscribers the servers support. |
| SubscriberInternalError | Internal error when subscribing. Try subscribing again. |
| UnknownPublisherInstance | Cannot unpublish: An unknown Publisher instance was passed into the Session.Unpublish(Publisher) method. |
| UnknownSubscriberInstance | Cannot unsubscribe: An unknown Subscriber instance was passed into the Session.Unsubscribe(Subscriber) method. |
| SessionNullOrInvalidParameter | You passed an invalid parameter or the Session is null. |
| VideoCaptureFailed | There was an error in the video capturer. |
| CameraFailed | There was an error in acquiring video from the camera. |
| VideoRenderFailed | There was an error in the video renderer. |
| SessionSubscriberNotFound | The subscriber is unknown to this session. This is usually the result of calling Session.Unsubscribe(Subscriber) with a subscriber that is not associated with the session. |
| SessionPublisherNotFound | The publisher is unknown to this session. This is usually the result of calling Session.Unpublish(Publisher) with a publisher that is not publishing a stream to the session. |
| PublisherTimeout | Timeout while attempting to publish. |
| SessionBlockedCountry | Unable to connect to the session. Terms of service violation: export compliance. |
| SessionConnectionLimitExceeded | The connection failed due to the the limit to the number of connections the servers support. |
| SessionUnexpectedGetSessionInfoResponse | Unable to connect to the session. Try connecting again. |
| SessionIllegalState | Unable to connect to a session that is already connected. Or unable to subscribe to a stream that is no longer in the session. |
| SessionUnableToForceMute | Unable to force mute, perhaps because the client's capabilities are limited. |
| EncryptionSecretMissing | Tried to join an end-to-end encrypted session without an encryption secret |
| EncryptionInternalError | Internal error while encrypting a packet |
| DecryptionInternalError | Internal error while decrypting a packet |
| EncryptionSecretMismatch | Secret mismatch while decrypting a packet |
| InvalidEncryptionSecret | Invalid encryption secret |
|
Defines values for the IncludeServers property of the IceConfig class.
|
Defines values for the TransportPolicy property of the IceConfig class.
|
|
Defines the settings passed into the VideoCapturer.SetVideoContentHint(VideoContentHint contentHint) method.
|
Defines options for the Publisher.VideoSourceType property.
| Enumerator | |
|---|---|
| Camera | A camera video source. |
| Screen | A screen-sharing video source. |
| Custom | A custom video source. The custom stream video type applies only to Web generated streams. |
