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
}
enum  Status {
  SUPPORTED,
  UNSUPPORTED,
  INCOMPATIBLE,
  CLIENT_UNSUPPORTED
}



 FrameEncoders ()
virtual ~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 couple of encoders that are used to encode still and interactive frames.


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 9.2 and driver version 397.44 or higher on Windows / driver version 396.26 or higher on Linux. On Linux, this encoder requires the package libva.

H264_OPENH264 

H.264 encoder using OpenH264.

On Linux, this encoder requires the package libva.

Frame encoder status.


Enumerator:
SUPPORTED 

The encoder can be loaded and used by the service.

UNSUPPORTED 

The encoder cannot be loaded by the service (missing RemoteViz codec library or satisfied dependency), or the encoder is not supported by the system (Example: no Nvidia GPU or missing CUDA Toolkit to use H264_NVENC).

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.


virtual RemoteViz::Rendering::FrameEncoders::~FrameEncoders (  )  [virtual]

Destructor.



Member Function Documentation

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

Gets the interactive encoder.


Default value is NONE.

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.

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

Gets the still encoder status.


Default value is UNSUPPORTED.

Returns:
the still encoder status.
void RemoteViz::Rendering::FrameEncoders::setInteractiveEncoder ( Encoder  value  ) 

Sets the interactive encoder.


This encoder will be used to encode interactive frames.
Default value is NONE.

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.

Parameters:
value : still encoder.

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

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