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

132 Flix Engine Linux Module Documentation
5.31.4.10 on2sc overlay_options_SetOverlayPosition (FLIX2HANDLE flix,
FE2_OverlayPositionMode mode, uint32_t x, uint32_t y)
Set the overlay position.
Parameters:
← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
→ mode the position mode
→ x the x coordinate value
→ y the y coordinate value
Return values:
ON2_OK success
ON2_INVALID_PARAMS the precondition failed
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
Remarks:
The x and y values are ignored unless mode is equal to FE2_OVERLAY_POS_MODE_XY .
If mode is equal to FE2_OVERLAY_POS_MODE_XY , and either coordinate value is invalid (x >
video width or y > video height), the invalid coordinate will be set to 0.
If the the value of the x and/or y coordinates cause any portion of the overlay to be outside of the video
image bounds, the portion of the overlay image that is out of bounds will be cropped.
Deprecated
Use the Filter Interface along with FE2_FILTER_OVERLAY and the FE2_OVERLAY_POS , FE2_-
OVERLAY_POS_X , FE2_OVERLAY_POS_Y parameters. This function will be removed in a future
release.
5.31.4.11 on2sc overlay_options_SetUseOverlay (FLIX2HANDLE flix, const on2bool bUseOverlay)
Enables or disables overlay usage.
Parameters:
← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
← bUseOverlay on2bool value set to the desired overlay state
Return values:
ON2_OK the overlay status was changed successfully
ON2_INVALID_PARAMS the precondition failed
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is NULL
Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen