Detailed Description
The GOP Data class represents a downloaded element from the edge archive of a supported encoder.
Once avilable, the GOP data can be interrogated to walk through the GOP to extract each GOPDataBlock element of the data in sequence. The extracted GOP data blocks may then be consumed by the calling application.
Availability
Available in version 6.1 of Decoder SDK. Requires a server version greater than 6.6
#include <GOPData.h>
Public Member Functions | |
| DB_EDGEVIS_SDK bool | HasNextDataBlock () |
| Determine if there is another block available when reading forward from the current position. | |
| DB_EDGEVIS_SDK GOPDataBlock | GetNextDataBlock () |
| Retrieve the next block available when reading forward from the current position. More... | |
| DB_EDGEVIS_SDK void | ResetRead () |
| Reset the position for the next block to be read from to the start of the first available block. | |
| DB_EDGEVIS_SDK int32_t | GetLength () |
| Get the length of the GOP data. More... | |
| DB_EDGEVIS_SDK int32_t | GetTransferID () |
| Get the GOP transfer ID. More... | |
| DB_EDGEVIS_SDK int32_t | GetInput () |
| Get the video input index that this GOP belongs to. More... | |
| DB_EDGEVIS_SDK int64_t | GetStartTime () |
| Get the start UTC timestamp for the GOP data. More... | |
| DB_EDGEVIS_SDK int64_t | GetEndTime () |
| Get the end UTC timestamp for the GOP data. More... | |
 Public Member Functions inherited from EdgeVisDecoderSDK::StreamData | |
| DB_EDGEVIS_SDK std::wstring | TypeName () const |
| Returns the type a StreamData this it. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK GOPDataBlock EdgeVisDecoderSDK::GOPData::GetNextDataBlock | ( | ) |
Retrieve the next block available when reading forward from the current position.
Reading a block will advance the read position for the next block to be read from.
- Returns
- GOPDataBlock The next data block available. If the last data block has already been read then the GOPDataBlock returned will not be valid i.e. IsValid will return false.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::GOPData::GetLength | ( | ) |
Get the length of the GOP data.
- Returns
- The length in bytes
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::GOPData::GetTransferID | ( | ) |
Get the GOP transfer ID.
- Returns
- The GOP transfer ID
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::GOPData::GetInput | ( | ) |
Get the video input index that this GOP belongs to.
- Returns
- The video input index
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::GOPData::GetStartTime | ( | ) |
Get the start UTC timestamp for the GOP data.
- Returns
- The start UTC timestamp in milliseconds
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::GOPData::GetEndTime | ( | ) |
Get the end UTC timestamp for the GOP data.
- Returns
- The end UTC timestamp in milliseconds
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/GOPData.h