AVBlocks for C++  3.0
Audio and Video Software Development Kit
Loading...
Searching...
No Matches
primo::avblocks::Param Namespace Reference

Defines parameters that can be passed to the transcoder and to the components that are used in the transcoding process. More...

Namespaces

namespace  Decoder
 Parameters specific to decoders.
 
namespace  Demuxer
 Parameters specific to demuxers.
 
namespace  Encoder
 Parameters specific to encoders.
 
namespace  Muxer
 Parameters specific to muxers.
 
namespace  Video
 Parameters specific to video filters.
 

Variables

static const char HardwareEncoder [] = "HARDWARE_ENCODER"
 Specifies which hardware encoder shall be used.
 
static const char HardwareEncoderApi [] = "HARDWARE_ENCODER_API"
 Specifies which hardware API shall be used.
 
static const char HardwareEncoderDevice [] = "HARDWARE_ENCODER_DEVICE"
 Specifies the device ID that shall be used for hardware encoding.
 
static const char ReEncode [] = "REENCODE_STREAM"
 Specifies whether a stream will be re-encoded.
 

Detailed Description

Defines parameters that can be passed to the transcoder and to the components that are used in the transcoding process.

A parameter can be used with one or more components like decoders, encoders, demuxers, muxers, and others.

A parameter can apply to:

  • any component
  • a certain component category like encoders, decoders, demuxers, muxers, etc.

  • a component that handles a specific format like H.264 encoder, MPEG-2 encoder, MPEG-2 muxer, etc.

  • a specific implementation of a component, or a block like PrimoCodecs H.264 encoder

The value representation, range and interpretation is different for each parameter.

See also
ParameterList
MediaPin::params
MediaSocket::params

Variable Documentation

◆ HardwareEncoder

const char HardwareEncoder[] = "HARDWARE_ENCODER"
static

Specifies which hardware encoder shall be used.

This parameter is an integer.

The supported values are defined in the primo::avblocks::HardwareEncoder::Enum. The default value is HardwareEncoder::Off.

◆ HardwareEncoderApi

const char HardwareEncoderApi[] = "HARDWARE_ENCODER_API"
static

Specifies which hardware API shall be used.

This parameter is an integer.

The supported values are defined in the primo::codecs::HwApi::Enum. The default value is HwApi::None which lets AVBlocks select the hardware API.

Note
AMD OpenVideo is never selected automatically by AVBlocks. It must be explicitly requested through this parameter.

◆ HardwareEncoderDevice

const char HardwareEncoderDevice[] = "HARDWARE_ENCODER_DEVICE"
static

Specifies the device ID that shall be used for hardware encoding.

This parameter is an integer.

The device ID includes uniquely identified devices that support the hardware encoder specified by the HardwareEncoder parameter. The default value is 0.

See also
primo::codecs::HwDevice

◆ ReEncode

const char ReEncode[] = "REENCODE_STREAM"
static

Specifies whether a stream will be re-encoded.

This parameter is an integer.

The supported values are defined in the primo::avblocks::Use::Enum. The default value is Use::Auto.

If this parameter is Use::Auto the re-encoding is done only when the input and the output formats are not equivalent. If this parameter is Use::On the re-encoding is always done even if the input and the output formats are equivalent. The case when this parameter is Use::Off is not implemented.