tracktion::engine::TimecodeDisplayFormat Struct Reference

A timecode display mode, e.g. More...

#include <tracktion_TimecodeDisplayFormat.h>

Public Member Functions
	TimecodeDisplayFormat () noexcept
	TimecodeDisplayFormat (TimecodeType t) noexcept
bool	operator== (const TimecodeDisplayFormat &other) const
bool	operator!= (const TimecodeDisplayFormat &other) const
bool	isBarsBeats () const
bool	isMilliseconds () const
bool	isSMPTE () const
int	getFPS () const
juce::String	getRoundingDescription () const
juce::String	getString (const TempoSequence &, TimePosition, bool isRelative) const
juce::String	getStartLabel () const
int	getNumParts () const
	number of sections in the timecode string
juce::String	getSeparator (int part) const
int	getMaxCharsInPart (int part, bool canBeNegative) const
int	getMaxValueOfPart (const TempoSequence &, TimecodeDuration currentTime, int part, bool isRelative) const
int	getMinValueOfPart (int part, bool isRelative) const
void	getPartStrings (TimecodeDuration duration, const TempoSequence &, bool isRelative, juce::String results[4]) const
TimecodeDuration	getNewTimeWithPartValue (TimecodeDuration oldTime, const TempoSequence &, int part, int newValue, bool isRelative) const
TimecodeSnapType	getBestSnapType (const TempoSetting &, TimeDuration onScreenTimePerPixel, bool isTripletOverride) const
int	getNumSnapTypes () const
TimecodeSnapType	getSnapType (int index) const
int	getSubSecondDivisions () const

Static Public Member Functions
static juce::String	toFullTimecode (TimePosition, const int subSecondDivisions=1000, bool showHours=false)
	this will format the time as "hh:mm:ss.xxx".

Public Attributes
TimecodeType	type

Detailed Description

A timecode display mode, e.g.

bars/beats, seconds/frames, etc.

Constructor & Destructor Documentation

TimecodeDisplayFormat() [1/2]

tracktion::engine::TimecodeDisplayFormat::TimecodeDisplayFormat ( )

noexcept

TimecodeDisplayFormat() [2/2]

tracktion::engine::TimecodeDisplayFormat::TimecodeDisplayFormat ( TimecodeType  t )

noexcept

Member Function Documentation

operator==()

bool tracktion::engine::TimecodeDisplayFormat::operator==

(

const TimecodeDisplayFormat &

other

)

const

References type.

operator!=()

bool tracktion::engine::TimecodeDisplayFormat::operator!=

(

const TimecodeDisplayFormat &

other

)

const

References type.

isBarsBeats()

bool tracktion::engine::TimecodeDisplayFormat::isBarsBeats

(

)

const

isMilliseconds()

bool tracktion::engine::TimecodeDisplayFormat::isMilliseconds

(

)

const

isSMPTE()

bool tracktion::engine::TimecodeDisplayFormat::isSMPTE

(

)

const

getFPS()

int tracktion::engine::TimecodeDisplayFormat::getFPS

(

)

const

getRoundingDescription()

juce::String tracktion::engine::TimecodeDisplayFormat::getRoundingDescription

(

)

const

getString()

juce::String tracktion::engine::TimecodeDisplayFormat::getString	(	const TempoSequence &	,
		TimePosition	,
		bool	isRelative
	)		const

getStartLabel()

juce::String tracktion::engine::TimecodeDisplayFormat::getStartLabel

(

)

const

getNumParts()

int tracktion::engine::TimecodeDisplayFormat::getNumParts

(

)

const

number of sections in the timecode string

getSeparator()

juce::String tracktion::engine::TimecodeDisplayFormat::getSeparator

(

int

part

)

const

getMaxCharsInPart()

int tracktion::engine::TimecodeDisplayFormat::getMaxCharsInPart	(	int	part,
		bool	canBeNegative
	)		const

getMaxValueOfPart()

int tracktion::engine::TimecodeDisplayFormat::getMaxValueOfPart	(	const TempoSequence &	,
		TimecodeDuration	currentTime,
		int	part,
		bool	isRelative
	)		const

getMinValueOfPart()

int tracktion::engine::TimecodeDisplayFormat::getMinValueOfPart	(	int	part,
		bool	isRelative
	)		const

getPartStrings()

void tracktion::engine::TimecodeDisplayFormat::getPartStrings	(	TimecodeDuration	duration,
		const TempoSequence &	,
		bool	isRelative,
		juce::String	results[4]
	)		const

getNewTimeWithPartValue()

TimecodeDuration tracktion::engine::TimecodeDisplayFormat::getNewTimeWithPartValue	(	TimecodeDuration	oldTime,
		const TempoSequence &	,
		int	part,
		int	newValue,
		bool	isRelative
	)		const

getBestSnapType()

TimecodeSnapType tracktion::engine::TimecodeDisplayFormat::getBestSnapType	(	const TempoSetting &	,
		TimeDuration	onScreenTimePerPixel,
		bool	isTripletOverride
	)		const

getNumSnapTypes()

int tracktion::engine::TimecodeDisplayFormat::getNumSnapTypes

(

)

const

getSnapType()

TimecodeSnapType tracktion::engine::TimecodeDisplayFormat::getSnapType

(

int

index

)

const

getSubSecondDivisions()

int tracktion::engine::TimecodeDisplayFormat::getSubSecondDivisions

(

)

const

toFullTimecode()

static juce::String tracktion::engine::TimecodeDisplayFormat::toFullTimecode ( TimePosition  , const int  subSecondDivisions = 1000, bool  showHours = false  )

static

this will format the time as "hh:mm:ss.xxx".

The xxx depends on the subSecondDivisor value - e.g. 1000 will show xxx as milliseconds, if subSecondDivisor is 25 xxx will be 0 to 24 (for frames). If subSecondDivisor is 0, no sub-second portion will be produced.

Member Data Documentation

type

TimecodeType tracktion::engine::TimecodeDisplayFormat::type

Referenced by operator!=(), and operator==().

---

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

• tracktion_TimecodeDisplayFormat.h