RemoteViz::Rendering::KeepFramesPerSecondPolicy Class Reference

RemoteViz More...

#include <RemoteViz/Rendering/KeepFramesPerSecondPolicy.h>

Inheritance diagram for RemoteViz::Rendering::KeepFramesPerSecondPolicy:

List of all members.

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:

See ConnectionSettings::setFrameEncodingPolicy to define the frame encoding policy.



Constructor & Destructor Documentation

RemoteViz::Rendering::KeepFramesPerSecondPolicy::KeepFramesPerSecondPolicy (  ) 


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.

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]


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].

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].

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.

connection : connection used to get values.

Implements RemoteViz::Rendering::IFrameEncodingPolicy.

The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 12 Sep 2022
Copyright © Thermo Fisher Scientific All rights reserved.