Detailed Description
The VideoData class extends the StreamData class and is a base class for all types of video data provided by the MediaStream.
Availability
Available in version 7.2 of Decoder SDK. Requires a server version greater than 6.0
#include <VideoData.h>
Public Member Functions | |
| 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::VideoData::GetWidth | ( | ) | const |
Return the width of the image.
- Returns
- The image width in pixels
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoData::GetHeight | ( | ) | const |
Return the height of the image.
- Returns
- The image height in pixels
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::VideoData::GetEncodeTimeStamp | ( | ) | const |
Return the timestamp of the image.
This is the time as encoded at the encoder.
This is in milliseconds since the epoch
- Returns
- The encode time stamp
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::VideoData::GetDisplayTimeStamp | ( | ) | const |
Return the timestamp of the image.
The context of the time stamp can be determined by using the GetTimeStampContext.
This is in milliseconds since the epoch
- See also
- GetTimeStampContext
- Returns
- The image time stamp
| DB_EDGEVIS_SDK StreamTimestampContext EdgeVisDecoderSDK::VideoData::GetTimeStampContext | ( | ) | const |
Return context of the image timestamp.
This will determine if the image is a live frame or a frame that is being played from the archive
- Returns
- The time stamp context
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::VideoData::GetViewerTimeoutTimeStamp | ( | ) | const |
Return the timestamp at which the stream will timeout.
This is in milliseconds since the epoch
- Returns
- The timestamp at which the stream will timeout
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoData::GetInput | ( | ) | const |
Returns what video input this image is coming from.
Each encoder can have multiple inputs.
- Returns
- Input number. This is a 0 based.
| DB_EDGEVIS_SDK EdgeVisSDKCore::AspectRatio EdgeVisDecoderSDK::VideoData::GetAspectRatio | ( | ) | const |
Returns the aspect ratio of this image.
- Returns
- The aspect ratio
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::VideoData::IsCached | ( | ) | const |
This flag determines if the image has been cached at the remote encoder end for the Full Resolution.
- Returns
- True if the image has been cached
| DB_EDGEVIS_SDK ArchivePlaybackSpeed EdgeVisDecoderSDK::VideoData::GetArchivePlaybackSpeed | ( | ) | const |
Get the playback speed of the stream.
- Returns
- The playback speed for the stream. A value of ArchivePlaybackSpeed::STOP indicates live video, all other values are received during archive playback.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoData::GetArchivePlaybackSpeedMultiplier | ( | ) | const |
Get the playback speed multiplier of the stream.
- Returns
- The playback speed multiplier for the stream. Used to indicate x2, x4 and x8 FFWD and REW operations. All other playback scenarios will return a value of 1.
| DB_EDGEVIS_SDK VideoFrameLayout EdgeVisDecoderSDK::VideoData::GetVideoFrameLayout | ( | ) | const |
Returns the VideoFrameLayout describing the sources used to construct the received YCbCrFrame for the specified input.
- Returns
- A VideoFrameLayout object describing the composition of this frame. If the encoder does not support this the returned object will have a type of VideoFrameLayout_Unknown.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/VideoData.h