Detailed Description
This is the base class for the FrameConfig objects.
Availability
Available in version 7.2 of Decoder SDK. Requires a server version greater than 6.0
#include <FrameConfig.h>
Public Member Functions | |
| virtual DB_EDGEVIS_SDK std::wstring | FrameType () const |
| Returns the type of FrameConfig this is. More... | |
| DB_EDGEVIS_SDK int32_t | GetFrameHeight () const |
| Returns the desired height of video frames. More... | |
| DB_EDGEVIS_SDK void | SetFrameHeight (int32_t height) |
| Sets the desired height of video frames. More... | |
| DB_EDGEVIS_SDK int32_t | GetMaxFPS () const |
| Returns the desired maximum number of video frames per second. More... | |
| DB_EDGEVIS_SDK void | SetMaxFPS (int32_t max_fps) |
| Sets the desired maximum number of video frames per second. More... | |
| DB_EDGEVIS_SDK int32_t | GetFrameWidth () const |
| Returns the desired width of video frames. More... | |
| DB_EDGEVIS_SDK void | SetFrameWidth (int32_t width) |
| Sets the desired width of video frames. More... | |
| DB_EDGEVIS_SDK bool | HasOverlayTimeStamp () const |
| Returns if the frame should have its timestamp drawn on top. More... | |
| DB_EDGEVIS_SDK void | SetHasOverlayTimeStamp (bool enableOverlay, bool use_ms) |
| Sets if the frame should have its timestamp drawn on top. More... | |
| DB_EDGEVIS_SDK bool | HasOverlayTimeStampMS () const |
| Returns if the frame should have its timestamp drawn on top with milliseconds included. More... | |
| DB_EDGEVIS_SDK bool | HasOverlayEncoderName () const |
| Returns if the frame should have the name of the encoder it was captured from drawn on top. More... | |
| DB_EDGEVIS_SDK void | SetHasOverlayEncoderName (bool enableOverlay) |
| Sets if the frame should have the name of the encoder it was captured from drawn on top. More... | |
| DB_EDGEVIS_SDK bool | HasOverlayInputName () const |
| Returns if the frame should have the name of the encoder input it was captured from drawn on top If the input name cannot be retrieved then the input index will be drawn. More... | |
| DB_EDGEVIS_SDK void | SetHasOverlayInputName (bool enableOverlay) |
| Sets if the frame should have the name of the encoder input it was captured from drawn on top. More... | |
Member Function Documentation
|
virtual |
Returns the type of FrameConfig this is.
- Returns
- The type of FrameConfig
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::FrameConfig::GetFrameHeight | ( | ) | const |
Returns the desired height of video frames.
- Returns
- The desired height of the video frames provided by the MediaStream
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::FrameConfig::SetFrameHeight | ( | int32_t | height | ) |
Sets the desired height of video frames.
- Parameters
-
height The desired height of the video frames provided by the MediaStream. A value of 0 indicates that no vertical scaling will be performed and the decoded frame size will be used as is. The frame width shall be determined from the frame height and the aspect ratio. The height must be in the range 96 to 1080. Values outside this range will be restricted to these limits. Odd values will be rounded up to ensure that the output frame height is even.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::FrameConfig::GetMaxFPS | ( | ) | const |
Returns the desired maximum number of video frames per second.
The actual number of frames provided may be lower due to the rate that the frames are received from the EdgeVis Encoder.
- Returns
- The desired maximum frame rate of the video frames provided by the MediaStream
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::FrameConfig::SetMaxFPS | ( | int32_t | max_fps | ) |
Sets the desired maximum number of video frames per second.
The actual number of frames provided may be lower due to the rate that the frames are received from the EdgeVis Encoder.
- Parameters
-
max_fps The desired maximum frame rate of the video frames provided by the MediaStream. This value must be in the range 1 to 30. Values outside this range will be restricted to these limits.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::FrameConfig::GetFrameWidth | ( | ) | const |
Returns the desired width of video frames.
- Returns
- The desired width of the video frames provided by the MediaStream This value is ignored if the frame height is set to 0. A value of 0 indicates that no horizontal scaling will be performed if the height is 0, or scaled to preserve aspect ratio if the height is non-zero.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::FrameConfig::SetFrameWidth | ( | int32_t | width | ) |
Sets the desired width of video frames.
- Parameters
-
height The desired width of the video frames provided by the MediaStream. This value is ignored if the frame height is set to 0. Setting the frame width to 0 shall cause the frame width to be determined from the frame height and the aspect ratio . The width must be in the range 128 to 1920. Values outside this range will be restricted to these limits. Odd values will be rounded up to ensure that the output frame width is even.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::FrameConfig::HasOverlayTimeStamp | ( | ) | const |
Returns if the frame should have its timestamp drawn on top.
- Returns
- True if the frame should have its timestamp drawn on top, false if not
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::FrameConfig::SetHasOverlayTimeStamp | ( | bool | enableOverlay, |
| bool | use_ms | ||
| ) |
Sets if the frame should have its timestamp drawn on top.
- Parameters
-
enableOverlay Set true if the frame should have its timestamp drawn on top, false if not. use_ms Set true if timestamp should include milliseconds, false if not.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::FrameConfig::HasOverlayTimeStampMS | ( | ) | const |
Returns if the frame should have its timestamp drawn on top with milliseconds included.
- Returns
- True if the frame should have its timestamp with milliseconds drawn on top, false if not
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::FrameConfig::HasOverlayEncoderName | ( | ) | const |
Returns if the frame should have the name of the encoder it was captured from drawn on top.
If the encoder name cannot be retrieved then "Encoder: Unknown" will be drawn.
- Returns
- True if the frame should have the name of the encoder it was captured from drawn on top, false if not
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::FrameConfig::SetHasOverlayEncoderName | ( | bool | enableOverlay | ) |
Sets if the frame should have the name of the encoder it was captured from drawn on top.
- Parameters
-
enableOverlay Set true if the frame should have the name of the encoder it was captured from drawn on top, false if not.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::FrameConfig::HasOverlayInputName | ( | ) | const |
Returns if the frame should have the name of the encoder input it was captured from drawn on top If the input name cannot be retrieved then the input index will be drawn.
- Returns
- True if the frame should have the name of the encoder input it was captured from drawn on top, false if not
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::FrameConfig::SetHasOverlayInputName | ( | bool | enableOverlay | ) |
Sets if the frame should have the name of the encoder input it was captured from drawn on top.
- Parameters
-
enableOverlay Set true if the frame should have the name of the encoder input it was captured from drawn on top, false if not.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/FrameConfig.h