FBTimeCode Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2013.

---

Search for all occurrences

---

Detailed Description

TimeCode data structure.

Definition at line 280 of file fbtime.h.

#include <fbtime.h>

List of all members.

Public Member Functions
	FBTimeCode (float pRate=NTSC_DROP)
	Constructor.
void	SetTimeCode (int pHour, int pMinute=0, int pSecond=0, float pFrame=0)
	Set timecode.
FBString	GetTimeCodeString (FBTime::ETimeFormats pFormat=FBTime::eDefaultFormat)
	Get time as a string.
void	SetTimeCodeString (const char *pTime)
	Set time from string.
FBTime	GetTime () const
	Return a Time corresponding to the timecode.
void	SetTime (FBTime pTime)
	Set TimeCode according to the given time.
double	GetFrame () const
	Return a frame number corresponding to the timecode.
void	SetFrame (double pFrame)
	Set Frame according to the given time.
float	GetFrameRate () const
	Return the rate of the timecode.
Static Public Attributes
static const float	NTSC_DROP
	Rates.
static const float	NTSC_FULL
	-29.97f
static const float	PAL_25
	-25.0f
static const float	MPAL_30
	-29.971f Currently not supported : "1" is added just to differentiate from NTSC_FULL(-29.97f)
static const float	FILM_24
	-24.0f
static const float	FILM_23976
	-23.976f
static const float	FRAMES_30
	-30.0f
static const float	FRAMES_5994
	-59.94f

---

Constructor & Destructor Documentation

FBTimeCode

(

float

pRate = NTSC_DROP

)

Constructor.

Parameters:

pRate

Framerate value.

---

Member Function Documentation

void SetTimeCode	(	int	pHour,
		int	pMinute = 0,
		int	pSecond = 0,
		float	pFrame = 0
	)

Search for all occurrences

Set timecode.

Parameters:

pHour	Hour value.
pMinute	Minute value.
pSecond	Second value.
pFrame	Frame value.

FBString GetTimeCodeString

(

FBTime::ETimeFormats

pFormat = FBTime::eDefaultFormat

)

Search for all occurrences

Get time as a string.

Parameters:

pFormat

Format to use for the returned string(default=FBTime::eDefaultFormat).

Returns:

String value of time.

void SetTimeCodeString

(

const char *

pTime

)

Search for all occurrences

Set time from string.

Parameters:

pTime

String to set time from.

FBTime GetTime

(

)

const

Search for all occurrences

Return a Time corresponding to the timecode.

void SetTime

(

FBTime

pTime

)

Search for all occurrences

Set TimeCode according to the given time.

Parameters:

pTime

Time value to set.

double GetFrame

(

)

const

Search for all occurrences

Return a frame number corresponding to the timecode.

void SetFrame

(

double

pFrame

)

Search for all occurrences

Set Frame according to the given time.

Parameters:

pFrame

Frame value to set.

float GetFrameRate

(

)

const

Search for all occurrences

Return the rate of the timecode.

---

Member Data Documentation

const float NTSC_DROP [static]

Search for all occurrences

Rates.

29.97f

Definition at line 335 of file fbtime.h.

const float NTSC_FULL [static]

Search for all occurrences

-29.97f

Definition at line 336 of file fbtime.h.

const float PAL_25 [static]

Search for all occurrences

-25.0f

Definition at line 337 of file fbtime.h.

const float MPAL_30 [static]

Search for all occurrences

-29.971f Currently not supported : "1" is added just to differentiate from NTSC_FULL(-29.97f)

Definition at line 338 of file fbtime.h.

const float FILM_24 [static]

Search for all occurrences

-24.0f

Definition at line 339 of file fbtime.h.

const float FILM_23976 [static]

Search for all occurrences

-23.976f

Definition at line 340 of file fbtime.h.

const float FRAMES_30 [static]

Search for all occurrences

-30.0f

Definition at line 341 of file fbtime.h.

const float FRAMES_5994 [static]

Search for all occurrences

-59.94f

Definition at line 342 of file fbtime.h.

---

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

• fbsdk/fbtime.h