Public Member Functions | List of all members
EdgeVisDecoderSDK::ArchiveFile Class Reference
Remote Archive Access

Detailed Description

A simple container class for information about a file on a remote archive device connected to an Encoder.

This information includes:

  • The file name
  • The file size in bytes
  • The file duration in seconds

Availability

Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0

#include <ArchiveFile.h>

Public Member Functions

DB_EDGEVIS_SDK std::wstring Name () const
 Gets the file name of the archive file. More...
 
DB_EDGEVIS_SDK int32_t Duration () const
 Gets the duration name of the archive file. More...
 
DB_EDGEVIS_SDK int64_t Size () const
 Gets the size of the archive file in bytes. More...
 
DB_EDGEVIS_SDK ArchiveFileSource Source () const
 Gets the source of the archive file. More...
 
DB_EDGEVIS_SDK std::wstring Metadata () const
 Gets any metadata associated with this archive file. More...
 

Member Function Documentation

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ArchiveFile::Name ( ) const

Gets the file name of the archive file.

Returns
The archive file name
DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::ArchiveFile::Duration ( ) const

Gets the duration name of the archive file.

Returns
The archive file duration
DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::ArchiveFile::Size ( ) const

Gets the size of the archive file in bytes.

Returns
The archive file size in bytes.
DB_EDGEVIS_SDK ArchiveFileSource EdgeVisDecoderSDK::ArchiveFile::Source ( ) const

Gets the source of the archive file.

Returns
The source of the archive file. Only AFS_EDGE is supported at this time.
DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ArchiveFile::Metadata ( ) const

Gets any metadata associated with this archive file.

Returns
Json formatted metadata extracted from the archive DB.
The documentation for this class was generated from the following file: