EdgeVisDecoderSDK::SnapshotFrame Class Reference
Detailed Description
A SnapshotFrame is an extension of YCbCrFrame.
It additionally contains information about the progress of a full res snapshot. The progress percentage reflects the number of blocks received over the total to be sent.
Availability
Available in version 7.3 of Decoder SDK. Requires a server version greater than 7.3
#include <SnapshotFrame.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int32_t | GetProgress () const |
| Get the progress of the Snapshot as a percentage. More... | |
| DB_EDGEVIS_SDK std::vector< int32_t > | GetMissingBlocks () const |
 Public Member Functions inherited from EdgeVisDecoderSDK::YCbCrFrame | |
| DB_EDGEVIS_SDK bool | SetDimensions (int32_t width, int32_t height) |
| Set the size of the frame witihout scaling the content. More... | |
| DB_EDGEVIS_SDK bool | ReSize (int32_t width, int32_t height) |
| Set the size of the frame and scale the content. More... | |
| DB_EDGEVIS_SDK bool | ReSizeCopy (const YCbCrFrame &frame, int32_t width, int32_t height) |
| Resize a frame, then copy (and scale) from. More... | |
| DB_EDGEVIS_SDK void | Copy (const YCbCrFrame &frame) |
| Copy the content and properties from another frame to this one. More... | |
| void | CopyFramePropertiesOnly (const YCbCrFrame &frame) |
| Copy only the properties from another frame to this one. More... | |
| DB_EDGEVIS_SDK int64_t | GetTimeStamp () const |
| Return the timestamp of the image. More... | |
| DB_EDGEVIS_SDK byte_array | GetYPlane () const |
| Returns the byte array containing the Y plane. More... | |
| DB_EDGEVIS_SDK int32_t | GetYPlaneDataSize () const |
| Returns the size the Y plane. More... | |
| DB_EDGEVIS_SDK bool | GetYPlaneData (byte_array &data) const |
| Retrieve byte array containing the Y plane. More... | |
| DB_EDGEVIS_SDK byte_array | GetCbPlane () const |
| Returns the byte array containing the Cb plane. More... | |
| DB_EDGEVIS_SDK int32_t | GetCbPlaneDataSize () const |
| Returns the size the Cb plane. More... | |
| DB_EDGEVIS_SDK bool | GetCbPlaneData (byte_array &data) const |
| Retrieve byte array containing the Cb plane. More... | |
| DB_EDGEVIS_SDK byte_array | GetCrPlane () const |
| Returns the byte array containing the Cr plane. More... | |
| DB_EDGEVIS_SDK int32_t | GetCrPlaneDataSize () const |
| Returns the size the Cr plane. More... | |
| DB_EDGEVIS_SDK bool | GetCrPlaneData (byte_array &data) const |
| Retrieve byte array containing the Cr plane. More... | |
| DB_EDGEVIS_SDK void | CorrectAspectRatio () |
| Will correct the aspect ratio of the image. | |
| DB_EDGEVIS_SDK void | ResetToBlack () |
| Will reset the frame to black. | |
| DB_EDGEVIS_SDK void | ResetToGrey () |
| Will reset the planes to return a grey image. | |
| Public Member Functions inherited from EdgeVisDecoderSDK::VideoData | |
| DB_EDGEVIS_SDK int32_t | GetWidth () const |
| Return the width of the image. More... | |
| DB_EDGEVIS_SDK int32_t | GetHeight () const |
| Return the height of the image. More... | |
| DB_EDGEVIS_SDK int64_t | GetEncodeTimeStamp () const |
| Return the timestamp of the image. More... | |
| DB_EDGEVIS_SDK int64_t | GetDisplayTimeStamp () const |
| Return the timestamp of the image. More... | |
| DB_EDGEVIS_SDK StreamTimestampContext | GetTimeStampContext () const |
| Return context of the image timestamp. More... | |
| DB_EDGEVIS_SDK int64_t | GetViewerTimeoutTimeStamp () const |
| Return the timestamp at which the stream will timeout. More... | |
| DB_EDGEVIS_SDK int32_t | GetInput () const |
| Returns what video input this image is coming from. More... | |
| DB_EDGEVIS_SDK EdgeVisSDKCore::AspectRatio | GetAspectRatio () const |
| Returns the aspect ratio of this image. More... | |
| DB_EDGEVIS_SDK bool | IsCached () const |
| This flag determines if the image has been cached at the remote encoder end for the Full Resolution. More... | |
| DB_EDGEVIS_SDK ArchivePlaybackSpeed | GetArchivePlaybackSpeed () const |
| Get the playback speed of the stream. More... | |
| DB_EDGEVIS_SDK int32_t | GetArchivePlaybackSpeedMultiplier () const |
| Get the playback speed multiplier of the stream. More... | |
| DB_EDGEVIS_SDK VideoFrameLayout | GetVideoFrameLayout () const |
| Returns the VideoFrameLayout describing the sources used to construct the received YCbCrFrame for the specified input. 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 int32_t EdgeVisDecoderSDK::SnapshotFrame::GetProgress | ( | ) | const |
Get the progress of the Snapshot as a percentage.
- Returns
- The percentage progress of the snapshot
| DB_EDGEVIS_SDK std::vector<int32_t> EdgeVisDecoderSDK::SnapshotFrame::GetMissingBlocks | ( | ) | const |
- Returns
- The a vector of missing blocks
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/SnapshotFrame.h