AudioPlayHead::CurrentPositionInfo Struct Reference

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

List of all members.

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

---

Detailed Description

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

---

Member Function Documentation

bool AudioPlayHead::CurrentPositionInfo::operator==

(

const CurrentPositionInfo &

other )

const

bool AudioPlayHead::CurrentPositionInfo::operator!=

(

const CurrentPositionInfo &

other )

const

void AudioPlayHead::CurrentPositionInfo::resetToDefault

(

)

---

Member Data Documentation

double AudioPlayHead::CurrentPositionInfo::bpm

The tempo in BPM.

int AudioPlayHead::CurrentPositionInfo::timeSigNumerator

Time signature numerator, e.g.

the 3 of a 3/4 time sig

int AudioPlayHead::CurrentPositionInfo::timeSigDenominator

Time signature denominator, e.g.

the 4 of a 3/4 time sig

double AudioPlayHead::CurrentPositionInfo::timeInSeconds

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

double AudioPlayHead::CurrentPositionInfo::editOriginTime

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

double AudioPlayHead::CurrentPositionInfo::ppqPosition

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

This is the number of quarter notes since the edit start.

double AudioPlayHead::CurrentPositionInfo::ppqPositionOfLastBarStart

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

This is the number of quarter notes from the start of the edit to the start of the current bar.

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

FrameRateType AudioPlayHead::CurrentPositionInfo::frameRate

The video frame rate, if applicable.

bool AudioPlayHead::CurrentPositionInfo::isPlaying

True if the transport is currently playing.

bool AudioPlayHead::CurrentPositionInfo::isRecording

True if the transport is currently recording.

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

---

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

• juce_AudioPlayHead.h