Detailed Description
The Archive Service provides access to the edge archive on an Encoder.
If and Encoder has an edge archive configured the SDK can access the archive and retrieve the following information:
- Playback footage from the Remote archive over the live TVI stream:
- Get a list of days, hours and minutes for which recorded footage exists.
- Get a list of bookmarks that are available in the archive.
- Start and stop playback of the remote archive
- Change the playback speed (fast forward, rewind, pause, normal speed).
- Download the Archive content at its original recorded quality
- The Archive Exporter Service can download the original file as stored on the device. This file may be password protected and have fragile watermarking.
- The GoP (Group of Pictures) downloader will download the archive video content as a standards based file chunks.
The Archive Service can only be used by one client application at a time. While the Archive Service is held open by one user other users (applications) will not be able to open it. When designing applications please keep this in mind. For example, it may be beneficial to add a feature that will automatically close the Archive Service if the user has not used it for a while. It is also worth noting that the Archive Exporter Service cannot be used at the same time as recorded footage is being played back live.
File Download
There are two mechanisms to download the original archive file from the edge archive.
Original File
Using the Archive Exporter Service the original file as stored on the device can be downloaded.
For Encoder with built in Archives these files are stored in our CSX archive format. CSX files include the video and audio recorded in high quality and in a standards based format. CSX files also have fragile watermarking to protect files from tampering and can also be encrypted with a user defined password. The files also store associated metadata relevant to the recorded footage.
CSX files can only be downloaded in their entirety. To view CSX files use the "Export Player" application.
GoP Transfer
Alternatively the GoP download service can be used to retrieve just the standards based footage stored on the device.
The encoder will extract the standards based content from the CSX file. Any encryption, watermarking and metadata is not retrievable.
The GoP transfer will transfer only the times requested from the CSX file and can will retrieve partial files to the nearest I frame.
Sample applications
Full sample applications are available demonstrating the capabilities of the SDK
Files | |
| file | ArchiveRecordingInfo.h |
| The ArchiveRecordingInfo class provides information on the times that the archive has recorded footage for. | |
| file | Timeline.h |
| An ITimelineWatcher interface is used to receive notifications when an Timeline object is updated. | |
Classes | |
| class | EdgeVisDecoderSDK::ArchiveBookmark |
| Contains the details of an Archive bookmark. More... | |
| class | EdgeVisDecoderSDK::ArchiveExporterService |
| The ArchiveExporter Service handles listing files from a remote archive device connected to an Encoder and allows the files to be downloaded. More... | |
| class | EdgeVisDecoderSDK::ArchiveFile |
| A simple container class for information about a file on a remote archive device connected to an Encoder. More... | |
| class | EdgeVisDecoderSDK::ArchiveService |
| The Archive Service provides access to the edge archive on an Encoder. More... | |
| class | EdgeVisDecoderSDK::GOPData |
| The GOP Data class represents a downloaded element from the edge archive of a supported encoder. More... | |
| class | EdgeVisDecoderSDK::GOPDataBlock |
| The GOP Data Block class represents an individual element of a GOPData buffer. More... | |
| class | EdgeVisDecoderSDK::GOPDownloadService |
| The GOP Download Service handles the download of GOPs (Group of Pictures) from the edge archive of supported encoders. More... | |
| class | EdgeVisDecoderSDK::IGOPDownloadListener |
| The interface for the GOP download service callbacks. More... | |
| class | EdgeVisDecoderSDK::Timeline |
| This contains lists of days, hours and minutes that the archive holds footage for. More... | |
Typedefs | |
| typedef enum ArchiveFileSource | ArchiveFileSource |
| The possible sources of an archive file. More... | |
| typedef enum GOPDataBlockType | GOPDataBlockType |
| Contains the type of GOPDataBlock. More... | |
| typedef enum TimelineEntryFlags | TimelineEntryFlags |
| This contains values representing the type of timeline entry. More... | |
Enumerations |
Typedef Documentation
| typedef enum ArchiveFileSource ArchiveFileSource |
The possible sources of an archive file.
At present only AFS_EDGE is supported.
| typedef enum GOPDataBlockType GOPDataBlockType |
Contains the type of GOPDataBlock.
This describes the type of data within the GOPDataBlock.
The Video and Audio configuration are the SDP (Session Description Protocol) block describing the Video or Audio data block. The SDP block is as received from the edge IP camera.
| typedef enum TimelineEntryFlags TimelineEntryFlags |
This contains values representing the type of timeline entry.
- See also
- Timeline
Enumeration Type Documentation
| enum ArchiveFileSource |
| enum GOPDataBlockType |
Contains the type of GOPDataBlock.
This describes the type of data within the GOPDataBlock.
The Video and Audio configuration are the SDP (Session Description Protocol) block describing the Video or Audio data block. The SDP block is as received from the edge IP camera.
| enum TimelineEntryFlags |
| enum ArchivePlaybackSpeed |
Header file for the ArchivePlaybackSpeed enumeration.
This contains values representing playback speeds for use with The ArchiveService.
Availability
Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0
| Enumerator | |
|---|---|
| REW |
Rewind. |
| PAUSE |
Pause. |
| NORMAL |
Normal playback speed. |
| FFWD |
Fast Forward. |
| STOP |
Stop (live video) |