RemoteViz::Rendering::EncodedFrame Class Reference
[RemoteViz]
#include <RemoteViz/Rendering/EncodedFrame.h>
Public Types | |
| enum | EncodingFormat { JPEG, PNG, H264, VP9 } |
Public Member Functions | |
| EncodedFrame () | |
| EncodedFrame (const EncodedFrame &obj) | |
| EncodedFrame & | operator= (const EncodedFrame &obj) |
| ~EncodedFrame () | |
| size_t | getBufferSize () const |
| EncodingFormat | getEncodingFormat () const |
| size_t | getId () const |
| bool | isLossless () const |
| bool | isInteractive () const |
Detailed Description
This class provides the features of an encoded frame that is sent to the client.
Member Enumeration Documentation
Constructor & Destructor Documentation
| RemoteViz::Rendering::EncodedFrame::EncodedFrame | ( | ) |
Constructor.
| RemoteViz::Rendering::EncodedFrame::EncodedFrame | ( | const EncodedFrame & | obj | ) |
Copy constructor.
| RemoteViz::Rendering::EncodedFrame::~EncodedFrame | ( | ) |
Destructor.
Member Function Documentation
| size_t RemoteViz::Rendering::EncodedFrame::getBufferSize | ( | ) | const |
Gets the frame buffer size in bytes.
- Returns:
- the buffer size of the encoded frame.
| EncodingFormat RemoteViz::Rendering::EncodedFrame::getEncodingFormat | ( | ) | const |
Gets the frame encoding format.
- Returns:
- the encoding format of the encoded frame.
| size_t RemoteViz::Rendering::EncodedFrame::getId | ( | ) | const |
Gets the frame id.
- Returns:
- the frame id of the encoded frame.
| 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
| bool RemoteViz::Rendering::EncodedFrame::isLossless | ( | ) | const |
Returns if the frame is lossless.
- Returns:
- true if the frame is lossless
| EncodedFrame& RemoteViz::Rendering::EncodedFrame::operator= | ( | const EncodedFrame & | obj | ) |
Copy assignment operator.
The documentation for this class was generated from the following file:
- RemoteViz/Rendering/EncodedFrame.h