FBTimeCode Class Reference

TimeCode data structure. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBTimeCode:

Public Member Functions
	FBTimeCode (float pRate=FRAMES_30)
	Constructor.
float	GetRawFrame ()
	Get the raw value for the frame.
float	GetRawRate ()
	Get the raw value for the rate.
float	GetRawSecond ()
	Get the raw value for the second.
FBTime	GetTime ()
	Return a Time corresponding to the timecode.
str	GetTimeCodeString (FBTime::ETimeFormats pFormat=FBTime::eDefaultFormat)
	Get time as a string.
	SetTime (FBTime pTime)
	Set TimeCode according to the given time.
	SetTimeCode (int pHour, int pMinute=0, int pSecond=0, float pFrame=0)
	Set timecode.
	SetTimeCodeString (str pTime, FBTime::ETimeFormats pFormat=FBTime::eDefaultFormat)
	Set time from string.

Public Attributes
float	FILM_23976
	-23.976f
float	FILM_24
	-24.0f
float	FRAMES_11988
	-119.88f
float	FRAMES_30
	-30.0f
float	FRAMES_5994
	-59.94f
float	MPAL_30
	-29.971f Currently not supported : "1" is added just to differentiate from NTSC_FULL(-29.97f)
float	NTSC_DROP
	Rates.
float	NTSC_FULL
	-29.97f
float	PAL_25
	-25.0f

Detailed Description

TimeCode data structure.

See sample: TimeCodeKeying.py.

Constructor & Destructor Documentation

FBTimeCode()

FBTimeCode

(

float

pRate = FRAMES_30

)

Constructor.

Parameters

pRate

Framerate value.

References FRAMES_30.

Member Function Documentation

GetRawFrame()

float GetRawFrame

(

)

Get the raw value for the frame.

Returns

raw value for the frame.

GetRawRate()

float GetRawRate

(

)

Get the raw value for the rate.

Returns

raw value for the rate.

GetRawSecond()

float GetRawSecond

(

)

Get the raw value for the second.

Returns

raw value for the second.

GetTime()

FBTime GetTime

(

)

Return a Time corresponding to the timecode.

GetTimeCodeString()

str GetTimeCodeString

(

FBTime::ETimeFormats

pFormat = FBTime::eDefaultFormat

)

Get time as a string.

Parameters

pFormat

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

Returns

String value of time.

SetTime()

SetTime

(

FBTime

pTime

)

Set TimeCode according to the given time.

Parameters

pTime

Time value to set.

SetTimeCode()

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

Set timecode.

Parameters

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

SetTimeCodeString()

SetTimeCodeString	(	str	pTime,
		FBTime::ETimeFormats	pFormat = FBTime::eDefaultFormat )

Set time from string.

Parameters

pTime	String to set time from.
pFormat	Format to use for the string(default=FBTime::eDefaultFormat).

Member Data Documentation

FILM_23976

float FILM_23976

-23.976f

FILM_24

float FILM_24

-24.0f

FRAMES_11988

float FRAMES_11988

-119.88f

FRAMES_30

float FRAMES_30

-30.0f

Referenced by FBTimeCode().

FRAMES_5994

float FRAMES_5994

-59.94f

MPAL_30

float MPAL_30

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

NTSC_DROP

float NTSC_DROP

Rates.

NTSC_FULL

float NTSC_FULL

-29.97f

PAL_25

float PAL_25

-25.0f