This type is deprecated; prefer PositionInfo instead. More...

#include <juce_AudioPlayHead.h>

Collaboration diagram for juce::AudioPlayHead::CurrentPositionInfo:

[legend]

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.

double	editOriginTime = 0
	For timecode, the position of the start of the timeline, in seconds from 00:00:00:00.

FrameRate	frameRate = FrameRateType::fps23976
	The video frame rate, if applicable.

bool	isLooping = false
	True if the transport is currently looping.

bool	isPlaying = false
	True if the transport is currently playing.

bool	isRecording = false
	True if the transport is currently recording.

double	ppqLoopEnd = 0
	The current cycle end position in units of quarter-notes.

double	ppqLoopStart = 0
	The current cycle start position in units of quarter-notes.

double	ppqPosition = 0
	The current play position, in units of quarter-notes.

double	ppqPositionOfLastBarStart = 0
	The position of the start of the last bar, in units of quarter-notes.

int64	timeInSamples = 0
	The current play position, in samples from the start of the timeline.

double	timeInSeconds = 0
	The current play position, in seconds from the start of the timeline.

int	timeSigDenominator = 4
	Time signature denominator, e.g.

int	timeSigNumerator = 4
	Time signature numerator, e.g.

Detailed Description

This type is deprecated; prefer PositionInfo instead.

Some position info may be unavailable, depending on the host or plugin format. Unfortunately, CurrentPositionInfo doesn't have any way of differentiating between default values and values that have been set explicitly.

Member Function Documentation

◆ operator!=()

bool juce::AudioPlayHead::CurrentPositionInfo::operator!= ( const CurrentPositionInfo & other ) const

inlinenoexcept

◆ operator==()

bool juce::AudioPlayHead::CurrentPositionInfo::operator== ( const CurrentPositionInfo & other ) const

inlinenoexcept

◆ resetToDefault()

void juce::AudioPlayHead::CurrentPositionInfo::resetToDefault ( )

inline

Member Data Documentation

◆ bpm

double juce::AudioPlayHead::CurrentPositionInfo::bpm = 120.0

The tempo in BPM.

◆ editOriginTime

double juce::AudioPlayHead::CurrentPositionInfo::editOriginTime = 0

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

◆ frameRate

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

The video frame rate, if applicable.

◆ isLooping

bool juce::AudioPlayHead::CurrentPositionInfo::isLooping = false

True if the transport is currently looping.

◆ isPlaying

bool juce::AudioPlayHead::CurrentPositionInfo::isPlaying = false

True if the transport is currently playing.

◆ isRecording

bool juce::AudioPlayHead::CurrentPositionInfo::isRecording = false

True if the transport is currently recording.

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

◆ ppqLoopEnd

double juce::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

◆ ppqLoopStart

double juce::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

◆ ppqPosition

double juce::AudioPlayHead::CurrentPositionInfo::ppqPosition = 0

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

◆ ppqPositionOfLastBarStart

double juce::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.

◆ timeInSamples

int64 juce::AudioPlayHead::CurrentPositionInfo::timeInSamples = 0

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

◆ timeInSeconds

double juce::AudioPlayHead::CurrentPositionInfo::timeInSeconds = 0

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

◆ timeSigDenominator

int juce::AudioPlayHead::CurrentPositionInfo::timeSigDenominator = 4

Time signature denominator, e.g.

the 4 of a 3/4 time sig

◆ timeSigNumerator

int juce::AudioPlayHead::CurrentPositionInfo::timeSigNumerator = 4

Time signature numerator, e.g.

the 3 of a 3/4 time sig

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

juce_AudioPlayHead.h

Public Member Functions

Public Attributes