FBTimeCode Class Reference
 
 
 
FBTimeCode Class Reference

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


#include <mobu-python-api.h>


Class Description

TimeCode data structure.

Public Member Functions

def  __reduce__ ()
def  GetTime ()
def  __init__ ()
def  SetTimeCode ()
def  GetTimeCodeString ()
def  SetTime ()
def  GetRawSecond ()
def  GetRawFrame ()
def  GetRawRate ()
def  __ne__ ()
def  __eq__ ()

Public Attributes

object  TimeCodeString
double  Frame
object  FrameRate

Member Function Documentation

def __reduce__ ( )
def GetTime ( )

Python Docstring:

GetTime( (FBTimeCode)arg1) -> FBTime 

C++ Signature:

FBTime GetTime() 

Return a Time corresponding to the timecode.

def __init__ ( )

Python Docstring:

__init__( (object)arg1) -> None

__init__( (object)arg1 [, (float)arg2]) -> None

__init__( (object)arg1, (FBTimeCode)arg2) -> None 

C++ Signature:

 FBTimeCode(float pRate = NTSC_DROP) 

Constructor.

Parameters:
pRate Framerate value.
def SetTimeCode ( )

Python Docstring:

SetTimeCode( (FBTimeCode)arg1, (object)arg2 [, (object)arg3 [, (object)arg4 [, (float)arg5]]]) -> None 

C++ Signature:

void 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.
def GetTimeCodeString ( )

Python Docstring:

GetTimeCodeString( (FBTimeCode)arg1 [, (ETimeFormats)arg2]) -> str 

C++ Signature:

FBString GetTimeCodeString(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.
def SetTime ( )

Python Docstring:

SetTime( (FBTimeCode)arg1, (FBTime)arg2) -> None 

C++ Signature:

void SetTime(FBTime pTime) 

Set TimeCode according to the given time.

Parameters:
pTime Time value to set.
def GetRawSecond ( )

Python Docstring:

GetRawSecond( (FBTimeCode)arg1) -> float 

C++ Signature:

double GetRawSecond() 

Get the raw value for the second.

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

Python Docstring:

GetRawFrame( (FBTimeCode)arg1) -> float 

C++ Signature:

double GetRawFrame() 

Get the raw value for the frame.

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

Python Docstring:

GetRawRate( (FBTimeCode)arg1) -> float 

C++ Signature:

double GetRawRate() 

Get the raw value for the rate.

Returns:
raw value for the rate.
def __ne__ ( )

Python Docstring:

__ne__( (FBTimeCode)arg1, (FBTimeCode)arg2) -> object 
def __eq__ ( )

Python Docstring:

__eq__( (FBTimeCode)arg1, (FBTimeCode)arg2) -> object 

Member Data Documentation

double Frame

in HH:MM:SS:FF.ff, it correspond to FF.ff