primo::avblocks::Param::Video::Overlay Namespace Reference

Parameters specific to the video overlay filter. More...

Variables
static const char	BackgroundAlpha [] = "OVERLAY_BACKGROUND_ALPHA"
	Specifies the alpha value for all pixels in the background.
static const char *	BackgroundX = LocationX
	Specifies the X coordinate of the background origin where the overlay must be applied.
static const char *	BackgroundY = LocationX
	Specifies the Y coordinate of the background origin where the overlay must be applied.
static const char	ForegroundAlpha [] = "OVERLAY_FOREGROUND_ALPHA"
	Specifies the alpha value for all pixels in the foreground.
static const char	ForegroundBuffer [] = "OVERLAY_FOREGROUND_BUFFER"
	Specifies the foreground that should be overlaid with the background.
static const char	ForegroundBufferFormat [] = "OVERLAY_FOREGROUND_BUFFER_FORMAT"
	Specifies the format of the foreground buffer.
static const char	LocationX [] = "OVERLAY_LOCATION_X"
	Specifies the X coordinate of the location where the overlay is applied on the frame.
static const char	LocationY [] = "OVERLAY_LOCATION_Y"
	Specifies the Y coordinate of the location where the overlay is applied on the frame.
static const char	Mode [] = "OVERLAY_MODE"
	Specifies an alpha compositing mode - the way a foreground overlay image is combined with the background video.

Detailed Description

Parameters specific to the video overlay filter.

Variable Documentation

BackgroundAlpha

const char BackgroundAlpha[] = "OVERLAY_BACKGROUND_ALPHA"

static

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.

BackgroundX

const char* BackgroundX = LocationX

static

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.

BackgroundY

const char* BackgroundY = LocationX

static

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.

ForegroundAlpha

const char ForegroundAlpha[] = "OVERLAY_FOREGROUND_ALPHA"

static

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.

ForegroundBuffer

const char ForegroundBuffer[] = "OVERLAY_FOREGROUND_BUFFER"

static

Specifies the foreground that should be overlaid with the background.

This is a MediaBufferParameter.

ForegroundBufferFormat

const char ForegroundBufferFormat[] = "OVERLAY_FOREGROUND_BUFFER_FORMAT"

static

Specifies the format of the foreground buffer.

This is a VideoStreamInfoParameter.

LocationX

const char LocationX[] = "OVERLAY_LOCATION_X"

static

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).

LocationY

const char LocationY[] = "OVERLAY_LOCATION_Y"

static

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).

Mode

const char Mode[] = "OVERLAY_MODE"

static

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.