Describes the timecode mode (frame rate and drop-frame status). More...

#include <timecode.h>

Public Member Functions
	Mode ()=default
	Constructs an invalid, default mode.

	Mode (const VtcFormat *format)
	Constructs a mode from a libvtc format pointer.

	Mode (uint32_t fps, uint32_t flags)
	Constructs a mode from a frame rate and flag set.

	Mode (TimecodeType type)
	Constructs a mode from a standard TimecodeType.

bool	operator== (const Mode &other) const

bool	operator!= (const Mode &other) const

uint32_t	fps () const
	Returns the frames-per-second rate, or 0 if no format is set.

bool	isValid () const
	Returns true if this mode has been explicitly set.

bool	isDropFrame () const
	Returns true if this mode uses drop-frame counting.

bool	hasFormat () const
	Returns true if a VtcFormat pointer is assigned.

const VtcFormat *	vtcFormat () const
	Returns the underlying libvtc format pointer.

Detailed Description

Describes the timecode mode (frame rate and drop-frame status).

Wraps a const VtcFormat* from libvtc together with a validity flag.

Constructor & Destructor Documentation

Timecode::Mode::Mode ( const VtcFormat * format )

inline

Constructs a mode from a libvtc format pointer.

Parameters

format Pointer to a VtcFormat, or nullptr for an invalid mode.

inline

Constructs a mode from a frame rate and flag set.

Parameters

fps	Frames per second.
flags	Bitmask of Flags values (e.g. DropFrame).

Timecode::Mode::Mode ( TimecodeType type )

inline

Constructs a mode from a standard TimecodeType.

Parameters

type	One of the TimecodeType enum values.

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