Public Member Functions | List of all members
AudioPlayHead::FrameRate Class Reference

More descriptive frame rate type. More...

Public Member Functions

 FrameRate ()=default
 Creates a frame rate with a base rate of 0. More...
 
 FrameRate (FrameRateType type)
 Creates a FrameRate instance from a FrameRateType. More...
 
FrameRateType getType () const
 Gets the FrameRateType that matches the state of this FrameRate. More...
 
int getBaseRate () const
 Returns the plain rate, without taking pulldown into account. More...
 
bool isDrop () const
 Returns true if drop-frame timecode is in use. More...
 
bool isPullDown () const
 Returns true if the effective framerate is actually equal to the base rate divided by 1.001. More...
 
double getEffectiveRate () const
 Returns the actual rate described by this object, taking pulldown into account. More...
 
FrameRate withBaseRate (int x) const
 Returns a copy of this object with the specified base rate. More...
 
FrameRate withDrop (bool x=true) const
 Returns a copy of this object with drop frames enabled or disabled, as specified. More...
 
FrameRate withPullDown (bool x=true) const
 Returns a copy of this object with pulldown enabled or disabled, as specified. More...
 
bool operator== (const FrameRate &other) const
 Returns true if this instance is equal to other. More...
 
bool operator!= (const FrameRate &other) const
 Returns true if this instance is not equal to other. More...
 

Detailed Description

More descriptive frame rate type.

Constructor & Destructor Documentation

◆ FrameRate() [1/2]

AudioPlayHead::FrameRate::FrameRate ( )
default

Creates a frame rate with a base rate of 0.

◆ FrameRate() [2/2]

AudioPlayHead::FrameRate::FrameRate ( FrameRateType  type)

Creates a FrameRate instance from a FrameRateType.

Member Function Documentation

◆ getType()

FrameRateType AudioPlayHead::FrameRate::getType ( ) const

Gets the FrameRateType that matches the state of this FrameRate.

Returns fpsUnknown if this FrameRate cannot be represented by any of the other enum fields.

◆ getBaseRate()

int AudioPlayHead::FrameRate::getBaseRate ( ) const

Returns the plain rate, without taking pulldown into account.

◆ isDrop()

bool AudioPlayHead::FrameRate::isDrop ( ) const

Returns true if drop-frame timecode is in use.

◆ isPullDown()

bool AudioPlayHead::FrameRate::isPullDown ( ) const

Returns true if the effective framerate is actually equal to the base rate divided by 1.001.

◆ getEffectiveRate()

double AudioPlayHead::FrameRate::getEffectiveRate ( ) const

Returns the actual rate described by this object, taking pulldown into account.

◆ withBaseRate()

FrameRate AudioPlayHead::FrameRate::withBaseRate ( int  x) const

Returns a copy of this object with the specified base rate.

References gl::x.

◆ withDrop()

FrameRate AudioPlayHead::FrameRate::withDrop ( bool  x = true) const

Returns a copy of this object with drop frames enabled or disabled, as specified.

References gl::x.

◆ withPullDown()

FrameRate AudioPlayHead::FrameRate::withPullDown ( bool  x = true) const

Returns a copy of this object with pulldown enabled or disabled, as specified.

References gl::x.

◆ operator==()

bool AudioPlayHead::FrameRate::operator== ( const FrameRate other) const

Returns true if this instance is equal to other.

References gl::x.

◆ operator!=()

bool AudioPlayHead::FrameRate::operator!= ( const FrameRate other) const

Returns true if this instance is not equal to other.


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