Overlay_options_getoverlaypath, Overlay_options_getoverlayposition – Google Flix Engine Linux Reference Manual User Manual

Page 133

Advertising
background image

5.31 Overlay (Watermark)

127

ON2_INVALID_PARAMS

a precondition failed

ON2_NET_ERROR

the underlying communication layer failed

Precondition:

flix

is not NULL

pMaskPixelX

is not NULL

pMaskPixelY

is not NULL

Remarks:

This method returns the values set in previous call to

overlay_options_SetMaskPixelXY()

, if no coor-

dinates were previously set, the X and Y coordinate values will be set to 0.
The color at the specified coordinate will become transparent when the overlay image is drawn on the
video image.

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

on2sc overlay_options_GetOverlayPath (const FLIX2HANDLE flix, on2tc ∗
pOverlayFilePath, int32_t ∗ pLen)

Returns the path to the overlay image file.

Parameters:

← flix Handle to the flix engine returned from

Flix2_Create()

or

Flix2_CreateEx()

→ pOverlayFilePath string that will receive the file path

↔ pLen length of pOverlayFilePath

Return values:

ON2_OK

success

ON2_INVALID_PARAMS

a precondition failed

ON2_NET_ERROR

the underlying communication layer failed

Precondition:

flix

is not NULL

pLen

is not NULL

Remarks:

if pOverlayFilePath is not NULL, the value pointed to by pLen must be set to the maximum
number of characters that can be written to pOverlayFilePath.
If pOverlayFilePath is NULL, pLen will be set to the length of the path to the overlay image

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