Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
RemoteViz::Rendering::EncodedFrame Class Reference

RemoteViz More...

#include <RemoteViz/Rendering/EncodedFrame.h>

Public Types

enum  EncodingFormat {
  JPEG ,
  PNG ,
  H264 ,
  VP9
}
 Encoding format. More...
 

Public Member Functions

 EncodedFrame ()
 Constructor.
 
 EncodedFrame (const EncodedFrame &obj)
 Copy constructor.
 
EncodedFrameoperator= (const EncodedFrame &obj)
 Copy assignment operator.
 
 ~EncodedFrame ()
 Destructor.
 
size_t getBufferSize () const
 Gets the frame buffer size in bytes.
 
EncodingFormat getEncodingFormat () const
 Gets the frame encoding format.
 
size_t getId () const
 Gets the frame id.
 
bool isLossless () const
 Returns if the frame is lossless.
 
bool isInteractive () const
 Returns if an user interaction is in progress when the frame has been encoded.
 
std::string getMessage () const
 Gets the frame message.
 

Detailed Description

RemoteViz

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

Definition at line 44 of file EncodedFrame.h.

Member Enumeration Documentation

◆ EncodingFormat

Encoding format.

Enumerator
JPEG 
PNG 
H264 
VP9 

Definition at line 56 of file EncodedFrame.h.

Constructor & Destructor Documentation

◆ EncodedFrame() [1/2]

RemoteViz::Rendering::EncodedFrame::EncodedFrame ( )

Constructor.

◆ EncodedFrame() [2/2]

RemoteViz::Rendering::EncodedFrame::EncodedFrame ( const EncodedFrame obj)

Copy constructor.

◆ ~EncodedFrame()

RemoteViz::Rendering::EncodedFrame::~EncodedFrame ( )

Destructor.

Member Function Documentation

◆ getBufferSize()

size_t RemoteViz::Rendering::EncodedFrame::getBufferSize ( ) const

Gets the frame buffer size in bytes.

Returns
the buffer size of the encoded frame.

◆ getEncodingFormat()

EncodingFormat RemoteViz::Rendering::EncodedFrame::getEncodingFormat ( ) const

Gets the frame encoding format.

Returns
the encoding format of the encoded frame.

◆ getId()

size_t RemoteViz::Rendering::EncodedFrame::getId ( ) const

Gets the frame id.

Returns
the frame id of the encoded frame.

◆ getMessage()

std::string RemoteViz::Rendering::EncodedFrame::getMessage ( ) const

Gets the frame message.

Returns
the message joint with the encoded frame.

◆ isInteractive()

bool RemoteViz::Rendering::EncodedFrame::isInteractive ( ) const

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

◆ isLossless()

bool RemoteViz::Rendering::EncodedFrame::isLossless ( ) const

Returns if the frame is lossless.

Returns
true if the frame is lossless

◆ operator=()

EncodedFrame & RemoteViz::Rendering::EncodedFrame::operator= ( const EncodedFrame obj)

Copy assignment operator.


The documentation for this class was generated from the following file: