ClientSettings Class

Settings that define a OIV.RemoteViz.Rendering.Client.

Inheritance Hierarchy

SystemObject
OIV.InventorSoNetBase
OIV.RemoteViz.RenderingClientSettings

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 2024.1.0.0 (2024.1.0)

Syntax

C++

Copy

public sealed class ClientSettings : SoNetBase

Public NotInheritable Class ClientSettings
	Inherits SoNetBase

public ref class ClientSettings sealed : public SoNetBase

[<SealedAttribute>]
type ClientSettings =  
    class
        inherit SoNetBase
    end

The ClientSettings type exposes the following members.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Bandwidth	Sets the network bandwidth to be used by the client.

Top

Remarks

The application can query this object from a OIV.RemoteViz.Rendering.Client object. A OIV.RemoteViz.Rendering.Client object is passed to various listener methods such as OIV.RemoteViz.Rendering.ServiceListener.OnConnectedClient(System.String, OIV.RemoteViz.Rendering.NetworkPerformance) and OIV.RemoteViz.Rendering.ServiceListener.OnInitializedClient(OIV.RemoteViz.Rendering.Client, OIV.RemoteViz.Rendering.NetworkPerformance). Clients can also be queried using OIV.RemoteViz.Rendering.Service.GetClient(System.String).

OIV.RemoteViz.Rendering.ClientSettings is used to set the network bandwidth to be used by the OIV.RemoteViz.Rendering.Client. This value is not a hard limit, but higher values imply higher image quality and higher frames per second. The policy can be set for each connection (see OIV.RemoteViz.Rendering.ConnectionSettings.SetFrameEncodingPolicy(OIV.RemoteViz.Rendering.IFrameEncodingPolicy)). If a client has multiple connections, the bandwidth value for each connection is the client value divided by the number of connections.

If network calibration is enabled (true by default, see OIV.RemoteViz.Rendering.NetworkPerformance), when a client connects to the service, RemoteViz will measure the available network bandwidth. The default implementation of OIV.RemoteViz.Rendering.ServiceListener.OnInitializedClient(OIV.RemoteViz.Rendering.Client, OIV.RemoteViz.Rendering.NetworkPerformance) will query this value (()) and call (). If the application already knows the available network bandwidth, it is not necessary to enable calibration, simply call ().

To measure available network bandwidth, RemoteViz has to cause network congestion, which implies that the user is blocked for a period of time. Therefore RemoteViz only measures network bandwidth once, when the client first connects (and only if calibration is enabled). Of course network bandwidth can change at any time. If the application has new information about the available network bandwidth, () can be called at any time.

The application can query this object from a OIV.RemoteViz.Rendering.Client object. The OIV.RemoteViz.Rendering.Client object can obtained in, e.g., OIV.RemoteViz.Rendering.ServiceListener.OnPendingCreateRenderArea(System.String, System.UInt32@, System.UInt32@, OIV.RemoteViz.Rendering.RenderAreaHardware, OIV.RemoteViz.Rendering.Client, OIV.RemoteViz.Rendering.ConnectionParameters).

Reference

OIV.RemoteViz.Rendering Namespace