getCurrentlyPlayingClipIndex

Introduction

The getCurrentlyPlayingClipIndex() method retrieves the array index of the key play clip that is currently being played. This is useful for tracking playback status and synchronizing UI updates based on which clip is active. If no clip is currently playing, the method returns nil.

Return Value

Return Type	Description	Example
Int?	The index of the key play clip that is currently playing, or nil if none is active.	2

Code Example

if let playingClipIndex = eventInterface.getCurrentlyPlayingClipIndex() {
    print("Currently playing clip at index: \(playingClipIndex)")
} else {
    print("No clip is currently playing.")
}