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

128 Flix Engine Linux Module Documentation
5.31.4.4 on2sc overlay_options_GetOverlayPosition (FLIX2HANDLE flix,
FE2_OverlayPositionMode ∗ pMode, uint32_t ∗ pX, uint32_t ∗ pY)
Return the overlay position.
Parameters:
← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
→ pMode pointer to variable that will receive the mode value
→ pX pointer to variable that will receive the X value
→ pY pointer to variable that will receive the Y value
Return values:
ON2_OK the values were retrieved successfully
ON2_INVALID_PARAMS a precondition failed
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pMode is not NULL
pX is not NULL
pY is not NULL
Remarks:
This method returns the values set in previous call to overlay_options_SetOverlayPosition() , if no
call was made previously, mode will default to FE2_OVERLAY_POS_MODE_TOPLEFT . The X/Y
coordinates will default to 0.
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.5 on2sc overlay_options_GetUseOverlay (const FLIX2HANDLE flix, on2bool ∗
pUseOverlay)
Determines if an overlay is to be used.
Parameters:
← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
→ pUseOverlay pointer to the on2bool variable that will receive the usage state
Return values:
ON2_OK pUseOverlay was set successfully
ON2_INVALID_PARAMS a precondition failed
ON2_NET_ERROR the underlying communication layer failed
Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen