Contains methods for creating Vonage Video API sessions, generating tokens, and working with archives. More...

Detailed Description

Contains methods for creating Vonage Video API sessions, generating tokens, and working with archives.

To create a new OpenTok object, call the OpenTok() constructor with your Vonage Video API key and the API secret for your OpenTok project. Do not publicly share your API secret. You will use it with the OpenTok constructor (only on your web server) to create Vonage Video API sessions.

Constructor & Destructor Documentation

OpenTok() [1/2]

Creates an OpenTok object.

Parameters : | | | | --- | --- | | apiKey | Your Vonage Video API key. (See the TokBox account page | | apiSecret | Your Vonage Video API secret. (See the TokBox account page |

OpenTok() [2/2]

For TokBox internal use.

Parameters : | | | | --- | --- | | apiKey | | | apiSecret | | | apiUrl | |

Member Function Documentation

AddStreamToArchive()

Adds a stream to a currently running composed archive that was started with the streamMode set to StreamMode.Manual. You can call the method repeatedly with the same stream ID, to toggle the stream's audio or video in the archive.

Parameters : | | | | --- | --- | | archiveId | The archive ID. | | streamId | The stream ID. | | hasAudio | Whether the composed archive should include the stream's audio (true, the default) or not (false). | | hasVideo | Whether the composed archive should include the stream's video (true, the default) or not (false). |

AddStreamToArchiveAsync()

Adds a stream to a currently running composed archive that was started with the streamMode set to StreamMode.Manual. You can call the method repeatedly with the same stream ID, to toggle the stream's audio or video in the archive.

Parameters : | | | | --- | --- | | archiveId | The archive ID. | | streamId | The stream ID. | | hasAudio | Whether the composed archive should include the stream's audio (true, the default) or not (false). | | hasVideo | Whether the composed archive should include the stream's video (true, the default) or not (false). |

AddStreamToBroadcast()

Adds a stream to a currently running broadcast that was started with the the streamMode set to StreamMode.Manual. You can call the method repeatedly with the same stream ID, to toggle the stream's audio or video in the broadcast.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID. | | streamId | The stream ID. | | hasAudio | Whether the broadcast should include the stream's audio (true, the default) or not (false). | | hasVideo | Whether the broadcast should include the stream's video (true, the default) or not (false). |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | |

AddStreamToBroadcastAsync()

Adds a stream to a currently running broadcast that was started with the the streamMode set to StreamMode.Manual. You can call the method repeatedly with the same stream ID, to toggle the stream's audio or video in the broadcast.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID. | | streamId | The stream ID. | | hasAudio | Whether the broadcast should include the stream's audio (true, the default) or not (false). | | hasVideo | Whether the broadcast should include the stream's video (true, the default) or not (false). |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | |

CreateSession()

Creates a new Vonage Video API session.

Vonage Video API sessions do not expire. However, authentication tokens do expire (see the generateToken() method). Also note that sessions cannot explicitly be destroyed.

A session ID string can be up to 255 characters long.

Calling this method results in an OpenTokException in the event of an error. Check the error message for details.

You can also create a session using the OpenTok REST API or by logging in to your TokBox account.

Parameters : | | | | --- | --- | | location | An IP address that the Vonage Video API servers will use to situate the session in its global network. If you do not set a location hint, the Vonage Video API servers will be based on the first client connecting to the session. | | mediaMode | Whether the session will transmit streams using the Vonage Video API Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default, the setting is MediaMode.RELAYED. With the parameter set to MediaMode.RELAYED, the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay streams. The OpenTok Media Router provides the following benefits: - The Vonage Video API Media Router can decrease bandwidth usage in multiparty sessions. (When the mediaMode parameter is set to MediaMode.ROUTED, each client must send a separate audio-video stream to each client subscribing to it.) - The Vonage Video API Media Router can improve the quality of the user experience through audio fallback and video recovery With these features, if a client's connectivity degrades to a degree that it does not support video for a stream it's subscribing to, the video is dropped on that client (without affecting other clients), and the client receives audio only. If the client's connectivity improves, the video returns. - The Vonage Video API Media Router supports the archiving feature, which lets you record, save, and retrieve Vonage Video API sessions. | | archiveMode | Whether the session is automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL). By default, the setting is ArchiveMode.MANUAL and you must call the StartArchive method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set the mediaMode parameter to MediaMode.ROUTED | | encryption | Enables end-to-end media encryption in routed sessions. | | archiveName | Name of the archives in auto archived sessions. A session that begins with archive mode 'always' will be using this archive name for all archives of that session. Passing 'archiveName' with archive mode 'manual' will cause an error response. | | archiveResolution | Resolution of the archives in auto archived sessions. A session that begins with archive mode 'always' will be using this resolution for all archives of that session. Passing 'archiveResolution' with archive mode 'manual' will cause an error response. |

Returns : A Session object representing the new session. The Session.Id property of the Session is the session ID, which uniquely identifies the session. You will use this session ID in the client SDKs to identify the session. For example, when using the OpenTok.js library, use the session ID when calling the OT.initSession() method (to initialize an Vonage Video API session).

CreateSessionAsync()

Creates a new Vonage Video API session.

Vonage Video API sessions do not expire. However, authentication tokens do expire (see the generateToken() method). Also note that sessions cannot explicitly be destroyed.

A session ID string can be up to 255 characters long.

Calling this method results in an OpenTokException in the event of an error. Check the error message for details.

You can also create a session using the OpenTok REST API or by logging in to your TokBox account.

Parameters : | | | | --- | --- | | location | An IP address that the Vonage Video API servers will use to situate the session in its global network. If you do not set a location hint, the Vonage Video API servers will be based on the first client connecting to the session. | | mediaMode | Whether the session will transmit streams using the Vonage Video API Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default, the setting is MediaMode.RELAYED. With the parameter set to MediaMode.RELAYED, the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay streams. The OpenTok Media Router provides the following benefits: - The Vonage Video API Media Router can decrease bandwidth usage in multiparty sessions. (When the mediaMode parameter is set to MediaMode.ROUTED, each client must send a separate audio-video stream to each client subscribing to it.) - The Vonage Video API Media Router can improve the quality of the user experience through audio fallback and video recovery With these features, if a client's connectivity degrades to a degree that it does not support video for a stream it's subscribing to, the video is dropped on that client (without affecting other clients), and the client receives audio only. If the client's connectivity improves, the video returns. - The Vonage Video API Media Router supports the archiving feature, which lets you record, save, and retrieve Vonage Video API sessions. | | archiveMode | Whether the session is automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL). By default, the setting is ArchiveMode.MANUAL and you must call the StartArchive method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set the mediaMode parameter to MediaMode.ROUTED | | encryption | Enables end-to-end media encryption in routed sessions. | | archiveName | Name of the archives in auto archived sessions. A session that begins with archive mode 'always' will be using this archive name for all archives of that session. Passing 'archiveName' with archive mode 'manual' will cause an error response. | | archiveResolution | Resolution of the archives in auto archived sessions. A session that begins with archive mode 'always' will be using this resolution for all archives of that session. Passing 'archiveResolution' with archive mode 'manual' will cause an error response. |

Returns : A Session object representing the new session. The Session.Id property of the Session is the session ID, which uniquely identifies the session. You will use this session ID in the client SDKs to identify the session. For example, when using the OpenTok.js library, use the session ID when calling the OT.initSession() method (to initialize an Vonage Video API session).

DeleteArchive()

Deletes an OpenTok archive.

You can only delete an archive which has a status of "available" or "uploaded". Deleting an archive removes its record from the list of archives. For an "available" archive, it also removes the archive file, making it unavailable for download.

Parameters : | | | | --- | --- | | archiveId | The archive ID of the archive you want to delete. |

DeleteArchiveAsync()

Deletes an OpenTok archive.

You can only delete an archive which has a status of "available" or "uploaded". Deleting an archive removes its record from the list of archives. For an "available" archive, it also removes the archive file, making it unavailable for download.

Parameters : | | | | --- | --- | | archiveId | The archive ID of the archive you want to delete. |

Dial()

Connects a SIP platform to an Vonage Video API session.

For more information, including technical details and security considerations, see the the OpenTok SIP interconnect developer guide.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session to which the user will connect. | | token | The token for the session ID with which the SIP user will use to connect. | | sipUri | The SIP URI to be used as destination of the SIP call initiated from OpenTok to your SIP platform. If the SIP URI contains a ​transport=tls​ header, the negotiation between OpenTok and the SIP endpoint will be done securely. Note that this will only apply to the negotiation itself, and not to the transmission of audio. If you also audio transmission to be encrypted, set the Secure property of the of the DialOptions object passed into the options parameter to ​true​. This is an example of setting sipUri for a secure call negotiation: "sip:user@sip.partner.com;transport=tls". This is an example of insecure call negotiation: "sip:user@sip.partner.com". | | options | Optional parameters for SIP dialing. |

DialAsync()

Connects a SIP platform to an Vonage Video API session.

For more information, including technical details and security considerations, see the the OpenTok SIP interconnect developer guide.

Also see OpenTok.Dial.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session to which the user will connect. | | token | The token for the session ID with which the SIP user will use to connect. | | sipUri | The SIP URI to be used as destination of the SIP call initiated from OpenTok to your SIP platform. If the SIP URI contains a ​transport=tls​ header, the negotiation between OpenTok and the SIP endpoint will be done securely. Note that this will only apply to the negotiation itself, and not to the transmission of audio. If you also audio transmission to be encrypted, set the Secure property of the of the DialOptions object passed into the options parameter to ​true​. This is an example of setting sipUri for a secure call negotiation: "sip:user@sip.partner.com;transport=tls". This is an example of insecure call negotiation: "sip:user@sip.partner.com". | | options | Optional parameters for SIP dialing. |

DisableForceMute()

Disables the active mute state of the session. After you call this method, new streams published to the session will no longer have audio muted.

After you call the ForceMuteAll method, any streams published after the call are published with audio muted. Call the DisableForceMute() method to remove the mute state of a session, so that new published streams are not automatically muted.

Also see the DisableForceMuteAsync method.

Parameters : | | | | --- | --- | | sessionId | The session ID. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | Thrown when the session ID is invalid. | | OpenTokWebException | Thrown when an HTTP error has occurred. |

DisableForceMuteAsync()

Disables the active mute state of the session. After you call this method, new streams published to the session will no longer have audio muted.

After you call the ForceMuteAllAsync method, any streams published after the call are published with audio muted. Call the DisableForceMuteAsync() method to remove the mute state of a session, so that new published streams are not automatically muted.

Also see the DisableForceMute method.

Parameters : | | | | --- | --- | | sessionId | The session ID. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | Thrown when the session ID is invalid. | | OpenTokWebException | Thrown when an HTTP error has occurred. |

ForceDisconnect()

Force a specific client to disconnect from an Vonage Video API session.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session. | | connectionId | The connectionId of the connection in a session. |

ForceDisconnectAsync()

Force a specific client to disconnect from an Vonage Video API session.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session. | | connectionId | The connectionId of the connection in a session. |

ForceMuteAll()

Forces all streams (except for an optional list of streams) in a session to mute published audio.

In addition to existing streams, any streams that are published after the call to this method are published with audio muted. You can remove the mute state of a session by calling the DisableForceMute method.

Also see the ForceMuteAllAsync and ForceMuteStream methods.

Parameters : | | | | --- | --- | | sessionId | The ID of session. | | excludedStreamIds | The stream IDs of streams that will not be muted. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | Thrown when the session ID is invalid. | | OpenTokWebException | Thrown when an HTTP error has occurred. |

ForceMuteAllAsync()

Forces all streams (except for an optional list of streams) in a session to mute published audio.

In addition to existing streams, any streams that are published after the call to this method are published with audio muted. You can remove the mute state of a session by calling the DisableForceMuteAsync method.

Also see the ForceMuteAll and ForceMuteStreamAsync methods.

Parameters : | | | | --- | --- | | sessionId | The ID of session. | | excludedStreamIds | The stream IDs of streams that will not be muted. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | Thrown when the session ID is invalid. | | OpenTokWebException | Thrown when an HTTP error has occurred. |

ForceMuteStream()

Force the publisher of a specific stream to mute its published audio.

Also see the ForceMuteAll and ForceMuteStreamAsync methods.

Parameters : | | | | --- | --- | | sessionId | The session ID of the session that includes the stream. | | streamId | The stream ID. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | Thrown when session or stream ID is invalid. | | OpenTokWebException | Thrown when an HTTP error has occurred. |

ForceMuteStreamAsync()

Force the publisher of a specific stream to mute its published audio.

Also see the ForceMuteAll and ForceMuteStream methods.

Parameters : | | | | --- | --- | | sessionId | The session ID of the session that includes the stream. | | streamId | The stream ID. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | Thrown when session or stream ID is invalid. | | OpenTokWebException | Thrown when an HTTP error has occurred. |

GenerateToken()

Creates a token for connecting to an Vonage Video API session. In order to authenticate a user connecting to an Vonage Video API session, the client passes a token when connecting to the session.

For testing, you can also generate test tokens by logging in to your TokBox account.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session to which the user will connect. | | role | The role for the token. Valid values are defined in the Role enum: - Role.SUBSCRIBER (A subscriber can only subscribe to streams) - Role.PUBLISHER (A publisher can publish streams, subscribe to streams, and signal. (This is the default value if you do not specify a role.)) - Role.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. | | expireTime | The expiration time of the token, in seconds since the UNIX epoch. Pass in 0 to use the default expiration time of 24 hours after the token creation time. The maximum expiration time is 30 days after the creation time. | | data | A string containing connection metadata describing the end-user. For example, you can pass the user ID, name, or other data describing the end-user. The length of the string is limited to 1000 characters. This data cannot be updated once it is set. | | initialLayoutClassList | A list of strings values containing the initial layout for the stream. |

Returns

GetArchive()

Gets an Archive object for the given archive ID.

Parameters : | | | | --- | --- | | archiveId | The archive ID. |

Returns : The Archive object.

GetArchiveAsync()

Gets an Archive object for the given archive ID.

Parameters : | | | | --- | --- | | archiveId | The archive ID. |

Returns : The Archive object.

GetBroadcast()

Use this method to get a live streaming broadcast object of an Vonage Video API session.

For more information on broadcasting, see the Broadcast developer guide.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID of the broadcasting session |

Returns : The Broadcast object. This object includes properties defining the broadcast, including the broadcast ID.

GetBroadcastAsync()

Use this method to get a live streaming broadcast object of an Vonage Video API session.

For more information on broadcasting, see the Broadcast developer guide.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID of the broadcasting session |

Returns : The Broadcast object. This object includes properties defining the broadcast, including the broadcast ID.

GetRenderAsync()

Retrieves an Experience Composer renderer.

Parameters : | | | | --- | --- | | renderId | The Id of the rendering. |

GetStream()

Gets a Stream object for the given stream ID.

Parameters : | | | | --- | --- | | sessionId | The session ID of the Vonage Video API session. | | streamId | The stream ID. |

Returns : The Stream object.

GetStreamAsync()

Gets a Stream object for the given stream ID.

Parameters : | | | | --- | --- | | sessionId | The session ID of the Vonage Video API session. | | streamId | The stream ID. |

Returns : The Stream object.

ListArchives()

Returns a List of Archive objects, representing archives that are both both completed and in-progress, for your API key.

Parameters : | | | | --- | --- | | offset | The index offset of the first archive. 0 is offset of the most recently started archive. 1 is the offset of the archive that started prior to the most recent archive. | | count | The number of archives to be returned. The maximum number of archives returned is 1000. | | sessionId | The session ID. |

Returns : A List of Archive objects.

ListArchivesAsync()

Returns a List of Archive objects, representing archives that are both both completed and in-progress, for your API key.

Parameters : | | | | --- | --- | | offset | The index offset of the first archive. 0 is offset of the most recently started archive. 1 is the offset of the archive that started prior to the most recent archive. | | count | The number of archives to be returned. The maximum number of archives returned is 1000. | | sessionId | The session ID. |

Returns : A List of Archive objects.

ListRendersAsync()

Retrieves all Experience Composer renderers matching the provided request.

Parameters : | | | | --- | --- | | request | The request containing filtering options. |

Returns : The list of rendering.

ListStreams()

Returns a List of Stream objects, representing streams that are in-progress, for the session ID.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session. |

Returns : A List of Stream objects.

Exceptions : | | | | --- | --- | | OpenTokArgumentException | |

ListStreamsAsync()

Returns a List of Stream objects, representing streams that are in-progress, for the session ID.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session. |

Returns : A List of Stream objects.

Exceptions : | | | | --- | --- | | OpenTokArgumentException | |

PlayDTMF()

Send DTMF digits to all participants in an active Vonage Video API session or to a specific client connected to that session.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session that will receive the DTMF string. | | connectionId | The connection connection ID of the client you are sending the DTMF signal to. Leave this empty to send a DTMF signal to all clients connected to the session. | | digits | This is the string of DTMF digits to send. This can include 0-9, '*', '#', and 'p'. A p indicates a pause of 500ms (if you need to add a delay in sending the digits). |

PlayDTMFAsync()

Send DTMF digits to all participants in an active Vonage Video API session or to a specific client connected to that session.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session that will receive the DTMF string. | | connectionId | The connection connection ID of the client you are sending the DTMF signal to. Leave this empty to send a DTMF signal to all clients connected to the session. | | digits | This is the string of DTMF digits to send. This can include 0-9, '*', '#', and 'p'. A p indicates a pause of 500ms (if you need to add a delay in sending the digits). |

RemoveStreamFromArchive()

Removes a stream from a composed archive that was started with the streamMode set to StreamMode.Manual.

Parameters : | | | | --- | --- | | archiveId | The archive ID. | | streamId | The stream ID. |

RemoveStreamFromArchiveAsync()

Removes a stream from a composed archive that was started with the streamMode set to StreamMode.Manual.

Parameters : | | | | --- | --- | | archiveId | The archive ID. | | streamId | The stream ID. |

RemoveStreamFromBroadcast()

Removes a stream from a broadcast that was started with the the streamMode set to StreamMode.Manual.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID. | | streamId | The stream ID. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | |

RemoveStreamFromBroadcastAsync()

Removes a stream from a broadcast that was started with the the streamMode set to StreamMode.Manual.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID. | | streamId | The stream ID. |

Exceptions : | | | | --- | --- | | OpenTokArgumentException | |

SetArchiveLayout()

Allows you to dynamically change the layout of a composed archive while it's being recorded see Customizing the video layout for composed archives for details regarding customizing a layout.

Parameters : | | | | --- | --- | | archiveId | | | layout | |

Returns

SetArchiveLayoutAsync()

Allows you to dynamically change the layout of a composed archive while it's being recorded see Customizing the video layout for composed archives for details regarding customizing a layout.

Parameters : | | | | --- | --- | | archiveId | | | layout | |

Returns

SetBroadcastLayout()

Sets the layout type for the broadcast. For a description of layout types, see Configuring the video layout for OpenTok live streaming broadcasts.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID of the broadcasting session. | | layout | The BroadcastLayout that defines layout options for the broadcast. |

SetBroadcastLayoutAsync()

Sets the layout type for the broadcast. For a description of layout types, see Configuring the video layout for OpenTok live streaming broadcasts.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID of the broadcasting session. | | layout | The BroadcastLayout that defines layout options for the broadcast. |

SetCustomUserAgent()

Sets a custom user-agent value. The HttpClient will append this value, if it exists, to the initial user-agent value.

Parameters : | | | | --- | --- | | value | The custom user-agent value. |

SetDefaultRequestTimeout()

Set's the default request timeout (in milliseconds) for all WebRequest's sent by the SDK

Parameters : | | | | --- | --- | | timeout | |

SetStreamClassLists()

Sets the layout class list for streams in a session. Layout classes are used in the layout for composed archives and live streaming broadcasts. For more information, see Customizing the video layout for composed archives and Configuring video layout for OpenTok live streaming broadcasts.

You can set the initial layout class list for streams published by a client when you generate used by the client. See the GenerateToken method.

Parameters : | | | | --- | --- | | sessionId | The sessionId | | streams | A list of StreamsProperties that defines class lists for one or more streams in the session. |

SetStreamClassListsAsync()

Sets the layout class list for streams in a session. Layout classes are used in the layout for composed archives and live streaming broadcasts. For more information, see Customizing the video layout for composed archives and Configuring video layout for OpenTok live streaming broadcasts.

You can set the initial layout class list for streams published by a client when you generate used by the client. See the GenerateToken method.

Parameters : | | | | --- | --- | | sessionId | The sessionId | | streams | A list of StreamsProperties that defines class lists for one or more streams in the session. |

Signal()

Sends a signal to clients (or a specific client) connected to an Vonage Video API session.

Parameters : | | | | --- | --- | | sessionId | The Vonage Video API sessionId where the signal will be sent. | | signalProperties | This signalProperties defines the payload for the signal. | | connectionId | An optional parameter used to send the signal to a specific connection in a session. |

SignalAsync()

Sends a signal to clients (or a specific client) connected to an Vonage Video API session.

Parameters : | | | | --- | --- | | sessionId | The Vonage Video API sessionId where the signal will be sent. | | signalProperties | This signalProperties defines the payload for the signal. | | connectionId | An optional parameter used to send the signal to a specific connection in a session. |

StartArchive()

Starts archiving an Vonage Video API session.

Clients must be actively connected to the Vonage Video API session for you to successfully start recording an archive.

You can only record one archive at a time for a given session. You can only record archives of sessions that uses the Vonage Video API Media Router (sessions with the media mode set to routed); you cannot archive sessions with the media mode set to relayed.

Note that you can have the session be automatically archived by setting the archiveMode parameter of the CreateSession method to ArchiveMode.ALWAYS.

Parameters : | | | | --- | --- | | sessionId | The session ID of the Vonage Video API session to archive. | | name | The name of the archive. You can use this name to identify the archive. It is a property of the Archive object, and it is a property of archive-related events in the OpenTok client libraries. | | hasVideo | Whether the archive will record video (true) or not (false). The default value is true (video is recorded). If you set both hasAudio and hasVideo to false, the call to the StartArchive method results in an error. | | hasAudio | Whether the archive will record audio (true) or not (false). The default value is true (audio is recorded). If you set both hasAudio and hasVideo to false, the call to the StartArchive method results in an error. | | outputMode | Whether all streams in the archive are recorded to a single file (OutputMode.COMPOSED, the default) or to individual files (OutputMode.INDIVIDUAL). | | resolution | The resolution for the archive. The default for OutputMode.COMPOSED is "640x480". You cannot specify the resolution for OutputMode.INDIVIDUAL. | | layout | The layout that you want to use for your archive. If type is set to LayoutType.custom you must provide a StyleSheet string to Vonage how to layout your archive. | | streamMode | Whether streams included in the archive are selected automatically (StreamMode.Auto, the default) or manually (StreamMode.Manual). With StreamMode.Manual, you will specify streams to be included in the archive using the OpenTok.AddStreamToArchive and OpenTok.RemoveStreamFromArchive methods (or the OpenTok.AddStreamToArchiveAsync and OpenTok.RemoveStreamFromArchiveAsync methods). | | multiArchiveTag | Set this to support recording multiple archives for the same session simultaneously. Set this to a unique string for each simultaneous archive of an ongoing session. You must also set this option when manually starting an archive in a session that is automatically archived. If you do not specify a unique multiArchiveTag, you can only record one archive at a time for a given session. See Simultaneous archives. |

Returns : The Archive object. This object includes properties defining the archive, including the archive ID.

StartArchiveAsync()

Starts archiving an Vonage Video API session.

Clients must be actively connected to the Vonage Video API session for you to successfully start recording an archive.

You can only record one archive at a time for a given session. You can only record archives of sessions that uses the Vonage Video API Media Router (sessions with the media mode set to routed); you cannot archive sessions with the media mode set to relayed.

Note that you can have the session be automatically archived by setting the archiveMode parameter of the CreateSession method to ArchiveMode.ALWAYS.

Parameters : | | | | --- | --- | | sessionId | The session ID of the Vonage Video API session to archive. | | name | The name of the archive. You can use this name to identify the archive. It is a property of the Archive object, and it is a property of archive-related events in the OpenTok client libraries. | | hasVideo | Whether the archive will record video (true) or not (false). The default value is true (video is recorded). If you set both hasAudio and hasVideo to false, the call to the StartArchive method results in an error. | | hasAudio | Whether the archive will record audio (true) or not (false). The default value is true (audio is recorded). If you set both hasAudio and hasVideo to false, the call to the StartArchive method results in an error. | | outputMode | Whether all streams in the archive are recorded to a single file (OutputMode.COMPOSED, the default) or to individual files (OutputMode.INDIVIDUAL). | | resolution | The resolution for the archive. The default for OutputMode.COMPOSED is "640x480". You cannot specify the resolution for OutputMode.INDIVIDUAL. | | layout | The layout that you want to use for your archive. If type is set to LayoutType.custom you must provide a StyleSheet string to Vonage how to layout your archive. | | streamMode | Whether streams included in the archive are selected automatically (StreamMode.Auto, the default) or manually (StreamMode.Manual). With StreamMode.Manual, you will specify streams to be included in the archive using the OpenTok.AddStreamToArchive and OpenTok.RemoveStreamFromArchive methods (or the OpenTok.AddStreamToArchiveAsync and OpenTok.RemoveStreamFromArchiveAsync methods). | | multiArchiveTag | Set this to support recording multiple archives for the same session simultaneously. Set this to a unique string for each simultaneous archive of an ongoing session. You must also set this option when manually starting an archive in a session that is automatically archived. If you do not specify a unique multiArchiveTag, you can only record one archive at a time for a given session. See Simultaneous archives. |

Returns : The Archive object. This object includes properties defining the archive, including the archive ID.

StartAudioConnectorAsync()

Sends audio from a Vonage Video API session to a WebSocket. For more information, see the Audio Connector developer guide.

Parameters : | | | | --- | --- | | request | The request to start the audio connector. |

Returns : The response object from the server.

StartBroadcast()

Use this method to start a live streaming for an Vonage Video API session. This broadcasts the session to an HLS (HTTP live streaming) or to RTMP streams.

To successfully start broadcasting a session, at least one client must be connected to the session.

You can only have one active live streaming broadcast at a time for a session (however, having more than one would not be useful). The live streaming broadcast can target one HLS endpoint and up to five RTMP servers simultaneously for a session. You can only start live streaming for sessions that use the Vonage Video API Media Router (with the media mode set to routed); you cannot use live streaming with sessions that have the media mode set to relayed Vonage Video API Media Router. See The OpenTok Media Router and media modes.

For more information on broadcasting, see the Broadcast developer guide.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session. | | hls | Whether to include an HLS broadcast. | | rtmpList | A list of Rtmp objects, defining RTMP streams to be broadcast (up to five). | | resolution | The resolution of the broadcast video. Valid resolutions are "640x480", "1280x720", "1920x1080", "480x640", "720x1280", "1080x1920". | | maxDuration | The maximum duration for the broadcast, in seconds. The broadcast will automatically stop when the maximum duration is reached. You can set the maximum duration to a value from 60 (60 seconds) to 36000 (10 hours). The default maximum duration is 2 hours (7,200 seconds). | | layout | Specify this BroadcastLayout object to assign the initial layout type for the broadcast. | | streamMode | Whether streams included in the broadcast are selected automatically (StreamMode.Auto, the default) or manually (StreamMode.Manual). With StreamMode.Manual, you will specify streams to be included in the broadcast using the OpenTok.AddStreamToBroadcast and OpenTok.RemoveStreamFromBroadcast methods (or the OpenTok.AddStreamToBroadcastAsync and OpenTok.RemoveStreamFromBroadcastAsync methods). | | dvr | Whether to enable DVR functionality — rewinding, pausing, and resuming — in players that support it (true), or not (false, the default). With DVR enabled, the HLS URL will include a ?DVR query string appended to the end. See DVR functionality | | lowLatency | Whether to enable low-latency mode for the HLSstream. Some HLS players do not support low-latency mode. This feature is incompatible with DVR mode HLS broadcasts. See Low-latency HLS broadcasts | | multiBroadcastTag | Set this to support multiple broadcasts for the same session simultaneously. Set this to a unique string for each simultaneous broadcast of an ongoing session. See Simultaneous broadcasts. | | hasAudio | Whether the broadcast has audio (default is true). | | hasVideo | Whether the broadcast has video (default is true). |

Returns : The Broadcast object. This object includes properties defining the archive, including the archive ID.

StartBroadcastAsync()

Use this method to start a live streaming for an Vonage Video API session. This broadcasts the session to an HLS (HTTP live streaming) or to RTMP streams.

To successfully start broadcasting a session, at least one client must be connected to the session.

You can only have one active live streaming broadcast at a time for a session (however, having more than one would not be useful). The live streaming broadcast can target one HLS endpoint and up to five RTMP servers simultaneously for a session. You can only start live streaming for sessions that use the Vonage Video API Media Router (with the media mode set to routed); you cannot use live streaming with sessions that have the media mode set to relayed Vonage Video API Media Router. See The OpenTok Media Router and media modes.

For more information on broadcasting, see the Broadcast developer guide.

Parameters : | | | | --- | --- | | sessionId | The session ID corresponding to the session. | | hls | Whether to include an HLS broadcast. | | rtmpList | A list of Rtmp objects, defining RTMP streams to be broadcast (up to five). | | resolution | The resolution of the broadcast video. Valid resolutions are "640x480", "1280x720", "1920x1080", "480x640", "720x1280", "1080x1920". | | maxDuration | The maximum duration for the broadcast, in seconds. The broadcast will automatically stop when the maximum duration is reached. You can set the maximum duration to a value from 60 (60 seconds) to 36000 (10 hours). The default maximum duration is 2 hours (7,200 seconds). | | layout | Specify this BroadcastLayout object to assign the initial layout type for the broadcast. | | streamMode | Whether streams included in the broadcast are selected automatically (StreamMode.Auto, the default) or manually (StreamMode.Manual). With StreamMode.Manual, you will specify streams to be included in the broadcast using the OpenTok.AddStreamToBroadcast and OpenTok.RemoveStreamFromBroadcast methods (or the OpenTok.AddStreamToBroadcastAsync and OpenTok.RemoveStreamFromBroadcastAsync methods). | | dvr | Whether to enable DVR functionality — rewinding, pausing, and resuming — in players that support it (true), or not (false, the default). With DVR enabled, the HLS URL will include a ?DVR query string appended to the end. See DVR functionality | | lowLatency | Whether to enable low-latency mode for the HLSstream. Some HLS players do not support low-latency mode. This feature is incompatible with DVR mode HLS broadcasts. See Low-latency HLS broadcasts | | multiBroadcastTag | Set this to support multiple broadcasts for the same session simultaneously. Set this to a unique string for each simultaneous broadcast of an ongoing session. See Simultaneous broadcasts. | | hasAudio | Whether the broadcast has audio (default is true). | | hasVideo | Whether the broadcast has video (default is true). |

Returns : The Broadcast object. This object includes properties defining the archive, including the archive ID.

StartRenderAsync()

Starts a new Experience Composer renderer for an Vonage Video API session.

For more information, see the . Experience Composer developer guide.

Parameters : | | | | --- | --- | | request | The rendering request. |

Returns : The generated rendering.

StopArchive()

Stops an OpenTok archive that is being recorded.

Archives automatically stop recording after 120 minutes or when all clients have disconnected from the session being archived.

Parameters : | | | | --- | --- | | archiveId | The archive ID of the archive you want to stop recording. |

Returns : The Archive object corresponding to the archive being stopped.

StopArchiveAsync()

Stops an OpenTok archive that is being recorded.

Archives automatically stop recording after 120 minutes or when all clients have disconnected from the session being archived.

Parameters : | | | | --- | --- | | archiveId | The archive ID of the archive you want to stop recording. |

Returns : The Archive object corresponding to the archive being stopped.

StopAudioConnectorAsync()

Stops sending audio for a Vonage Video API session.

Parameters : | | | | --- | --- | | connectionId | The OpenTok connection ID for the Audio Connector WebSocket connection in the Vonage Video API session. See [AudioConnector.ConnectionId]. |

StopBroadcast()

Use this method to stop a live broadcast of an Vonage Video API session. Note that broadcasts automatically stop 120 minutes after they are started.

For more information on broadcasting, see the Broadcast developer guide.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID of the broadcasting session |

Returns : The Broadcast object. This object includes properties defining the broadcast, including the broadcast ID.

StopBroadcastAsync()

Use this method to stop a live broadcast of an Vonage Video API session. Note that broadcasts automatically stop 120 minutes after they are started.

For more information on broadcasting, see the Broadcast developer guide.

Parameters : | | | | --- | --- | | broadcastId | The broadcast ID of the broadcasting session |

Returns : The Broadcast object. This object includes properties defining the broadcast, including the broadcast ID.

StopRenderAsync()

Stops an Experience Composer renderer.

Parameters : | | | | --- | --- | | renderId | The Id of the rendering. |

Property Documentation

ApiKey

The Vonage Video API key passed into the OpenTok() constructor.

ApiSecret

The Vonage Video API secret passed into the OpenTok() constructor.

Client

For internal use

Debug

Enables writing request/response details to console. Don't use in a production environment.