RemoteViz::Rendering::KeepFramesPerSecondPolicy Class Reference
[RemoteViz]
#include <RemoteViz/Rendering/KeepFramesPerSecondPolicy.h>
Public Member Functions | |
| KeepFramesPerSecondPolicy () | |
| KeepFramesPerSecondPolicy (unsigned int fpsTarget, float qualityTarget, float qualityThreshold) | |
| virtual | ~KeepFramesPerSecondPolicy () |
| virtual unsigned int | getFramesPerSecond () const override |
| virtual float | getFrameQuality () const override |
| virtual void | update (std::shared_ptr< Connection > connection) override |
Detailed Description
This class provides a calculation policy which allows to manage the FPS (frames per second) and the quality of interactive frames sent from Remoteviz service depending on the network bandwidth allocated to the Connection.
If the Client owns multiple connections, the network bandwidth allocated to each Connection will be equitably shared. Otherwise, the network bandwidth allocated to the Connection will be equal to the network bandwidth allocated to the Client. The network bandwidth allocated to the Client can be defined from ClientSettings::setBandwidth. This policy works as described below:
- When the network bandwidth allocated to the Connection decreases, the FPS value will keep the FPS target value and the frame quality will decrease.
- If the frame quality decreases until the frame quality threshold, then the FPS will start to decrease.
- When the network bandwidth allocated to the Connection increases, the FPS will increase until it reaches the FPS target and then the frame quality will increase until it reaches the frame quality target.
See ConnectionSettings::setFrameEncodingPolicy to define the frame encoding policy.
SEE ALSO
Constructor & Destructor Documentation
| RemoteViz::Rendering::KeepFramesPerSecondPolicy::KeepFramesPerSecondPolicy | ( | ) |
Constructor.
The FPS target will be set to 30.
The frame quality target will be set to 0.7.
The frame quality threshold will be set to 0.3.
| RemoteViz::Rendering::KeepFramesPerSecondPolicy::KeepFramesPerSecondPolicy | ( | unsigned int | fpsTarget, | |
| float | qualityTarget, | |||
| float | qualityThreshold | |||
| ) |
Convenience Constructor.
- Parameters:
-
fpsTarget : FPS target, the value range is [1, 60]. qualityTarget : frame quality target, the value range is [0, 1]. qualityThreshold : frame quality threshold, the value range is [0, 1]. (qualityThreshold <= qualityTarget)
| virtual RemoteViz::Rendering::KeepFramesPerSecondPolicy::~KeepFramesPerSecondPolicy | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual float RemoteViz::Rendering::KeepFramesPerSecondPolicy::getFrameQuality | ( | ) | const [override, virtual] |
Gets the interactive frame quality calculated after calling the method update().
The value range is [0, 1].
- Returns:
- the interactive frame quality.
Implements RemoteViz::Rendering::IFrameEncodingPolicy.
| virtual unsigned int RemoteViz::Rendering::KeepFramesPerSecondPolicy::getFramesPerSecond | ( | ) | const [override, virtual] |
Gets the FPS calculated after calling the method update().
The value range is [1, 60].
- Returns:
- the FPS.
Implements RemoteViz::Rendering::IFrameEncodingPolicy.
| virtual void RemoteViz::Rendering::KeepFramesPerSecondPolicy::update | ( | std::shared_ptr< Connection > | connection | ) | [override, virtual] |
Update value of the FPS and frame quality.
The connection will be used to get values such encode frame buffer size or bandwidth.
- Parameters:
-
connection : connection used to get values.
Implements RemoteViz::Rendering::IFrameEncodingPolicy.
The documentation for this class was generated from the following file:
- RemoteViz/Rendering/KeepFramesPerSecondPolicy.h