Click or drag to resize
KeepFrameQualityPolicy Class

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 OIV.RemoteViz.Rendering.Connection.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.RemoteViz.RenderingIFrameEncodingPolicy
      OIV.RemoteViz.RenderingKeepFrameQualityPolicy

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 2024.1.1.0 (2024.1.1)
Syntax
public class KeepFrameQualityPolicy : IFrameEncodingPolicy

The KeepFrameQualityPolicy type exposes the following members.

Constructors
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetFrameQuality

Returns the frame quality value used to encode interactive frames.

(Inherited from IFrameEncodingPolicy.)
Public methodGetFramesPerSecond

Returns the FPS value used to send frames to the client periodically.

(Inherited from IFrameEncodingPolicy.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate

Update value of the FPS and frame quality.

(Inherited from IFrameEncodingPolicy.)
Top
Remarks

If the OIV.RemoteViz.Rendering.Client owns multiple connections, the network bandwidth allocated to each OIV.RemoteViz.Rendering.Connection will be equitably shared. Otherwise, the network bandwidth allocated to the OIV.RemoteViz.Rendering.Connection will be equal to the network bandwidth allocated to the OIV.RemoteViz.Rendering.Client. The network bandwidth allocated to the OIV.RemoteViz.Rendering.Client can be defined from (). This policy works as described below:

  • When the network bandwidth allocated to the OIV.RemoteViz.Rendering.Connection decreases, the frame quality value will keep the frame quality target value and the FPS will decrease.

  • If the FPS decreases until the FPS threshold, then the frame quality will start to decrease.

  • When the network bandwidth allocated to the OIV.RemoteViz.Rendering.Connection increases, the frame quality will increase until it reaches the frame quality target and then the FPS will increase until it reaches the FPS target.

See OIV.RemoteViz.Rendering.ConnectionSettings.SetFrameEncodingPolicy(OIV.RemoteViz.Rendering.IFrameEncodingPolicy) to define the frame encoding policy.

See Also