Google Flix Engine Linux Reference Manual - Manual (Page 126)

120 Flix Engine Linux Module Documentation
5.31 Overlay (Watermark)
5.31.1 Detailed Description
The overlay video filter is a filter used to apply a PNG image to the output video. In addition this filter
supports positioning the overlay and treating sections of the image as transparent either by specifying a
pixel of the image to use as a reference, specifying a RGB value to use as a reference or using the alpha
channel of the image.
Filter Parameters:
Name | Type | Opt/Reqd | Range
=======================================================================================
FE2_OVERLAY_FILE | String | Required | N/A
FE2_OVERLAY_MASK_XY | Boolean | Optional | [on2false,on2true]
FE2_OVERLAY_MASK_X | Numeric | Optional | [0,video width)
FE2_OVERLAY_MASK_Y | Numeric | Optional | [0,video height)
FE2_OVERLAY_MASK_RGB | Boolean | Optional | [on2false,on2true]
FE2_OVERLAY_MASK_R | Numeric | Optional | [0,255]
FE2_OVERLAY_MASK_G | Numeric | Optional | [0,255]
FE2_OVERLAY_MASK_B | Numeric | Optional | [0,255]
FE2_OVERLAY_POS | Numeric | Optional | [FE2_OverlayPositionMode]
FE2_OVERLAY_POS_X | Numeric | Optional | [0,video width)
FE2_OVERLAY_POS_Y | Numeric | Optional | [0,video height)
Example Usage:
sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_OVERLAY);
//apply image.png to the top left of the output video
if(sc == ON2_OK)
sc = Flix2_FilterSetParamAsStr(filter, FE2_OVERLAY_FILE, "/tmp/image.png");
Deprecated functions
• on2sc overlay_options_Reset (const FLIX2HANDLE flix)
Resets the overlay options.
• on2sc overlay_options_GetUseOverlay (const FLIX2HANDLE flix, on2bool ∗pUseOverlay)
Determines if an overlay is to be used.
• on2sc overlay_options_SetUseOverlay ( FLIX2HANDLE flix, const on2bool bUseOverlay)
Enables or disables overlay usage.
• on2sc overlay_options_GetOverlayPath (const FLIX2HANDLE flix, on2tc ∗pOverlayFilePath,
int32_t ∗pLen)
Returns the path to the overlay image file.
• on2sc overlay_options_SetOverlayPath ( FLIX2HANDLE flix, const on2tc ∗pOverlayFilePath)
Set the path to the overlay image file.
• on2sc overlay_options_GetMaskPixelXY (const FLIX2HANDLE flix, int32_t ∗pMaskPixelX,
int32_t ∗pMaskPixelY)
Return the X and Y coordinates of the mask pixel.
Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen