com.openinventor.remoteviz.rendering

Class EncodedFrame

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.EncodedFrame

public class EncodedFrame
extends Inventor

This class provides the features of an encoded frame that is sent to the client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncodedFrame.EncodingFormats Encoding format.

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	H264 Deprecated. Use EncodedFrame.EncodingFormats.H264 instead.
static int	JPEG Deprecated. Use EncodedFrame.EncodingFormats.JPEG instead.
static int	PNG Deprecated. Use EncodedFrame.EncodingFormats.PNG instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
long	getBufferSize() Gets the frame buffer size in bytes.
EncodedFrame.EncodingFormats	getEncodingFormat() Gets the frame encoding format.
long	getId() Gets the frame id.
boolean	isInteractive() Returns if an user interaction is in progress when the frame has been encoded.
boolean	isLossless() Returns if the frame is lossless.

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

Field Detail

JPEG

@Deprecated
public static final int JPEG

Deprecated. Use EncodedFrame.EncodingFormats.JPEG instead.

PNG

@Deprecated
public static final int PNG

Deprecated. Use EncodedFrame.EncodingFormats.PNG instead.

H264

@Deprecated
public static final int H264

Deprecated. Use EncodedFrame.EncodingFormats.H264 instead.

Method Detail

getBufferSize

public long getBufferSize()

Gets the frame buffer size in bytes.

Returns:

the buffer size of the encoded frame.

isLossless

public boolean isLossless()

Returns if the frame is lossless.

Returns:

true if the frame is lossless

isInteractive

public boolean isInteractive()

Returns if an user interaction is in progress when the frame has been encoded. If the frame is interactive, the frame has been encoded with the interactive frame encoder and a quality adapted to the network bandwidth.
Otherwise (the frame is still), the frame has been encoded with the still frame encoder and the best available quality.

Returns:

true if the frame is interactive

getId

public long getId()

Gets the frame id.

Returns:

the frame id of the encoded frame.

getEncodingFormat

public EncodedFrame.EncodingFormats getEncodingFormat()

Gets the frame encoding format.

Returns:

the encoding format of the encoded frame.