tracktion::engine::TimecodeSnapType Struct Reference

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

#include <tracktion_TimecodeDisplayFormat.h>

Public Member Functions
	TimecodeSnapType () noexcept=default
	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 = TimecodeType::millisecs
int	level = 0

Detailed Description

A snap mode, e.g.

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

Constructor & Destructor Documentation

TimecodeSnapType() [1/2]

tracktion::engine::TimecodeSnapType::TimecodeSnapType ( )

defaultnoexcept

TimecodeSnapType() [2/2]

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

noexcept

Member Function Documentation

getDescription()

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

getApproxIntervalTime() [1/2]

TimeDuration tracktion::engine::TimecodeSnapType::getApproxIntervalTime

(

const TempoSetting &

)

const

getApproxIntervalTime() [2/2]

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

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

getTimecodeString()

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

roundTimeDown() [1/2]

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

roundTimeDown() [2/2]

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

roundTimeNearest() [1/2]

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

roundTimeNearest() [2/2]

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

roundTimeUp() [1/2]

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

roundTimeUp() [2/2]

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

getLevel()

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

noexcept

References level.

getOneBarLevel()

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

noexcept

getSnapTypeForMaximumSnapLevelOf() [1/2]

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

getSnapTypeForMaximumSnapLevelOf() [2/2]

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

get1BeatSnapType()

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

static

Member Data Documentation

type

TimecodeType tracktion::engine::TimecodeSnapType::type = TimecodeType::millisecs

level

int tracktion::engine::TimecodeSnapType::level = 0

Referenced by getLevel().

---

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

• tracktion_TimecodeDisplayFormat.h