Param.Video.Overlay Class Reference

Parameters specific the video overlay filter. More...

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

Detailed Description

Parameters specific the video overlay filter.

Member Data Documentation

BackgroundAlpha

string BackgroundAlpha = "OVERLAY_BACKGROUND_ALPHA"

static

Specifies the alpha value for all pixels in the background.

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

BackgroundX

string BackgroundX = LocationX

static

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

Deprecated:

Please use PrimoSoftware.AVBlocks.Param.Video.Overlay.LocationX.

This is an integer parameter.

BackgroundY

string BackgroundY = LocationY

static

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

Deprecated:

Please use PrimoSoftware.AVBlocks.Param.Video.Overlay.LocationY.

This is an integer parameter.

ForegroundAlpha

string ForegroundAlpha = "OVERLAY_FOREGROUND_ALPHA"

static

Specifies the alpha value for all pixels in the foreground.

This is a float parameter 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

string ForegroundBuffer = "OVERLAY_FOREGROUND_BUFFER"

static

Specifies the foreground that should be overlaid with the background.

This is a MediaBuffer parameter.

ForegroundBufferFormat

string ForegroundBufferFormat = "OVERLAY_FOREGROUND_BUFFER_FORMAT"

static

Specifies the format of the foreground buffer.

This is a VideoStreamInfo parameter.

LocationX

string LocationX = "OVERLAY_LOCATION_X"

static

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

This is an integer parameter.

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

LocationY

string LocationY = "OVERLAY_LOCATION_Y"

static

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

This is an integer parameter.

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

Mode

string Mode = "OVERLAY_MODE"

static

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

This is an integer parameter. The acceptable values are defined in the AlphaCompositingMode enum.

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