Detailed Description
VideoFrameLayoutComponent decribes either all or part of a VideoFrameLayout.
This provides access to the source input along with the relative size and position within the received YCbCrFrame object.
For example, a phyiscal input will have a single VideoFrameLayoutComponent with a left offset percentage of 0, a top offset percentage of 0, a width percentage of 100 and a height percentage of 100 (i.e. full frame).
Virtual inputs may be more exotic, with different frame sizes from different sources combined in to a single YCbCrFrame. The composition of frames such as these may be determined using this class for encoders that support it.
Availability
Available in version 7.1 of Decoder SDK. Requires a server version greater than 6.0
#include <VideoFrameLayoutComponent.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int32_t | GetInput () const |
| Get the source input that provides the frames for this component. More... | |
| DB_EDGEVIS_SDK int32_t | GetLeftOffsetPercentage () const |
| Get the left position of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame width. More... | |
| DB_EDGEVIS_SDK int32_t | GetTopOffsetPercentage () const |
| Get the top position of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame height. More... | |
| DB_EDGEVIS_SDK int32_t | GetWidthPercentage () const |
| Get the width of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame width. More... | |
| DB_EDGEVIS_SDK int32_t | GetHeightPercentage () const |
| Get the height of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame height. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoFrameLayoutComponent::GetInput | ( | ) | const |
Get the source input that provides the frames for this component.
- Returns
- The physical input index that provides this frame component.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoFrameLayoutComponent::GetLeftOffsetPercentage | ( | ) | const |
Get the left position of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame width.
- Returns
- The left position of this component image within the received frame as a percentage of the frame width.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoFrameLayoutComponent::GetTopOffsetPercentage | ( | ) | const |
Get the top position of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame height.
- Returns
- The top position of this component image within the received frame as a percentage of the frame height.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoFrameLayoutComponent::GetWidthPercentage | ( | ) | const |
Get the width of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame width.
- Returns
- The width of this component image within the received frame as a percentage of the frame width.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::VideoFrameLayoutComponent::GetHeightPercentage | ( | ) | const |
Get the height of this component within the received YCbCrFrame as a percentage of the received YCbCrFrame height.
- Returns
- The height of this component image within the received frame as a percentage of the frame height.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/VideoFrameLayoutComponent.h