FBTimeCode Class Reference

#include <mobu-python-api.h>

Class Description

TimeCode data structure.

See the C++ reference

Inheritance diagram for FBTimeCode:

Public Member Functions
	__reduce__ ()
FBTime	GetTime (FBTimeCode arg1)
	Return a Time corresponding to the timecode. More...
	__init__ (...)
	Constructor. More...
	SetTimeCode (FBTimeCode arg1, object arg2, object arg3, object arg4, float arg5)
	Set timecode. More...
str	GetTimeCodeString (FBTimeCode arg1, ETimeFormats arg2)
	Get time as a string. More...
	SetTimeCodeString (FBTimeCode arg1, str arg2, ETimeFormats arg3)
	Set time from string. More...
	SetTime (FBTimeCode arg1, FBTime arg2)
	Set TimeCode according to the given time. More...
float	GetRawSecond (FBTimeCode arg1)
	Get the raw value for the second. More...
float	GetRawFrame (FBTimeCode arg1)
	Get the raw value for the frame. More...
float	GetRawRate (FBTimeCode arg1)
	Get the raw value for the rate. More...
object	__ne__ (FBTimeCode arg1, FBTimeCode arg2)
object	__eq__ (FBTimeCode arg1, FBTimeCode arg2)

Public Attributes
object	TimeCodeString
double	Frame
	in HH:MM:SS:FF.ff, it correspond to FF.ff More...
object	FrameRate

Member Function Documentation

object __eq__	(	FBTimeCode	arg1,
		FBTimeCode	arg2
	)

Python Docstring:

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

__init__

(

...

)

Constructor.

Python Docstring:

__init__( (object)arg1) -> None

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

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

C++ Signature:

 FBTimeCode(float pRate = FRAMES_30) 

Parameters

pRate

Framerate value.

See the C++ reference

object __ne__	(	FBTimeCode	arg1,
		FBTimeCode	arg2
	)

Python Docstring:

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

__reduce__

(

)

float GetRawFrame

(

FBTimeCode

arg1

)

Get the raw value for the frame.

Python Docstring:

GetRawFrame( (FBTimeCode)arg1) -> float 

C++ Signature:

double GetRawFrame() 

Returns

raw value for the frame.

See the C++ reference

float GetRawRate

(

FBTimeCode

arg1

)

Get the raw value for the rate.

Python Docstring:

GetRawRate( (FBTimeCode)arg1) -> float 

C++ Signature:

double GetRawRate() 

Returns

raw value for the rate.

See the C++ reference

float GetRawSecond

(

FBTimeCode

arg1

)

Get the raw value for the second.

Python Docstring:

GetRawSecond( (FBTimeCode)arg1) -> float 

C++ Signature:

double GetRawSecond() 

Returns

raw value for the second.

See the C++ reference

FBTime GetTime

(

FBTimeCode

arg1

)

Return a Time corresponding to the timecode.

Python Docstring:

GetTime( (FBTimeCode)arg1) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetTime() 

See the C++ reference

str GetTimeCodeString	(	FBTimeCode	arg1,
		ETimeFormats	arg2
	)

Get time as a string.

Python Docstring:

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

C++ Signature:

ORSDK2018::FBString GetTimeCodeString(ETimeFormats pFormat = FBTime::eDefaultFormat) 

Parameters

pFormat

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

Returns

String value of time.

See the C++ reference

SetTime	(	FBTimeCode	arg1,
		FBTime	arg2
	)

Set TimeCode according to the given time.

Python Docstring:

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

C++ Signature:

void SetTime(ORSDK2018::FBTime pTime) 

Parameters

pTime

Time value to set.

See the C++ reference

SetTimeCode	(	FBTimeCode	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		float	arg5
	)

Set timecode.

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) 

Parameters

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

See the C++ reference

SetTimeCodeString	(	FBTimeCode	arg1,
		str	arg2,
		ETimeFormats	arg3
	)

Set time from string.

Python Docstring:

SetTimeCodeString( (FBTimeCode)arg1, (str)arg2 [, (ETimeFormats)arg3]) -> None 

C++ Signature:

void SetTimeCodeString(const char * pTime, ETimeFormats pFormat = FBTime::eDefaultFormat) 

Parameters

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

See the C++ reference

Member Data Documentation

double Frame

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

See the C++ reference

object FrameRate

object TimeCodeString