Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs
Visit the Vonage API Developer PortalClasses | |
| class | Archive |
| Represents an archive of an Vonage Video API session. More... | |
| class | ArchiveLayout |
| Layout the archive is going to use More... | |
| class | ArchiveList |
| A class for accessing an array of Archive objects. More... | |
| struct | AudioConnector |
| Represents an Audio Connector. More... | |
| class | AudioConnectorStartRequest |
| Represents a request to send audio from a Vonage Video API session to a WebSocket. More... | |
| class | Broadcast |
| Represents a broadcast of an Vonage Video API session. More... | |
| class | BroadcastLayout |
| Represents a broadcast layout of an Vonage Video API session. More... | |
| class | 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. More... | |
| class | 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. More... | |
| class | OpenTok |
| Contains methods for creating Vonage Video API sessions, generating tokens, and working with archives. More... | |
| class | RoleExtensions |
| For internal use. | |
| class | Rtmp |
| Represents an RTMP stream in an Vonage Video API session. More... | |
| class | 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. More... | |
| class | SignalProperties |
| Defines signal payload for the Signal API. More... | |
| class | Sip |
| Dial response object containing SIP information More... | |
| class | Stream |
| Represents a stream in an Vonage Video API session. More... | |
| class | StreamList |
| A class for accessing an array of Stream objects. More... | |
| class | StreamProperties |
| Defines class lists for one or more streams in the session. Used by the OpenTok.SetStreamClassLists() method. More... | |
Enumerations | |
| enum | ArchiveStatus { ArchiveStatus.AVAILABLE, ArchiveStatus.DELETED, ArchiveStatus.FAILED, ArchiveStatus.PAUSED, ArchiveStatus.STARTED, ArchiveStatus.STOPPED, ArchiveStatus.UPLOADED, ArchiveStatus.EXPIRED, ArchiveStatus.UNKOWN } |
| Defines values returned by the Status property of an Archive object. See the ListArchives() method of the OpenTok class. More... | |
| enum | OutputMode { OutputMode.COMPOSED, OutputMode.INDIVIDUAL } |
| Defines values for the OutputMode property of an Archive object. More... | |
| enum | LayoutType { LayoutType.bestFit, LayoutType.custom, LayoutType.horizontalPresentation, LayoutType.pip, LayoutType.verticalPresentation } |
| The Layout Type for the an Archive. More... | |
| enum | Role { Role.PUBLISHER, Role.SUBSCRIBER, Role.MODERATOR } |
| Defines values for the role parameter of the GenerateToken method of the OpenTok class. More... | |
| enum | ScreenShareLayoutType { ScreenShareLayoutType.Pip, ScreenShareLayoutType.BestFit, ScreenShareLayoutType.VerticalPresentation, ScreenShareLayoutType.HorizontalPresentation } |
| For archive and broadcast layouts, the layout type to use with screen shares. If this enum is used, the Type property should be set to BestFit. More... | |
| enum | MediaMode { MediaMode.ROUTED, MediaMode.RELAYED } |
| Defines values for the mediaMode parameter of the OpenTok.CreateSession method of the OpenTok class. More... | |
| enum | ArchiveMode { ArchiveMode.MANUAL, ArchiveMode.ALWAYS } |
| Defines values for the archiveMode property of the Session object. You also use these values for the archiveMode parameter of the OpenTok.CreateSession method. More... | |
| enum | StreamMode { StreamMode.Auto, StreamMode.Manual } |
Whether streams included in an archive or broadcast are selected automatically or manually. See the streamMode parameter of the OpenTok.StartArchive and OpenTok.StartBroadcast methods). More... | |
Defines values for the archiveMode property of the Session object. You also use these values for the archiveMode parameter of the OpenTok.CreateSession method.
| Enumerator | |
|---|---|
| MANUAL | The session is not archived automatically. To archive the session, you can call the OpenTok.StartArchive method. |
| ALWAYS | The session is archived automatically (as soon as there are clients publishing streams to the session). |
Defines values returned by the Status property of an Archive object. See the ListArchives() method of the OpenTok class.
| Enumerator | |
|---|---|
| AVAILABLE | The archive file is available for download from the OpenTok cloud. You can get the URL of the download file by getting the Url property of the Archive object. |
| DELETED | The archive file has been deleted. |
| FAILED | The recording of the archive failed. |
| PAUSED | The archive is in progress and no clients are publishing streams to the session. When an archive is in progress and any client publishes a stream, the status is STARTED. When an archive is PAUSED, nothing is recorded. When a client starts publishing a stream, the recording starts (or resumes). If all clients disconnect from a session that is being archived, the status changes to PAUSED, and after 60 seconds the archive recording stops (and the status changes to STOPPED). |
| STARTED | The archive recording has started and is in progress. |
| STOPPED | The archive recording has stopped, but the file is not available. |
| UPLOADED | The archive is available for download from the the upload targetAmazon S3 bucket or Windows Azure container you set up for your OpenTok project. |
| EXPIRED | The archive file is no longer available for download from the OpenTok cloud. |
| UNKOWN | The status of the archive is unknown. |
The Layout Type for the an Archive.
|
Defines values for the mediaMode parameter of the OpenTok.CreateSession method of the OpenTok class.
| Enumerator | |
|---|---|
| ROUTED | The session will transmit streams using the Vonage Video API Media Router. |
| RELAYED | The session will attempt to transmit streams directly between clients. If two clients cannot send and receive each others' streams, due to firewalls on the clients' networks, their streams will be relayed using the OpenTok TURN Server. |
Defines values for the OutputMode property of an Archive object.
| Enumerator | |
|---|---|
| COMPOSED | All streams in the archive are recorded to a single (composed) file. |
| INDIVIDUAL | Each stream in the archive is recorded to its own individual file. |
|
Defines values for the role parameter of the GenerateToken method of the OpenTok class.
| Enumerator | |
|---|---|
| PUBLISHER | A publisher can publish streams, subscribe to streams, and signal. (This is the default value if you do not set a role when calling GenerateToken method of the OpenTok class. |
| SUBSCRIBER | A subscriber can only subscribe to streams. |
| MODERATOR | In addition to the privileges granted to a publisher, a moderator can perform moderation functions, such as forcing clients to disconnect, to stop publishing streams, or to mute audio in published streams. See the Moderation developer guide. |
Whether streams included in an archive or broadcast are selected automatically or manually. See the streamMode parameter of the OpenTok.StartArchive and OpenTok.StartBroadcast methods).
| Enumerator | |
|---|---|
| Auto | All streams in the session can be included. |
| Manual | You will specify streams to be included in the archive or broadcast. For an archive, use the OpenTok.AddStreamToArchive and OpenTok.RemoveStreamFromArchive methods (or the OpenTok.AddStreamToArchiveAsync and OpenTok.RemoveStreamFromArchiveAsync methods). For a broadcast, use the OpenTok.AddStreamToBroadcast and OpenTok.RemoveStreamFromBroadcast methods (or the OpenTok.AddStreamToBroadcastAsync and OpenTok.RemoveStreamFromBroadcastAsync methods). |
