Class ConnectionSettings
- java.lang.Object
-
- com.openinventor.inventor.Inventor
-
- com.openinventor.remoteviz.rendering.ConnectionSettings
-
public class ConnectionSettings extends Inventor
Settings that define aConnection
. The application can query this object from aConnection
object. TheConnection
object can obtained in, e.g.,RenderAreaListener.onInitializedConnection()
.
-
-
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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FrameEncoders
getFrameEncoders()
Gets the frame encoders used by the connection.int
getKeepAliveTimeOut()
Gets the keepalive timeout (ms).int
getMaxFPS()
Deprecated.As of Open Inventor 9900.boolean
isSupportedEncoders(FrameEncoders frameEncoders)
Returns if encoders are supported by the host.void
setFrameEncodingPolicy(IFrameEncodingPolicy policy)
Sets the frame encoding policy used by theConnection
.void
setKeepAliveTimeOut(int value)
Sets the keepalive timeout (ms).void
setMaxFPS(int value)
Deprecated.As of Open Inventor 9900.-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Method Detail
-
getMaxFPS
@Deprecated public int getMaxFPS()
Deprecated.As of Open Inventor 9900. Please use new method IFrameEncodingPolicy.getFPS() instead.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.
Warning 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. Please use new method setFrameEncodingPolicy instead.Sets the frame encoding policy toKeepFrameQualityPolicy
(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.Warning Deprecated since Open Inventor 9900. Please use new method setFrameEncodingPolicy instead.
-
getFrameEncoders
public FrameEncoders getFrameEncoders()
Gets the frame encoders used by the connection.
This value is defined inRenderAreaListener.onOpenedConnection
.- Returns:
- the frame encoders.
-
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 with the disconnection message NETWORKFAILURE. Default value is 90000.- Returns:
- the keepalive timeout delay (ms).
-
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
-
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 with the disconnection message NETWORKFAILURE. Default value is 90000.- Parameters:
value
- : the keepalive timeout delay (ms).
-
setFrameEncodingPolicy
public void setFrameEncodingPolicy(IFrameEncodingPolicy policy)
Sets the frame encoding policy used by theConnection
. A policy is used to calculate two values: FPS (frames per second) and interactive frame encoding quality. There are two predefined policies:KeepFramesPerSecondPolicy
andKeepFrameQualityPolicy
. The default value isKeepFrameQualityPolicy
with default parameters. (Replaces the old setMaxFPS method.)- Parameters:
policy
- : a frame encoding policy object.
-
-