isOverlayShowing

Returns whether the Maestro overlay is currently visible.

Overview

Call isOverlayShowing to check whether the overlay is currently displayed on screen. Use this to conditionally show or hide your application's UI in response to overlay state.

Method Signature

isOverlayShowing(): boolean;

Parameters

This method does not take any parameters.

Return Value

true if the overlay is currently showing; false otherwise.

Example

const event = SDK.getMaestroEventViewModel();

if (event.isOverlayShowing()) {
  console.log('Overlay is visible');
}

Notes

• To receive lifecycle events when the overlay appears or dismisses, implement onOverlayEvent on your delegate.
• To push position data to the overlay, use setDataToOverlay.

See also

• Overlays — what an overlay is, how it is triggered, and its lifecycle.
• Overlay Integration — step-by-step host integration.