com.openinventor.remoteviz.rendering

Class ConnectionSettings

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.ConnectionSettings

public class ConnectionSettings
extends Inventor

Settings that define a Connection.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
FrameEncoders	getFrameEncoders() Gets the frame encoders used by the connection.
IFrameEncodingPolicy	getFrameEncodingPolicy() Gets the frame encoding policy used by the Connection.
int	getKeepAliveTimeOut() Gets the keepalive timeout (ms).
int	getMaxFPS() Deprecated. As of Open Inventor 9900 See documentation for more details
boolean	isSupportedEncoders(FrameEncoders frameEncoders) Returns if encoders are supported by the host.
void	setFrameEncodingPolicy(IFrameEncodingPolicy policy) Sets the frame encoding policy used by the Connection.
void	setKeepAliveTimeOut(int value) Sets the keepalive timeout (ms).
void	setMaxFPS(int value) Deprecated. As of Open Inventor 9900 See documentation for more details

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setKeepAliveTimeOut

public void setKeepAliveTimeOut(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).

getMaxFPS

@Deprecated
public int getMaxFPS()

Deprecated. As of Open Inventor 9900 See documentation for more details

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 since Open Inventor 9900
Please use new method IFrameEncodingPolicy.getFPS() instead.

setMaxFPS

@Deprecated
public void setMaxFPS(int value)

Deprecated. As of Open Inventor 9900 See documentation for more details

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 since Open Inventor 9900
Please use new method setFrameEncodingPolicy instead.

getKeepAliveTimeOut

public int getKeepAliveTimeOut()

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

setFrameEncodingPolicy

public void 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 frame encoding policy object. This method takes the ownership of the pointed object and will be responsible for its deletion.

isSupportedEncoders

public boolean isSupportedEncoders(FrameEncoders frameEncoders)

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

getFrameEncodingPolicy

public IFrameEncodingPolicy getFrameEncodingPolicy()

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.

getFrameEncoders

public FrameEncoders getFrameEncoders()

Gets the frame encoders used by the connection.
This value is defined in RenderAreaListener.onOpenedConnection.

Returns:

the frame encoders.