RemoteViz::Rendering::ConnectionSettings Class Reference
[RemoteViz]

RemoteViz More...

#include <RemoteViz/Rendering/ConnectionSettings.h>

List of all members.

Deprecated



SoDEPRECATED void setMaxFPS (unsigned int value)
SoDEPRECATED unsigned int getMaxFPS () const



void setKeepAliveTimeOut (unsigned int value)
unsigned int getKeepAliveTimeOut () const
std::shared_ptr< const
FrameEncoders
getFrameEncoders () const
bool isSupportedEncoders (std::shared_ptr< const FrameEncoders > frameEncoders) const
void setFrameEncodingPolicy (std::shared_ptr< IFrameEncodingPolicy > policy)

Detailed Description

RemoteViz

Settings that define a Connection.

The application can query this object from a Connection object. The Connection object can obtained in, e.g., RenderAreaListener::onInitializedConnection().


Member Function Documentation

std::shared_ptr<const FrameEncoders> RemoteViz::Rendering::ConnectionSettings::getFrameEncoders (  )  const

Gets the frame encoders used by the connection.


This value is defined in RenderAreaListener::onOpenedConnection.

Returns:
the frame encoders.
unsigned int RemoteViz::Rendering::ConnectionSettings::getKeepAliveTimeOut (  )  const

Gets the keepalive timeout (ms).

A keepalive is sent by the client every 5 seconds to check that the link between the two is operating, or to prevent this link from being broken. Without a keepalive signal, the service will drop the connection after timeout with the disconnection message NETWORKFAILURE. Default value is 90000.

Returns:
the keepalive timeout delay (ms).
SoDEPRECATED unsigned int RemoteViz::Rendering::ConnectionSettings::getMaxFPS (  )  const

Gets the maximum number of frames per second sent to the client.

This value is from encodingPolicy.getFramePerSecond();
The value range is [1..60].

Returns:
the number of frames per second.
Deprecated:

Deprecated since Open Inventor 9900
Please use new method IFrameEncodingPolicy::getFPS() instead.
bool RemoteViz::Rendering::ConnectionSettings::isSupportedEncoders ( std::shared_ptr< const FrameEncoders frameEncoders  )  const

Returns if encoders are supported by the host.


Parameters:
frameEncoders : frame encoders
Returns:
true if supported, if not, the status of encoders explain the reason
void RemoteViz::Rendering::ConnectionSettings::setFrameEncodingPolicy ( std::shared_ptr< IFrameEncodingPolicy policy  ) 

Sets the frame encoding policy used by the Connection.

A policy is used to calculate two values: FPS (frames per second) and interactive frame encoding quality. There are two predefined policies: KeepFramesPerSecondPolicy and KeepFrameQualityPolicy. The default value is KeepFrameQualityPolicy with default parameters. (Replaces the old setMaxFPS method.)

Parameters:
policy : a frame encoding policy object.
void RemoteViz::Rendering::ConnectionSettings::setKeepAliveTimeOut ( unsigned int  value  ) 

Sets the keepalive timeout (ms).

A keepalive is sent by the client every 5 seconds to check that the link between the two is operating, or to prevent this link from being broken. Without a keepalive signal, the service will drop the connection after timeout with the disconnection message NETWORKFAILURE. Default value is 90000.

Parameters:
value : the keepalive timeout delay (ms).
SoDEPRECATED void RemoteViz::Rendering::ConnectionSettings::setMaxFPS ( unsigned int  value  ) 

Sets the frame encoding policy to KeepFrameQualityPolicy (see setFrameEncodingPolicy) and the FPS target value.

The frame quality target is set to the default value (0.7).
The FPS threshold is set to the default value (15).

The value range is [1..60].

Parameters:
value : FPS target.
Deprecated:

Deprecated since Open Inventor 9900
Please use new method setFrameEncodingPolicy instead.

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.
http://www.openinventor.com/