Detailed Description
VideoFrameLayout decribes the content of the frame from a given Encoder input.
If the input is a virtual input (such as a quad or a picture-in-picture) then the components of the frame may be deduced from the VideFrameLayout for that input.
Not all encoders are capable of reporting this information. If an encoder is not capable the value returned by GetLayoutType() will always be VideoFrameType_Unknown.
Availability
Available in version 7.1 of Decoder SDK. Requires a server version greater than 6.0
#include <VideoFrameLayout.h>
Public Member Functions | |
| DB_EDGEVIS_SDK VideoFrameLayoutType | GetLayoutType () const |
| Returns the type of this video frame layout. More... | |
| DB_EDGEVIS_SDK std::vector< VideoFrameLayoutComponent > | GetLayoutContent () const |
| Returns the description of the frame layout including the inputs used to construct the frame and the relative sizes and positions of each input within the frame. More... | |
| DB_EDGEVIS_SDK bool | ContainsInput (const int32_t input) const |
| Determine if the frame layout contains the specified input as a component of the frame. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK VideoFrameLayoutType EdgeVisDecoderSDK::VideoFrameLayout::GetLayoutType | ( | ) | const |
Returns the type of this video frame layout.
- Returns
- A VideoFrameLayoutType if it can be deduced for the encoder, VideoFrameLayout_Unknown if it cannot be determined.
| DB_EDGEVIS_SDK std::vector<VideoFrameLayoutComponent> EdgeVisDecoderSDK::VideoFrameLayout::GetLayoutContent | ( | ) | const |
Returns the description of the frame layout including the inputs used to construct the frame and the relative sizes and positions of each input within the frame.
- Returns
- A list of VideoFrameLayoutComponent objects describing the contents of the video frame.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::VideoFrameLayout::ContainsInput | ( | const int32_t | input | ) | const |
Determine if the frame layout contains the specified input as a component of the frame.
- Returns
- True if the frame layout contains the specified input, false otherwise.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/VideoFrameLayout.h