RemoteViz::Rendering::FrameEncoders Class Reference
[RemoteViz]

RemoteViz More...

#include <RemoteViz/Rendering/FrameEncoders.h>

List of all members.

Public Types

enum  Encoder {
  NONE,
  JPEG,
  PNG,
  H264_NVENC,
  H264_OPENH264,
  VP9_VPX
}
enum  Status {
  SUPPORTED,
  UNSUPPORTED,
  INCOMPATIBLE,
  CLIENT_UNSUPPORTED
}



 FrameEncoders ()
 FrameEncoders (const FrameEncoders &obj)
FrameEncodersoperator= (const FrameEncoders &obj)
 ~FrameEncoders ()
void setInteractiveEncoder (Encoder value)
Encoder getInteractiveEncoder () const
void setStillEncoder (Encoder value)
Encoder getStillEncoder () const
Status getInteractiveEncoderStatus () const
Status getStillEncoderStatus () const

Detailed Description

RemoteViz

Defines a pair of encoders that are used to encode still and interactive frames.

Default value for both still and interactive is NONE when a FrameEncoders object is created. But when a client connects to the service, RemoteViz will set PNG for still frames and JPEG for interactive frames. Frames are considered "interactive" when the user is interacting with the scene, for example dragging the mouse to move the camera. In this case it may be acceptable to use (for example) lossy JPEG encoding to maximize performance, then switch to loss-less PNG encoding for the "still" frame when the user interaction is finished.

Video encoding (H.264 or VP9) generally provides better performance (frames per second) than image encoding (JPEG and PNG). However this depends on many factors. Video encoded frames usually require less bandwidth, but the encoding of each frame can take more time. See the hardware and software dependencies for each encoder below.

A FrameEncoders object is passed to the RenderAreaListener methods onOpenedConnection(), onInitializedConnection() and onRefusedEncoder().

The current frame encoders can also be queried using ConnectionSettings::getFrameEncoders().

See also ConnectionSettings::setFrameEncodingPolicy().

See the examples HelloConeH264 and HelloConeVP9.

Limitations:


Member Enumeration Documentation

Frame encoder.


Enumerator:
NONE 

Internal usage.

JPEG 

JPEG encoder.

PNG 

PNG encoder.

H264_NVENC 

H.264 encoder using Nvidia Video Codec.

This encoder requires an NVIDIA GPU Kepler or higher, CUDA Toolkit 10.1 or higher and driver version 418.96 or higher on Windows / driver version 418.39 or higher on Linux. On Windows, this encoder requires the library nvEncodeAPI(64).dll. On Linux, this encoder requires the libraries libnvidia-encode and libva.

H264_OPENH264 

H.264 encoder using OpenH264.

On Linux, this encoder requires the library libva.

VP9_VPX 

VP9 encoder using libvpx.

On Linux, this encoder requires the library libva.

Frame encoder status.


Enumerator:
SUPPORTED 

The encoder can be loaded and used by the service.

UNSUPPORTED 

Reasons:

  • The encoder cannot be loaded by the service: the RemoteViz codec library (fei_remoteViz_*_codec) is missing or at least one dependency is not satisfied (On Linux, the command ldd can be used to check if dependencies are satisfied).
  • The encoder is not supported by the system (Example: no Nvidia GPU to use H264_NVENC). Enabling debugging will output more verbose information.
INCOMPATIBLE 

The pair (still encoder, interactive encoder) is incompatible.

CLIENT_UNSUPPORTED 

The codec format is not supported by the client (Example: the client does not support H.264 decoding).


Constructor & Destructor Documentation

RemoteViz::Rendering::FrameEncoders::FrameEncoders (  ) 

Constructor.


RemoteViz::Rendering::FrameEncoders::FrameEncoders ( const FrameEncoders obj  ) 

Copy constructor.

RemoteViz::Rendering::FrameEncoders::~FrameEncoders (  ) 

Destructor.



Member Function Documentation

Encoder RemoteViz::Rendering::FrameEncoders::getInteractiveEncoder (  )  const

Gets the interactive encoder.


Default value is NONE when a FrameEncoders object is created. But note that, by default, RemoteViz will set this value to JPEG when a connection is initialized.

Returns:
the interactive encoder.
Status RemoteViz::Rendering::FrameEncoders::getInteractiveEncoderStatus (  )  const

Gets the interactive encoder status.


Default value is UNSUPPORTED.

Returns:
the interactive encoder status.
Encoder RemoteViz::Rendering::FrameEncoders::getStillEncoder (  )  const

Gets the still encoder.


Default value is NONE when a FrameEncoders object is created. But note that, by default, RemoteViz will set this value to PNG when a connection is initialized.

Returns:
the still encoder.
Status RemoteViz::Rendering::FrameEncoders::getStillEncoderStatus (  )  const

Gets the still encoder status.


Default value is UNSUPPORTED.

Returns:
the still encoder status.
FrameEncoders& RemoteViz::Rendering::FrameEncoders::operator= ( const FrameEncoders obj  ) 

Copy assignment operator.

void RemoteViz::Rendering::FrameEncoders::setInteractiveEncoder ( Encoder  value  ) 

Sets the interactive encoder.


This encoder will be used to encode interactive frames. Default value is NONE when a FrameEncoders object is created. But note that, by default, RemoteViz will set this value to JPEG when a connection is initialized.

Parameters:
value : interactive encoder.
void RemoteViz::Rendering::FrameEncoders::setStillEncoder ( Encoder  value  ) 

Sets the still encoder.


This encoder will be used to encode still frames.
Default value is NONE when a FrameEncoders object is created. But note that, by default, RemoteViz will set this value to PNG when a connection is initialized.

Parameters:
value : still encoder.

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

Open Inventor Toolkit reference manual, generated on 12 Sep 2022
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/