Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs
Visit the Vonage API Developer PortalRepresents an archive of an Vonage Video API session. More...
Public Member Functions | |
| void | Stop () |
| Stops the OpenTok archive if it is being recorded. More... | |
| async Task | StopAsync () |
| Stops the OpenTok archive if it is being recorded. More... | |
| void | Delete () |
| Deletes the OpenTok archive. More... | |
| Task | DeleteAsync () |
| Deletes the OpenTok archive. More... | |
Protected Member Functions | |
| Archive () | |
| Initializes a new instance of the Archive class. More... | |
Properties | |
| long | CreatedAt [get, set] |
| The time at which the archive was created, in milliseconds since the Unix epoch. More... | |
| long | Duration [get, set] |
| The duration of the archive, in seconds. More... | |
| Guid | Id [get, set] |
| The archive ID. More... | |
| string | Name [get, set] |
| The name of the archive. More... | |
| int | PartnerId [get, set] |
| The Vonage Video API key associated with the archive. More... | |
| String | SessionId [get, set] |
| The session ID of the Vonage Video API session associated with this archive. More... | |
| String | Reason [get, set] |
| For archives with the status ArchiveStatus.STOPPED or ArchiveStatus.FAILED, this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed. More... | |
| bool | HasVideo [get, set] |
| Whether the archive includes a video track (true) or not (false). More... | |
| bool | HasAudio [get, set] |
| Whether the archive includes an audio track (true) or not (false). More... | |
| string | Resolution [get, set] |
| The resolution of the archive. More... | |
| OutputMode | OutputMode [get, set] |
| Whether all streams in the archive are recorded to a single file (OutputMode.COMPOSED) or to individual files (OutputMode.INDIVIDUAL). To record streams to individual files, pass OutputMode.INDIVIDUAL as the OutputMode parameter when calling the OpenTok.StartArchive method. More... | |
| long | Size [get, set] |
| The size of the MP4 file. For archives that have not been generated, this value is set to 0. We use long instead of int to support archives larger than 2GB. More... | |
| ArchiveStatus | Status [get, set] |
| The status of the archive, as defined by the ArchiveStatus enum. More... | |
| String | Url [get, set] |
| The download URL of the available MP4 file. This is only set for an archive with the status set to ArchiveStatus.AVAILABLE; for other archives, (including archives with the status of ArchiveStatus.UPLOADED) this method returns null. The download URL is obfuscated, and the file is only available from the URL for 10 minutes. To generate a new URL, call the ListArchives() or GetArchive() method of the OpenTok object. More... | |
| String | Password [get, set] |
| The encryption password of the archive. More... | |
| StreamMode | StreamMode [get, set] |
| Whether streams included in the archive are selected automatically ("auto", the default) or manually. More... | |
| string | MultiArchiveTag [get, set] |
| The unique tag for simultaneous archives (if one was set). More... | |
Represents an archive of an Vonage Video API session.
|
Initializes a new instance of the Archive class.
| void OpenTokSDK.Archive.Delete | ( | ) |
Deletes the 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.
| Task OpenTokSDK.Archive.DeleteAsync | ( | ) |
Deletes the 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.
| void OpenTokSDK.Archive.Stop | ( | ) |
Stops the OpenTok archive if it is being recorded.
Archives automatically stop recording after 120 minutes or when all clients have disconnected from the session being archived.
| async Task OpenTokSDK.Archive.StopAsync | ( | ) |
Stops the OpenTok archive if it is being recorded.
Archives automatically stop recording after 120 minutes or when all clients have disconnected from the session being archived.
|
The time at which the archive was created, in milliseconds since the Unix epoch.
|
The duration of the archive, in seconds.
|
Whether the archive includes an audio track (true) or not (false).
|
Whether the archive includes a video track (true) or not (false).
|
The archive ID.
|
The unique tag for simultaneous archives (if one was set).
|
The name of the archive.
|
Whether all streams in the archive are recorded to a single file (OutputMode.COMPOSED) or to individual files (OutputMode.INDIVIDUAL). To record streams to individual files, pass OutputMode.INDIVIDUAL as the OutputMode parameter when calling the OpenTok.StartArchive method.
|
The Vonage Video API key associated with the archive.
|
The encryption password of the archive.
|
For archives with the status ArchiveStatus.STOPPED or ArchiveStatus.FAILED, this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed.
|
The resolution of the archive.
|
The session ID of the Vonage Video API session associated with this archive.
|
The size of the MP4 file. For archives that have not been generated, this value is set to 0. We use long instead of int to support archives larger than 2GB.
|
The status of the archive, as defined by the ArchiveStatus enum.
|
Whether streams included in the archive are selected automatically ("auto", the default) or manually.
|
The download URL of the available MP4 file. This is only set for an archive with the status set to ArchiveStatus.AVAILABLE; for other archives, (including archives with the status of ArchiveStatus.UPLOADED) this method returns null. The download URL is obfuscated, and the file is only available from the URL for 10 minutes. To generate a new URL, call the ListArchives() or GetArchive() method of the OpenTok object.
