RemoteViz::Rendering::KeepFramesPerSecondPolicy Class Reference

More...

#include <RemoteViz/Rendering/KeepFramesPerSecondPolicy.h>

Inheritance diagram for RemoteViz::Rendering::KeepFramesPerSecondPolicy:

Public Member Functions
	KeepFramesPerSecondPolicy ()
	Constructor.
	KeepFramesPerSecondPolicy (unsigned int fpsTarget, float qualityTarget, float qualityThreshold)
	Convenience Constructor.
virtual	~KeepFramesPerSecondPolicy ()
	Destructor.
virtual unsigned int	getFramesPerSecond () const override
	Gets the FPS calculated after calling the method update().
virtual float	getFrameQuality () const override
	Gets the interactive frame quality calculated after calling the method update().
virtual void	update (std::shared_ptr< Connection > connection) override
	Update value of the FPS and frame quality.
Public Member Functions inherited from RemoteViz::Rendering::IFrameEncodingPolicy
virtual	~IFrameEncodingPolicy ()
	Destructor.

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

KeepFrameQualityPolicy

Definition at line 60 of file KeepFramesPerSecondPolicy.h.

Constructor & Destructor Documentation

KeepFramesPerSecondPolicy() [1/2]

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.

KeepFramesPerSecondPolicy() [2/2]

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)

~KeepFramesPerSecondPolicy()

virtual RemoteViz::Rendering::KeepFramesPerSecondPolicy::~KeepFramesPerSecondPolicy ( )

virtual

Destructor.

Member Function Documentation

getFrameQuality()

virtual float RemoteViz::Rendering::KeepFramesPerSecondPolicy::getFrameQuality ( ) const

overridevirtual

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.

getFramesPerSecond()

virtual unsigned int RemoteViz::Rendering::KeepFramesPerSecondPolicy::getFramesPerSecond ( ) const

overridevirtual

Gets the FPS calculated after calling the method update().

The value range is [1, 60].

Returns

the FPS.

Implements RemoteViz::Rendering::IFrameEncodingPolicy.

update()

virtual void RemoteViz::Rendering::KeepFramesPerSecondPolicy::update ( std::shared_ptr< Connection >  connection )

overridevirtual

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