MaestroEventInterface

This is the public API that the app can use to make calls to the SDK related to the currently-loaded event.

Functions

abstract fun clipDidFailToPlay(index: Int)

Tells the SDK that the user tried to play the clip but it failed to play back.

abstract fun didHideOverlay()

abstract fun didHidePanel()

Tells the SDK that the app hid the MaestroPanel.

abstract fun didShowOverlay()

abstract fun didShowPanel(maestroPanelType: MaestroPanelType)

Tells the SDK that the app displayed the MaestroPanel.

Tells the SDK that the user just started playing a new key play clip at the given index.

abstract fun didStopPlayingClip(index: Int)

Tells the SDK that the user just stopped playing a key play clip at the given index.

Updates the SDK with the latest progress in the playback of the currently-played key play clip, from 0 to 1.

Retrieves the progress (between 0 and 1) of the currently-played key play clip.

abstract fun getCurrentEventID(): StateFlow<String?>

Retrieves the event ID for the currently loaded event.

Retrieves the array index of the key play clip that is currently being played.

abstract fun getKeyPlaysCount(): StateFlow<Int>

Retrieves the number of key plays.

abstract fun getLastPlayedClipIndex(): StateFlow<Int?>

Retrieves the array index of the key plays clip that was most recently played.

Tells the SDK that the keyplay with index index needs to gain focus