Overlay_options_setoverlaypath, Overlay_options_setoverlayposition, Overlay_options_setoverlayposition() – Google Flix Engine Linux Reference Manual User Manual

Page 137

Advertising
background image

5.31 Overlay (Watermark)

131

Once this function has been called successfully,

overlay_options_Reset()

must be called to turn trans-

parency off.
Calling this method will disable masking based on RGB components.
Using a PNG or bitmap with full alpha channel will produce better results than using a transparency
color.
If using this method to add an overlay to video with an existing alpha channel, the transparent portions
of the overlay will be transparent in the output video. Opaque portions of the overlay will be averaged
with the existing alpha data.

Deprecated

Use the

Filter Interface

along with

FE2_FILTER_OVERLAY

and the

FE2_OVERLAY_MASK_X

and

FE2_OVERLAY_MASK_Y

parameters. This function will be removed in a future release.

5.31.4.9

on2sc overlay_options_SetOverlayPath (FLIX2HANDLE flix, const on2tc ∗
pOverlayFilePath)

Set the path to the overlay image file.

Parameters:

← flix Handle to the flix engine returned from

Flix2_Create()

or

Flix2_CreateEx()

← pOverlayFilePath the path to the overlay image

Return values:

ON2_OK

the path to the overlay image was set successfully

ON2_INVALID_PARAMS

a precondition failed

ON2_NET_ERROR

the underlying communication layer failed

Precondition:

flix

is not NULL

pOverlayFilePath

is not NULL

Remarks:

This method does not check for the existence of the file at the specified path.
Only PNG images, 24 bit bitmaps, and 32 bit bitmaps are supported. Use of PNG images is highly
recommended.
Images with an uneven width or uneven height will be cropped.
Overlay images larger than the video image will be cropped.
When both the video and overlay images contain an alpha channel, the overlay and video alpha will
be averaged. For example, if the video at the overlay position was fully transparent, and the overlay
was fully opaque, the region of the exported video where the overlay was placed would become 50%
opaque.

Deprecated

Use the

Filter Interface

along with

FE2_FILTER_OVERLAY

and the

FE2_OVERLAY_FILE

param-

eter. This function will be removed in a future release.

Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen

Advertising