OpenTok .NET SDK reference
The OpenTok .NET SDK includes the following classes:
| Class | Description |
|---|---|
| OpenTokSDK | Defines values for the archiveMode property of the Session object. You also use these values for the archiveMode parameter of the OpenTok.CreateSession method. |
| OpenTokSDK.Archive | Represents an archive of an Vonage Video API session. |
| OpenTokSDK.ArchiveLayout | Layout the archive is going to use |
| OpenTokSDK.ArchiveList | A class for accessing an array of Archive objects. |
| OpenTokSDK.AudioConnectorStartRequest | Represents a request to send audio from a Vonage Video API session to a WebSocket . |
| OpenTokSDK.AudioConnectorStartRequest.WebSocket | Options for configuring the connect call for WebSocket . |
| OpenTokSDK.Broadcast | Represents a broadcast of an Vonage Video API session. |
| OpenTokSDK.Broadcast.BroadcastHlsSettings | Provides details on an HLS stream. |
| OpenTokSDK.Broadcast.BroadcastSettings | Provides details on an HLS broadcast stream. This object includes an hls property that specifies whether DVR functionality and low-latency mode are enabled for the HLS stream. |
| OpenTokSDK.BroadcastLayout | Represents a broadcast layout of an Vonage Video API session. |
| OpenTokSDK.Constants | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTokSDK.Constants.OpenTokVersion | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTokSDK.DialAuth | Used to set the username and password to be used in the OpenTok.Dial method. These are used in the SIP INVITE request for HTTP digest authentication, if it is required by your SIP platform. See the DialOptions class. |
| OpenTokSDK.DialOptions | Used to define options for the the OpenTok.Dial method. These are custom headers to be added to the SIP INVITE request initiated from OpenTok to your SIP platform. |
| OpenTokSDK.Exception | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTokSDK.Exception.OpenTokArgumentException | Defines an exception object thrown when an invalid argument is passed into a method. |
| OpenTokSDK.Exception.OpenTokException | Defines exceptions in the OpenTok SDK. |
| OpenTokSDK.Exception.OpenTokWebException | Defines an exception object thrown when a REST API call results in an error response. |
| OpenTokSDK.OpenTok | Contains methods for creating Vonage Video API sessions, generating tokens, and working with archives. |
| OpenTokSDK.Render.ListRendersRequest | Represents a request for retrieving Experience Composer renderers. ( OpenTok.ListRendersAsync ). |
| OpenTokSDK.Render.RenderResolutionConverter | Custom converter for serializing RenderResolution. |
| OpenTokSDK.Render.StartRenderRequest | Represents request options for OpenTok.StartRenderAsync . |
| OpenTokSDK.Render.StartRenderRequest.PublisherProperties | The Publisher properties for the composed output stream of a Render . |
| OpenTokSDK.Rtmp | Represents an RTMP stream in an Vonage Video API session. |
| OpenTokSDK.Session | Represents an Vonage Video API session. Use the OpenTok.CreateSession method of the OpenTok class to create an Vonage Video API session. Use the Id property of the Session object to get the session ID. |
| OpenTokSDK.SignalProperties | Defines signal payload for the Signal API. |
| OpenTokSDK.Sip | Dial response object containing SIP information |
| OpenTokSDK.Stream | Represents a stream in an Vonage Video API session. |
| OpenTokSDK.StreamList | A class for accessing an array of Stream objects. |
| OpenTokSDK.StreamProperties | Defines class lists for one or more streams in the session. Used by the OpenTok.SetStreamClassLists() method. |
| OpenTokSDK.Util | Use the OpenTok.js library to build Vonage Video API-powered WebRTC video, voice and messaging communications apps on iOS devices. |
| OpenTokSDK.Util.HttpClient | The custom user-agent value. The HttpClient will append this value, if it exists, to the initial user-agent value. |
| OpenTokSDK.Util.OpenTokUtils | Used if a WebException is caught to check that the TLS version makes sense If the TLS version is less than 1.2 and not the System Default (0) this method throws an exception |