Public Member Functions | Public Attributes | List of all members
AudioPlayHead::CurrentPositionInfo Struct Reference

This structure is filled-in by the AudioPlayHead::getCurrentPosition() method. More...

Public Member Functions

bool operator== (const CurrentPositionInfo &other) const noexcept
 
bool operator!= (const CurrentPositionInfo &other) const noexcept
 
void resetToDefault ()
 

Public Attributes

double bpm = 120.0
 The tempo in BPM. More...
 
int timeSigNumerator = 4
 Time signature numerator, e.g. More...
 
int timeSigDenominator = 4
 Time signature denominator, e.g. More...
 
int64 timeInSamples = 0
 The current play position, in samples from the start of the timeline. More...
 
double timeInSeconds = 0
 The current play position, in seconds from the start of the timeline. More...
 
double editOriginTime = 0
 For timecode, the position of the start of the timeline, in seconds from 00:00:00:00. More...
 
double ppqPosition = 0
 The current play position, in units of quarter-notes. More...
 
double ppqPositionOfLastBarStart = 0
 The position of the start of the last bar, in units of quarter-notes. More...
 
FrameRate frameRate = FrameRateType::fps23976
 The video frame rate, if applicable. More...
 
bool isPlaying = false
 True if the transport is currently playing. More...
 
bool isRecording = false
 True if the transport is currently recording. More...
 
double ppqLoopStart = 0
 The current cycle start position in units of quarter-notes. More...
 
double ppqLoopEnd = 0
 The current cycle end position in units of quarter-notes. More...
 
bool isLooping = false
 True if the transport is currently looping. More...
 

Detailed Description

This structure is filled-in by the AudioPlayHead::getCurrentPosition() method.

Member Function Documentation

◆ operator==()

bool AudioPlayHead::CurrentPositionInfo::operator== ( const CurrentPositionInfo other) const
noexcept

◆ operator!=()

bool AudioPlayHead::CurrentPositionInfo::operator!= ( const CurrentPositionInfo other) const
noexcept

References operator==().

◆ resetToDefault()

void AudioPlayHead::CurrentPositionInfo::resetToDefault ( )

Member Data Documentation

◆ bpm

double AudioPlayHead::CurrentPositionInfo::bpm = 120.0

The tempo in BPM.

◆ timeSigNumerator

int AudioPlayHead::CurrentPositionInfo::timeSigNumerator = 4

Time signature numerator, e.g.

the 3 of a 3/4 time sig

◆ timeSigDenominator

int AudioPlayHead::CurrentPositionInfo::timeSigDenominator = 4

Time signature denominator, e.g.

the 4 of a 3/4 time sig

◆ timeInSamples

int64 AudioPlayHead::CurrentPositionInfo::timeInSamples = 0

The current play position, in samples from the start of the timeline.

◆ timeInSeconds

double AudioPlayHead::CurrentPositionInfo::timeInSeconds = 0

The current play position, in seconds from the start of the timeline.

◆ editOriginTime

double AudioPlayHead::CurrentPositionInfo::editOriginTime = 0

For timecode, the position of the start of the timeline, in seconds from 00:00:00:00.

◆ ppqPosition

double AudioPlayHead::CurrentPositionInfo::ppqPosition = 0

The current play position, in units of quarter-notes.

◆ ppqPositionOfLastBarStart

double AudioPlayHead::CurrentPositionInfo::ppqPositionOfLastBarStart = 0

The position of the start of the last bar, in units of quarter-notes.

This is the time from the start of the timeline to the start of the current bar, in ppq units.

Note - this value may be unavailable on some hosts, e.g. Pro-Tools. If it's not available, the value will be 0.

◆ frameRate

FrameRate AudioPlayHead::CurrentPositionInfo::frameRate = FrameRateType::fps23976

The video frame rate, if applicable.

◆ isPlaying

bool AudioPlayHead::CurrentPositionInfo::isPlaying = false

True if the transport is currently playing.

◆ isRecording

bool AudioPlayHead::CurrentPositionInfo::isRecording = false

True if the transport is currently recording.

(When isRecording is true, then isPlaying will also be true).

◆ ppqLoopStart

double AudioPlayHead::CurrentPositionInfo::ppqLoopStart = 0

The current cycle start position in units of quarter-notes.

Note that not all hosts or plugin formats may provide this value.

See also
isLooping

◆ ppqLoopEnd

double AudioPlayHead::CurrentPositionInfo::ppqLoopEnd = 0

The current cycle end position in units of quarter-notes.

Note that not all hosts or plugin formats may provide this value.

See also
isLooping

◆ isLooping

bool AudioPlayHead::CurrentPositionInfo::isLooping = false

True if the transport is currently looping.


The documentation for this struct was generated from the following file: