tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
tracktion::engine::TimecodeSnapType Struct Reference

A snap mode, e.g. More...

#include "tracktion_TimecodeDisplayFormat.h"

Public Member Functions

 TimecodeSnapType (TimecodeType t, int lev) noexcept
 
juce::String getDescription (const TempoSetting &, bool isTripletOverride) const
 
TimeDuration getApproxIntervalTime (const TempoSetting &) const
 
TimeDuration getApproxIntervalTime (const TempoSetting &, bool isTripletsOverride) const
 Similar to above expect that the isTripletsOverride argument is used instead of the tempo owner sequence.
 
juce::String getTimecodeString (TimePosition time, const TempoSequence &, bool useStartLabelIfZero) const
 
TimePosition roundTimeDown (TimePosition, const TempoSequence &) const
 
TimePosition roundTimeDown (TimePosition, const TempoSequence &, bool isTripletsOverride) const
 
TimePosition roundTimeNearest (TimePosition, const TempoSequence &) const
 
TimePosition roundTimeNearest (TimePosition, const TempoSequence &, bool isTripletsOverride) const
 
TimePosition roundTimeUp (TimePosition, const TempoSequence &) const
 
TimePosition roundTimeUp (TimePosition, const TempoSequence &, bool tripletsOverride) const
 
int getLevel () const noexcept
 
int getOneBarLevel () const noexcept
 
TimecodeSnapType getSnapTypeForMaximumSnapLevelOf (TimePosition, const TempoSequence &) const
 
TimecodeSnapType getSnapTypeForMaximumSnapLevelOf (TimePosition, const TempoSequence &, bool isTripletsOverride) const
 

Static Public Member Functions

static TimecodeSnapType get1BeatSnapType ()
 

Public Attributes

TimecodeType type
 
int level
 

Detailed Description

A snap mode, e.g.

"nearest beat". A list of available types is returned from methods in TimecodeDisplayFormat

Definition at line 32 of file tracktion_TimecodeDisplayFormat.h.

Constructor & Destructor Documentation

◆ TimecodeSnapType()

tracktion::engine::TimecodeSnapType::TimecodeSnapType ( TimecodeType  t,
int  lev 
)
noexcept

Definition at line 37 of file tracktion_TimecodeDisplayFormat.h.

Member Function Documentation

◆ get1BeatSnapType()

TimecodeSnapType tracktion::engine::TimecodeSnapType::get1BeatSnapType ( )
static

Definition at line 340 of file tracktion_TimecodeDisplayFormat.cpp.

◆ getApproxIntervalTime() [1/2]

TimeDuration tracktion::engine::TimecodeSnapType::getApproxIntervalTime ( const TempoSetting &  tempo) const

Definition at line 150 of file tracktion_TimecodeDisplayFormat.cpp.

◆ getApproxIntervalTime() [2/2]

TimeDuration tracktion::engine::TimecodeSnapType::getApproxIntervalTime ( const TempoSetting &  tempo,
bool  isTripletsOverride 
) const

Similar to above expect that the isTripletsOverride argument is used instead of the tempo owner sequence.

Definition at line 155 of file tracktion_TimecodeDisplayFormat.cpp.

◆ getDescription()

juce::String tracktion::engine::TimecodeSnapType::getDescription ( const TempoSetting &  tempo,
bool  isTripletOverride 
) const

Definition at line 124 of file tracktion_TimecodeDisplayFormat.cpp.

◆ getLevel()

int tracktion::engine::TimecodeSnapType::getLevel ( ) const
noexcept

Definition at line 58 of file tracktion_TimecodeDisplayFormat.h.

◆ getOneBarLevel()

int tracktion::engine::TimecodeSnapType::getOneBarLevel ( ) const
noexcept

Definition at line 241 of file tracktion_TimecodeDisplayFormat.cpp.

◆ getSnapTypeForMaximumSnapLevelOf() [1/2]

TimecodeSnapType tracktion::engine::TimecodeSnapType::getSnapTypeForMaximumSnapLevelOf ( TimePosition  t,
const TempoSequence &  sequence 
) const

Definition at line 315 of file tracktion_TimecodeDisplayFormat.cpp.

◆ getSnapTypeForMaximumSnapLevelOf() [2/2]

TimecodeSnapType tracktion::engine::TimecodeSnapType::getSnapTypeForMaximumSnapLevelOf ( TimePosition  t,
const TempoSequence &  sequence,
bool  isTripletsOverride 
) const

Definition at line 320 of file tracktion_TimecodeDisplayFormat.cpp.

◆ getTimecodeString()

juce::String tracktion::engine::TimecodeSnapType::getTimecodeString ( TimePosition  time,
const TempoSequence &  sequence,
bool  useStartLabelIfZero 
) const

Definition at line 198 of file tracktion_TimecodeDisplayFormat.cpp.

◆ roundTimeDown() [1/2]

TimePosition tracktion::engine::TimecodeSnapType::roundTimeDown ( TimePosition  t,
const TempoSequence &  sequence 
) const

Definition at line 246 of file tracktion_TimecodeDisplayFormat.cpp.

◆ roundTimeDown() [2/2]

TimePosition tracktion::engine::TimecodeSnapType::roundTimeDown ( TimePosition  t,
const TempoSequence &  sequence,
bool  isTripletsOverride 
) const

Definition at line 251 of file tracktion_TimecodeDisplayFormat.cpp.

◆ roundTimeNearest() [1/2]

TimePosition tracktion::engine::TimecodeSnapType::roundTimeNearest ( TimePosition  t,
const TempoSequence &  sequence 
) const

Definition at line 256 of file tracktion_TimecodeDisplayFormat.cpp.

◆ roundTimeNearest() [2/2]

TimePosition tracktion::engine::TimecodeSnapType::roundTimeNearest ( TimePosition  t,
const TempoSequence &  sequence,
bool  isTripletsOverride 
) const

Definition at line 261 of file tracktion_TimecodeDisplayFormat.cpp.

◆ roundTimeUp() [1/2]

TimePosition tracktion::engine::TimecodeSnapType::roundTimeUp ( TimePosition  t,
const TempoSequence &  sequence 
) const

Definition at line 266 of file tracktion_TimecodeDisplayFormat.cpp.

◆ roundTimeUp() [2/2]

TimePosition tracktion::engine::TimecodeSnapType::roundTimeUp ( TimePosition  t,
const TempoSequence &  sequence,
bool  tripletsOverride 
) const

Definition at line 271 of file tracktion_TimecodeDisplayFormat.cpp.

Member Data Documentation

◆ level

int tracktion::engine::TimecodeSnapType::level

Definition at line 69 of file tracktion_TimecodeDisplayFormat.h.

◆ type

TimecodeType tracktion::engine::TimecodeSnapType::type

Definition at line 68 of file tracktion_TimecodeDisplayFormat.h.

The documentation for this struct was generated from the following files:
« « « Anklang Documentation