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
FrameEncoders getFrameEncoders () const
bool isSupportedEncoders (FrameEncoders *frameEncoders) const
void setFrameEncodingPolicy (IFrameEncodingPolicy *policy)
IFrameEncodingPolicygetFrameEncodingPolicy () const

Detailed Description

RemoteViz

Settings that define a Connection


Member Function Documentation

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.
IFrameEncodingPolicy* RemoteViz::Rendering::ConnectionSettings::getFrameEncodingPolicy (  )  const

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

Returns:
the encoding policy used by the Connection.
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. Default value is 20000.

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 ( FrameEncoders frameEncoders  )  const

Returns if encoders are supported by the host.


Parameters:
frameEncoders : frame encoder
Returns:
true if supported, if not, the status of encoders explain the reason
void RemoteViz::Rendering::ConnectionSettings::setFrameEncodingPolicy ( 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. (Replaces the old setMaxFPS method.)

Parameters:
policy : a pointer to a frame encoding policy. This method takes the ownership of the pointed object and will be responsible for its deletion.
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. Default value is 20000. The range is [0..inf[. If the value is out of range, it will be set to the value of the nearest endpoint of the interval.

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 11 Nov 2019
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/