EdgeVisDecoderSDK::JPEGFrameConfig Class Reference
Detailed Description
This is the derived class for the JPEGFrameConfig objects.
Availability
Available in version 7.2 of Decoder SDK. Requires a server version greater than 6.0
#include <JPEGFrameConfig.h>
Public Member Functions | |
| DB_EDGEVIS_SDK | JPEGFrameConfig (int32_t height, int32_t max_fps, int32_t quality) |
| Instantiate a new JPEGFrameConfig object with the specified parameters. More... | |
| DB_EDGEVIS_SDK int32_t | GetQuality () const |
| Retrieve the JPEG compression quality being used when generating JPEGs. More... | |
| DB_EDGEVIS_SDK void | SetQuality (int32_t quality) |
| Set the JPEG compression quality to use when generating JPEGs. More... | |
 Public Member Functions inherited from EdgeVisDecoderSDK::FrameConfig | |
| 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... | |
Constructor & Destructor Documentation
| DB_EDGEVIS_SDK EdgeVisDecoderSDK::JPEGFrameConfig::JPEGFrameConfig | ( | int32_t | height, |
| int32_t | max_fps, | ||
| int32_t | quality | ||
| ) |
Instantiate a new JPEGFrameConfig object with the specified parameters.
Applying this config to the MediaStream::SetVideoFrameConfig() method shall result in the IStreamListener::DataReceived method receiving JPEG frame data.
- 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. 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. quality The JPEG compression quality to use. This value must be in the range 5 to 100. Values outside this range will be restricted to these limits.
Member Function Documentation
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::JPEGFrameConfig::GetQuality | ( | ) | const |
Retrieve the JPEG compression quality being used when generating JPEGs.
- Returns
- The JPEG compression quality being used.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::JPEGFrameConfig::SetQuality | ( | int32_t | quality | ) |
Set the JPEG compression quality to use when generating JPEGs.
Higher values will result in more data per frame. Lower values will result in less data per frame and faster compression times.
- Parameters
-
quality The JPEG compression quality to use. This value must be in the range 5 to 100. Values outside this range will be restricted to these limits.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/JPEGFrameConfig.h