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

#include "juce_AudioPlayHead.h"

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.

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

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

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

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

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

FrameRate	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.

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

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

bool	isLooping
	True if the transport is currently looping.

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.

Definition at line 210 of file juce_AudioPlayHead.h.

Member Function Documentation

◆ operator!=()

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

noexcept

Definition at line 292 of file juce_AudioPlayHead.h.

◆ operator==()

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

noexcept

Definition at line 270 of file juce_AudioPlayHead.h.

◆ resetToDefault()

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

Definition at line 297 of file juce_AudioPlayHead.h.

Member Data Documentation

◆ bpm

double juce::AudioPlayHead::CurrentPositionInfo::bpm

The tempo in BPM.

Definition at line 213 of file juce_AudioPlayHead.h.

◆ editOriginTime

double juce::AudioPlayHead::CurrentPositionInfo::editOriginTime

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

Definition at line 227 of file juce_AudioPlayHead.h.

◆ frameRate

FrameRate juce::AudioPlayHead::CurrentPositionInfo::frameRate

The video frame rate, if applicable.

Definition at line 243 of file juce_AudioPlayHead.h.

◆ isLooping

bool juce::AudioPlayHead::CurrentPositionInfo::isLooping

True if the transport is currently looping.

Definition at line 267 of file juce_AudioPlayHead.h.

◆ isPlaying

bool juce::AudioPlayHead::CurrentPositionInfo::isPlaying

True if the transport is currently playing.

Definition at line 246 of file juce_AudioPlayHead.h.

◆ isRecording

bool juce::AudioPlayHead::CurrentPositionInfo::isRecording

True if the transport is currently recording.

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

Definition at line 252 of file juce_AudioPlayHead.h.

◆ ppqLoopEnd

double juce::AudioPlayHead::CurrentPositionInfo::ppqLoopEnd

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

Definition at line 264 of file juce_AudioPlayHead.h.

◆ ppqLoopStart

double juce::AudioPlayHead::CurrentPositionInfo::ppqLoopStart

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

Definition at line 258 of file juce_AudioPlayHead.h.

◆ ppqPosition

double juce::AudioPlayHead::CurrentPositionInfo::ppqPosition

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

Definition at line 230 of file juce_AudioPlayHead.h.

◆ ppqPositionOfLastBarStart

double juce::AudioPlayHead::CurrentPositionInfo::ppqPositionOfLastBarStart

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.

Definition at line 240 of file juce_AudioPlayHead.h.

◆ timeInSamples

int64 juce::AudioPlayHead::CurrentPositionInfo::timeInSamples

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

Definition at line 222 of file juce_AudioPlayHead.h.

◆ timeInSeconds

double juce::AudioPlayHead::CurrentPositionInfo::timeInSeconds

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

Definition at line 224 of file juce_AudioPlayHead.h.

◆ timeSigDenominator

int juce::AudioPlayHead::CurrentPositionInfo::timeSigDenominator

Time signature denominator, e.g.

the 4 of a 3/4 time sig

Definition at line 219 of file juce_AudioPlayHead.h.

◆ timeSigNumerator

int juce::AudioPlayHead::CurrentPositionInfo::timeSigNumerator

Time signature numerator, e.g.

the 3 of a 3/4 time sig

Definition at line 216 of file juce_AudioPlayHead.h.

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

juce_audio_basics/audio_play_head/juce_AudioPlayHead.h

Public Member Functions

Public Attributes