OverlayBitmap::setEnable Method

Enables or disables the display of the overlay bitmap on the live video.

Syntax:

bool setEnable( bool bOnOff );

Parameter		Description


bOnOff		Specifies whether the the overlay should be displayed or not. It defaults to false. If set to true, the overlay will be displayed on the live video stream. If set to false, the overlay is not displayed.

Return value:

true on success, false otherwise.

Remarks:

This method is used to enable or disable the display of the overlay on the live video. If the overlay is disabled, no CPU time is used because the overlay bitmap is not rendered. Since this is the default state, all applications that do not need an overlay will not suffer from a performance decrease.

See also:

OverlayBitmap, OverlayBitmap::getEnable

<< OverlayBitmap