JUCE  v5.1.1-3-g1a0b28c73
JUCE API
AudioPlayHead::CurrentPositionInfo Struct Reference

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

#include <juce_AudioPlayHead.h>

Collaboration diagram for AudioPlayHead::CurrentPositionInfo:

Public Member Functions

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

Public Attributes

double bpm
 The tempo in BPM. More...
 
double editOriginTime
 For timecode, the position of the start of the edit, in seconds from 00:00:00:00. More...
 
FrameRateType frameRate
 The video frame rate, if applicable. More...
 
bool isLooping
 True if the transport is currently looping. More...
 
bool isPlaying
 True if the transport is currently playing. More...
 
bool isRecording
 True if the transport is currently recording. More...
 
double ppqLoopEnd
 The current cycle end position in pulses-per-quarter-note. More...
 
double ppqLoopStart
 The current cycle start position in pulses-per-quarter-note. More...
 
double ppqPosition
 The current play position, in pulses-per-quarter-note. More...
 
double ppqPositionOfLastBarStart
 The position of the start of the last bar, in pulses-per-quarter-note. More...
 
int64 timeInSamples
 The current play position, in samples from the start of the edit. More...
 
double timeInSeconds
 The current play position, in seconds from the start of the edit. More...
 
int timeSigDenominator
 Time signature denominator, e.g. More...
 
int timeSigNumerator
 Time signature numerator, e.g. 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

◆ resetToDefault()

void AudioPlayHead::CurrentPositionInfo::resetToDefault ( )

Member Data Documentation

◆ bpm

double AudioPlayHead::CurrentPositionInfo::bpm

The tempo in BPM.

◆ editOriginTime

double AudioPlayHead::CurrentPositionInfo::editOriginTime

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

◆ frameRate

FrameRateType AudioPlayHead::CurrentPositionInfo::frameRate

The video frame rate, if applicable.

◆ isLooping

bool AudioPlayHead::CurrentPositionInfo::isLooping

True if the transport is currently looping.

◆ isPlaying

bool AudioPlayHead::CurrentPositionInfo::isPlaying

True if the transport is currently playing.

◆ isRecording

bool AudioPlayHead::CurrentPositionInfo::isRecording

True if the transport is currently recording.

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

◆ ppqLoopEnd

double AudioPlayHead::CurrentPositionInfo::ppqLoopEnd

The current cycle end position in pulses-per-quarter-note.

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

See also
isLooping

◆ ppqLoopStart

double AudioPlayHead::CurrentPositionInfo::ppqLoopStart

The current cycle start position in pulses-per-quarter-note.

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

See also
isLooping

◆ ppqPosition

double AudioPlayHead::CurrentPositionInfo::ppqPosition

The current play position, in pulses-per-quarter-note.

◆ ppqPositionOfLastBarStart

double AudioPlayHead::CurrentPositionInfo::ppqPositionOfLastBarStart

The position of the start of the last bar, in pulses-per-quarter-note.

This is the time from the start of the edit 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.

◆ timeInSamples

int64 AudioPlayHead::CurrentPositionInfo::timeInSamples

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

◆ timeInSeconds

double AudioPlayHead::CurrentPositionInfo::timeInSeconds

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

◆ timeSigDenominator

int AudioPlayHead::CurrentPositionInfo::timeSigDenominator

Time signature denominator, e.g.

the 4 of a 3/4 time sig

◆ timeSigNumerator

int AudioPlayHead::CurrentPositionInfo::timeSigNumerator

Time signature numerator, e.g.

the 3 of a 3/4 time sig


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