Class ConnectionSettings

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

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

      • 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. 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).
      • 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 with default parameters. (Replaces the old setMaxFPS method.)

        Parameters:
        policy - : a frame encoding policy object.