Class el.DSPScriptPosition

Time information for DSP Scripts.

An object of this type is passed to a DSP Script's process function conveying timing information.

Methods

DSPScriptPosition:playing () True if playing.
DSPScriptPosition:recording () True if recording.
DSPScriptPosition:looping () True if looping
DSPScriptPosition:valid () True if this position is valid.
DSPScriptPosition:frame () Time in audio samples.
DSPScriptPosition:seconds () Time in seconds.
DSPScriptPosition:bpm () The current BPM.
DSPScriptPosition:beatsPerBar () Beats per bar e.g.
DSPScriptPosition:beatUnit () Denominator of a the time signature.
DSPScriptPosition:bar () The current bar.
DSPScriptPosition:beat () The current beat in terms of quarter note.


Methods

DSPScriptPosition:playing ()
True if playing.
DSPScriptPosition:recording ()
True if recording.
DSPScriptPosition:looping ()
True if looping
DSPScriptPosition:valid ()
True if this position is valid. All other methods are not reliable if this returns false.
DSPScriptPosition:frame ()
Time in audio samples.

Returns:

    The frame as an Integer
DSPScriptPosition:seconds ()
Time in seconds.

Returns:

    Time in seconds as a number
DSPScriptPosition:bpm ()
The current BPM.

Returns:

    The bpm
DSPScriptPosition:beatsPerBar ()
Beats per bar e.g. the numerator in a time signature

Returns:

    The time signature numerator.
DSPScriptPosition:beatUnit ()
Denominator of a the time signature.

Returns:

    The time signature denominator
DSPScriptPosition:bar ()
The current bar.

Returns:

    The bar
DSPScriptPosition:beat ()
The current beat in terms of quarter note.

Returns:

    The beat
generated by LDoc 1.5.0 Last updated 2026-07-23 23:46:40