primo::avblocks::Param::Video::Overlay

Parameters specific to the video overlay filter.

static const char primo::avblocks::Param::Video::Overlay::Mode[] = "OVERLAY_MODE"

Specifies an alpha compositing mode - the way a foreground overlay image is combined with the background video.

This is an IntParameter. The acceptable values are defined in primo::codecs::AlphaCompositingMode::Enum.

The default value is AlphaCompositingMode::Over (Foreground over Background), in effect, a normal painting operation.

static const char primo::avblocks::Param::Video::Overlay::LocationX[] = "OVERLAY_LOCATION_X"

Specifies the X coordinate of the location where the overlay is applied on the frame.

This is an IntParameter.

X increases from left to right. The top left point in the frame is the origin and has coordinates (0,0).

static const char primo::avblocks::Param::Video::Overlay::LocationY[] = "OVERLAY_LOCATION_Y"

Specifies the Y coordinate of the location where the overlay is applied on the frame.

This is an IntParameter.

Y increases from top to bottom. The top left point in the frame is the origin and has coordinates (0,0).

static const char *primo::avblocks::Param::Video::Overlay::BackgroundX = LocationX

Specifies the X coordinate of the background origin where the overlay must be applied.

This is an IntParameter.

Deprecated:

Please use primo::avblocks::Param::Video::Overlay::LocationX instead.

static const char *primo::avblocks::Param::Video::Overlay::BackgroundY = LocationX

Specifies the Y coordinate of the background origin where the overlay must be applied.

This is an IntParameter.

Deprecated:

Please use primo::avblocks::Param::Video::Overlay::LocationY instead.

static const char primo::avblocks::Param::Video::Overlay::BackgroundAlpha[] = "OVERLAY_BACKGROUND_ALPHA"

Specifies the alpha value for all pixels in the background.

This is a FloatParameter with range from 0.0 to 1.0. The default value is 1.0.

static const char primo::avblocks::Param::Video::Overlay::ForegroundBuffer[] = "OVERLAY_FOREGROUND_BUFFER"

Specifies the foreground that should be overlaid with the background.

This is a MediaBufferParameter.

static const char primo::avblocks::Param::Video::Overlay::ForegroundBufferFormat[] = "OVERLAY_FOREGROUND_BUFFER_FORMAT"

Specifies the format of the foreground buffer.

This is a VideoStreamInfoParameter.

static const char primo::avblocks::Param::Video::Overlay::ForegroundAlpha[] = "OVERLAY_FOREGROUND_ALPHA"

Specifies the alpha value for all pixels in the foreground.

This is a FloatParameter with range from 0.0 to 1.0.

The default value is 1.0 which in combination with other overlay parameters results in showing the foreground and hiding the background.