EncodedFrame

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.remoteviz.rendering.EncodedFrame

All Implemented Interfaces:

java.lang.Cloneable
```
public class EncodedFrame
extends Inventor
implements java.lang.Cloneable
```
This class provides the features of an encoded frame that is sent to the client.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EncodedFrame.EncodingFormats
Encoding format.
- 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

Constructor Summary

Constructors
Constructor Description

EncodedFrame()
Constructor.

EncodedFrame(EncodedFrame obj)
Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`clone()`
`long`	`getBufferSize()`	Gets the frame buffer size in bytes.
`EncodedFrame.EncodingFormats`	`getEncodingFormat()`	Gets the frame encoding format.
`long`	`getId()`	Gets the frame id.
`java.lang.String`	`getMessage()`	Gets the frame message.
`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, getNativeResourceHandle

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EncodedFrame
```
public EncodedFrame(EncodedFrame obj)
```
    Copy constructor.
  - EncodedFrame
```
public EncodedFrame()
```
    Constructor.
- Method Detail
  - clone
```
public java.lang.Object clone()
```
  - 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
  - getEncodingFormat
```
public EncodedFrame.EncodingFormats getEncodingFormat()
```
    Gets the frame encoding format.
    
    Returns:
    
    the encoding format of the encoded frame.
  - getMessage
```
public java.lang.String getMessage()
```
    Gets the frame message.
    
    Returns:
    
    the message joint with the encoded frame.
  - getId
```
public long getId()
```
    Gets the frame id.
    
    Returns:
    
    the frame id of the encoded frame.
  - 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