FBTimeCode Class Reference


Detailed Description

TimeCode data structure.

Examples
Tasks/TimeCodeKeying.py

List of all members.

Public Member Functions

 __init__ (float pRate=NTSC_DROP)
 Constructor.
 SetTimeCode (int pHour, int pMinute=0, int pSecond=0, float pFrame=0)
 Set timecode.
str GetTimeCodeString (FBTime.ETimeFormats pFormat=FBTime::eDefaultFormat)
 Get time as a string.
 SetTimeCodeString (str pTime)
 Set time from string.
FBTime GetTime ()
 Return a Time corresponding to the timecode.
 SetTime (FBTime pTime)
 Set TimeCode according to the given time.
float GetFrame ()
 Return a frame number corresponding to the timecode.
 SetFrame (float pFrame)
 Set Frame according to the given time.
float GetFrameRate ()
 Return the rate of the timecode.
float GetRawSecond ()
 Get the raw value for the second.
float GetRawFrame ()
 Get the raw value for the frame.
float GetRawRate ()
 Get the raw value for the rate.
bool operator== (FBTimeCode pTimeCode)
 Equality operator.
bool operator!= (FBTimeCode pTimeCode)
 Inequality operator.

Public Attributes

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

Member Function Documentation

__init__ ( float  pRate = NTSC_DROP)

Constructor.

Parameters:
pRateFramerate value.
Examples
Tasks/TimeCodeKeying.py
SetTimeCode ( int  pHour,
int  pMinute = 0,
int  pSecond = 0,
float  pFrame = 0 
)

Set timecode.

Parameters:
pHourHour value.
pMinuteMinute value.
pSecondSecond value.
pFrameFrame value.
str GetTimeCodeString ( FBTime.ETimeFormats  pFormat = FBTime::eDefaultFormat)

Get time as a string.

Parameters:
pFormatFormat to use for the returned string(default=FBTime::eDefaultFormat).
Returns:
String value of time.
SetTimeCodeString ( str  pTime)

Set time from string.

Parameters:
pTimeString to set time from.
FBTime GetTime ( )

Return a Time corresponding to the timecode.

SetTime ( FBTime  pTime)

Set TimeCode according to the given time.

Parameters:
pTimeTime value to set.
float GetFrame ( )

Return a frame number corresponding to the timecode.

SetFrame ( float  pFrame)

Set Frame according to the given time.

Parameters:
pFrameFrame value to set.
float GetFrameRate ( )

Return the rate of the timecode.

float GetRawSecond ( )

Get the raw value for the second.

Returns:
raw value for the second.
float GetRawFrame ( )

Get the raw value for the frame.

Returns:
raw value for the frame.
float GetRawRate ( )

Get the raw value for the rate.

Returns:
raw value for the rate.
bool operator== ( FBTimeCode  pTimeCode)

Equality operator.

Parameters:
pTimeCodetime code to compare with.
Returns:
true if time codes are equal.
bool operator!= ( FBTimeCode  pTimeCode)

Inequality operator.

Parameters:
pTimeCodetime code to compare with.
Returns:
true if time codes are not equal.

Member Data Documentation

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


FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode
FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode FBTimeCode