Page tree
Skip to end of metadata
Go to start of metadata

getBeatTime()

Description

Function to obtain the current song position in number of beats (quarter notes).

Available in: Processor.

Return Values

When the host is in playback, the function returns a decimal with the number of beats (quarter notes) since the start of the song. The start of the song equals 0 beats. The function returns -1 if the host is not in playback.

Example

-- print the song position in number of beats
function onNote(event)
	posInSong = getBeatTime()
	if (posInSong ~= -1) then
        print(string.format("%.3f beats", posInSong))
    else
        print("Playback is stopped.") 
    end
end

1 Comment