Time::FrameRate Class Reference

#include <FrameRate.h>

Classes
struct	FrameRateConfiguration
struct	StandardFrameRates

Public Member Functions
	FrameRate ()
	FrameRate (double fps)
	FrameRate (double fps, bool drop)
	FrameRate (juce::ValueTree valueTree)
	FrameRate (FrameRate::FrameRateConfiguration config)
int	getNominalFrameRate ()
double	getTrueFrameRate ()
bool	isDropFrame ()
int	getDroppdFramesPerMinute ()
juce::String	toString ()
juce::ValueTree	getValueTree ()

Static Public Member Functions
static juce::Identifier	getFrameRateValueTreeID ()

Private Member Functions
void	calculateFromDouble (double fps, bool isDrop)
void	fromValueTree (juce::ValueTree tree)

Private Attributes
juce::Identifier	frameRateValueTreeID = "FrameRate"
juce::Identifier	nominalFrameRateID = "nominalFrameRate"
juce::Identifier	trueFrameRateID = "trueFrameRate"
juce::Identifier	isDropID = "isDrop"
juce::Identifier	numDroppedFramesID = "numFramesPerDrop"
double	trueFR
int	nominalFR
bool	drop
int	numDroppedFrames

Detailed Description

Class for storing frame rate information used for Timecode generation

Constructor & Destructor Documentation

FrameRate() [1/5]

Time::FrameRate::FrameRate ( )

inline

Creates an invalid FrameRate

FrameRate() [2/5]

Time::FrameRate::FrameRate ( double fps )

inline

Create a FrameRate from double, assuming non-drop

FrameRate() [3/5]

Time::FrameRate::FrameRate ( double fps, bool drop )

inline

Create a FrameRate from double and specify drop frame

FrameRate() [4/5]

Time::FrameRate::FrameRate ( juce::ValueTree valueTree )

inline

Restore FrameRate from a juce::ValueTree

FrameRate() [5/5]

Time::FrameRate::FrameRate ( FrameRate::FrameRateConfiguration config )

inline

Create a FrameRate from FrameRateConfiguration. Useful for standard frame rates.

Member Function Documentation

calculateFromDouble()

void Time::FrameRate::calculateFromDouble ( double fps, bool isDrop )

inlineprivate

fromValueTree()

void Time::FrameRate::fromValueTree ( juce::ValueTree tree )

inlineprivate

getDroppdFramesPerMinute()

int Time::FrameRate::getDroppdFramesPerMinute ( )

inline

Returns the number of frames dropped per minute of timecode.

getFrameRateValueTreeID()

juce::Identifier Time::FrameRate::getFrameRateValueTreeID ( )

inlinestatic

getNominalFrameRate()

int Time::FrameRate::getNominalFrameRate ( )

inline

Returns frequency of frame rate rounded up to the nearest integer.

getTrueFrameRate()

double Time::FrameRate::getTrueFrameRate ( )

inline

Returns actual playback frequency.

getValueTree()

juce::ValueTree Time::FrameRate::getValueTree ( )

inline

Returns juce::ValueTree used to store this FrameRate's data for restoring later or storing inside another juce::ValueTree

isDropFrame()

bool Time::FrameRate::isDropFrame ( )

inline

Returns true if drop frame is used.

toString()

juce::String Time::FrameRate::toString ( )

inline

Outputs a juce::String representation of this FrameRate.

Member Data Documentation

drop

bool Time::FrameRate::drop

private

frameRateValueTreeID

juce::Identifier Time::FrameRate::frameRateValueTreeID = "FrameRate"

private

isDropID

juce::Identifier Time::FrameRate::isDropID = "isDrop"

private

nominalFR

int Time::FrameRate::nominalFR

private

nominalFrameRateID

juce::Identifier Time::FrameRate::nominalFrameRateID = "nominalFrameRate"

private

numDroppedFrames

int Time::FrameRate::numDroppedFrames

private

numDroppedFramesID

juce::Identifier Time::FrameRate::numDroppedFramesID = "numFramesPerDrop"

private

trueFR

double Time::FrameRate::trueFR

private

trueFrameRateID

juce::Identifier Time::FrameRate::trueFrameRateID = "trueFrameRate"

private

---

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

• /Users/cliftonmarien/Documents/Photosine/Photosine/Source/Time/FrameRate.h