DISTRHO Plugin Framework
Public Member Functions | Public Attributes | List of all members
TimePosition::BarBeatTick Struct Reference

#include <DistrhoDetails.hpp>

Public Member Functions

 BarBeatTick () noexcept
 
void clear () noexcept
 

Public Attributes

bool valid
 
int32_t bar
 
int32_t beat
 
double tick
 
double barStartTick
 
float beatsPerBar
 
float beatType
 
double ticksPerBeat
 
double beatsPerMinute
 

Detailed Description

Bar-Beat-Tick time position.

Constructor & Destructor Documentation

◆ BarBeatTick()

TimePosition::BarBeatTick::BarBeatTick ( )
inlinenoexcept

Default constructor for a null BBT time position.

Member Function Documentation

◆ clear()

void TimePosition::BarBeatTick::clear ( )
inlinenoexcept

Reinitialize this position using the default null initialization.

Member Data Documentation

◆ valid

bool TimePosition::BarBeatTick::valid

Wherever the host transport is using BBT.
If false you must not read from this struct.

◆ bar

int32_t TimePosition::BarBeatTick::bar

Current bar.
Should always be > 0.
The first bar is bar '1'.

◆ beat

int32_t TimePosition::BarBeatTick::beat

Current beat within bar.
Should always be > 0 and <= beatsPerBar.
The first beat is beat '1'.

◆ tick

double TimePosition::BarBeatTick::tick

Current tick within beat.
Should always be >= 0 and < ticksPerBeat.
The first tick is tick '0'.

Note
Fraction part of tick is only available on some plugin formats.

◆ barStartTick

double TimePosition::BarBeatTick::barStartTick

Number of ticks that have elapsed between frame 0 and the first beat of the current measure.

◆ beatsPerBar

float TimePosition::BarBeatTick::beatsPerBar

Time signature "numerator".

◆ beatType

float TimePosition::BarBeatTick::beatType

Time signature "denominator".

◆ ticksPerBeat

double TimePosition::BarBeatTick::ticksPerBeat

Number of ticks within a beat.
Usually a moderately large integer with many denominators, such as 1920.0.

◆ beatsPerMinute

double TimePosition::BarBeatTick::beatsPerMinute

Number of beats per minute.


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