EdgeVisDecoderSDK::ArchiveBookmark Class Reference
Detailed Description
Contains the details of an Archive bookmark.
An Archive bookmark marks a point in time on the archive that the user has set. This allows them to access the bookmark at a later date.
- Note
- Bookmarks can become out of date as the archive is overwritten
Availability
Available in version 7.3.0 of Decoder SDK. Requires a server version greater than 6.0
#include <ArchiveBookmark.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int64_t | GetTimeStamp () const |
| The timestamp of the bookmark. More... | |
| DB_EDGEVIS_SDK int32_t | GetIndex () const |
| Index identifier of the bookmark. More... | |
| DB_EDGEVIS_SDK int32_t | GetInput () const |
| The input this bookmark is set against. More... | |
| DB_EDGEVIS_SDK std::wstring | GetName () const |
| The name of the bookmark. More... | |
| DB_EDGEVIS_SDK std::wstring | GetDescription () const |
| The description of the bookmark. More... | |
| DB_EDGEVIS_SDK int64_t | GetCreatedTimeStamp () const |
| The timestamp that the bookmark was created A value of 0 indicates that the creation time is not known. | |
Member Function Documentation
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::ArchiveBookmark::GetTimeStamp | ( | ) | const |
The timestamp of the bookmark.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::ArchiveBookmark::GetIndex | ( | ) | const |
Index identifier of the bookmark.
To uniquely identify a bookmark use the input and timestamp values.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::ArchiveBookmark::GetInput | ( | ) | const |
The input this bookmark is set against.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ArchiveBookmark::GetName | ( | ) | const |
The name of the bookmark.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ArchiveBookmark::GetDescription | ( | ) | const |
The description of the bookmark.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/ArchiveBookmark.h