#include <mobu-python-api.h>

Class Description

Time data structure.

Inheritance diagram for FBTime:

Public Member Functions
	__reduce__ ()

	__init__ (...)

str	__repr__ (FBTime arg1)

int	Get (FBTime arg1)

int	GetFrame (FBTime arg1, FBTimeMode arg2)
	Get the frame count. More...

	SetFrame (FBTime arg1, object arg2, FBTimeMode arg3)
	Set time in frame format. More...

int	GetMilliSeconds (FBTime arg1)
	Get milliseconds for time. More...

float	GetSecondDouble (FBTime arg1)
	Get seconds as double. More...

str	GetTimeString (FBTime arg1, FBTimeMode arg2, ETimeFormats arg3)
	Get time as a string. More...

	Set (FBTime arg1, object arg2)
	Set time value from a long. More...

	SetMilliSeconds (FBTime arg1, object arg2)
	Set milliseconds time. More...

	SetSecondDouble (FBTime arg1, object arg2)
	Set seconds from double. More...

	SetTime (FBTime arg1, object arg2, object arg3, object arg4, object arg5, object arg6, FBTimeMode arg7)
	Set time (from separate values) More...

	SetTimeString (FBTime arg1, str arg2)
	Set time from string. More...

	__add__ (...)

	__sub__ (...)

object	__eq__ (FBTime arg1, FBTime arg2)

object	__ne__ (FBTime arg1, FBTime arg2)

object	__gt__ (FBTime arg1, FBTime arg2)

object	__ge__ (FBTime arg1, FBTime arg2)

object	__lt__ (FBTime arg1, FBTime arg2)

object	__le__ (FBTime arg1, FBTime arg2)

Public Attributes
const ORSDK2018::FBTime	MinusInfinity
	Time constant: Minus Infinity, the lowest negative time value. More...

const ORSDK2018::FBTime	Zero
	Time constant: Zero. More...

const ORSDK2018::FBTime	OneSecond
	Time constant: One Second. More...

const ORSDK2018::FBTime	OneMinute
	Time constant: One Minute. More...

const ORSDK2018::FBTime	OneHour
	Time constant: One Hour. More...

const ORSDK2018::FBTime	Infinity
	Time constant: Infinity, the largest time value. More...

Member Function Documentation

__add__ ( ... )

Python Docstring:

__add__( (FBTime)arg1, (FBTime)arg2) -> object

__add__( (FBTime)arg1, (object)arg2) -> object

object __eq__	(	FBTime	arg1,
		FBTime	arg2
	)

Python Docstring:

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

object __ge__	(	FBTime	arg1,
		FBTime	arg2
	)

Python Docstring:

__ge__( (FBTime)arg1, (FBTime)arg2) -> object

object __gt__	(	FBTime	arg1,
		FBTime	arg2
	)

Python Docstring:

__gt__( (FBTime)arg1, (FBTime)arg2) -> object

__init__ ( ... )

Python Docstring:

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

__init__( (object)arg1, (object)arg2, (object)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6 [, (FBTimeMode)arg7]]]]) -> None

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

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBTime(kLongLong pTime = 0)
 FBTime(int pHour, int pMinute, int pSecond = 0, int pFrame = 0, int pField = 0, FBTimeMode pTimeMode = kFBTimeModeDefault)

object __le__	(	FBTime	arg1,
		FBTime	arg2
	)

Python Docstring:

__le__( (FBTime)arg1, (FBTime)arg2) -> object

object __lt__	(	FBTime	arg1,
		FBTime	arg2
	)

Python Docstring:

__lt__( (FBTime)arg1, (FBTime)arg2) -> object

object __ne__	(	FBTime	arg1,
		FBTime	arg2
	)

Python Docstring:

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

__reduce__ ( )

str __repr__ ( FBTime arg1 )

Python Docstring:

__repr__( (FBTime)arg1) -> str

__sub__ ( ... )

Python Docstring:

__sub__( (FBTime)arg1, (FBTime)arg2) -> object

__sub__( (FBTime)arg1, (object)arg2) -> object

int Get ( FBTime arg1 )

Python Docstring:

Get( (FBTime)arg1) -> int

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

kLongLong & Get()
const kLongLong & Get()

int GetFrame	(	FBTime	arg1,
		FBTimeMode	arg2
	)

Get the frame count.

Python Docstring:

GetFrame( (FBTime)arg1 [, (FBTimeMode)arg2]) -> int

C++ Signature:

kLongLong GetFrame(FBTimeMode pTimeMode = kFBTimeModeDefault)

With this function, it is possible to obtain the cumulative and local frame counts.

Parameters

pTimeMode Time mode to get the constant (default is kFBTimeModeDefault).

Returns: Frames per second constant for the specified time mode.

See the C++ reference

int GetMilliSeconds ( FBTime arg1 )

Get milliseconds for time.

Python Docstring:

GetMilliSeconds( (FBTime)arg1) -> int

C++ Signature:

kLongLong GetMilliSeconds()

Returns: MilliSeconds value.

See the C++ reference

float GetSecondDouble ( FBTime arg1 )

Get seconds as double.

Python Docstring:

GetSecondDouble( (FBTime)arg1) -> float

C++ Signature:

double GetSecondDouble()

Returns: Seconds in double form.

See the C++ reference

str GetTimeString	(	FBTime	arg1,
		FBTimeMode	arg2,
		ETimeFormats	arg3
	)

Get time as a string.

Python Docstring:

GetTimeString( (FBTime)arg1 [, (FBTimeMode)arg2 [, (ETimeFormats)arg3]]) -> str

C++ Signature:

ORSDK2018::FBString GetTimeString(FBTimeMode pMode = kFBTimeModeDefault, ETimeFormats pFormat = eDefaultFormat)

Parameters

pMode	Time mode (default=kFBTimeModeDefault) to use (call FBSystem().GetTransportFps() to the the current UI displayed mode).
pFormat	Format to use for the returned string(default=FBTime::eDefaultFormat).

Returns: String value of time.

See the C++ reference

Set	(	FBTime	arg1,
		object	arg2
	)

Set time value from a long.

Python Docstring:

Set( (FBTime)arg1, (object)arg2) -> None

C++ Signature:

void Set(kLongLong pTime)

Parameters

pTime Time value to set.

See the C++ reference

SetFrame	(	FBTime	arg1,
		object	arg2,
		FBTimeMode	arg3
	)

Set time in frame format.

Python Docstring:

SetFrame( (FBTime)arg1, (object)arg2 [, (FBTimeMode)arg3]) -> None

C++ Signature:

void SetFrame(kLongLong pFrames, FBTimeMode pTimeMode = kFBTimeModeDefault)

Parameters

pFrames	The number of frames.
pTimeMode	The time mode identifier which will dictate the extraction algorithm.

See the C++ reference

SetMilliSeconds	(	FBTime	arg1,
		object	arg2
	)

Set milliseconds time.

Python Docstring:

SetMilliSeconds( (FBTime)arg1, (object)arg2) -> None

C++ Signature:

void SetMilliSeconds(kLongLong pMilliSeconds)

Parameters

pMilliSeconds MilliSeconds value.

See the C++ reference

SetSecondDouble	(	FBTime	arg1,
		object	arg2
	)

Set seconds from double.

Python Docstring:

SetSecondDouble( (FBTime)arg1, (object)arg2) -> None

C++ Signature:

void SetSecondDouble(double pTime)

Parameters

pTime Time to set seconds from.

See the C++ reference

SetTime	(	FBTime	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		object	arg5,
		object	arg6,
		FBTimeMode	arg7
	)

Set time (from separate values)

Python Docstring:

SetTime( (FBTime)arg1, (object)arg2 [, (object)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6 [, (FBTimeMode)arg7]]]]]) -> None

C++ Signature:

void SetTime(int pHour, int pMinute = 0, int pSecond = 0, int pFrame = 0, int pField = 0, FBTimeMode pTimeMode = kFBTimeModeDefault)

Parameters

pHour	Hour value.
pMinute	Minute value(default=0).
pSecond	Second value(default=0).
pFrame	Frame value(default=0).
pField	Field value(default=0).
pTimeMode	Time mode to get time as(default=kFBTimeModeDefault).

See the C++ reference

SetTimeString	(	FBTime	arg1,
		str	arg2
	)

Set time from string.

Python Docstring:

SetTimeString( (FBTime)arg1, (str)arg2) -> None

C++ Signature:

void SetTimeString(const char * pTime)

Parameters

pTime String to set time from.

See the C++ reference

Member Data Documentation

const ORSDK2018::FBTime Infinity

Time constant: Infinity, the largest time value.

See the C++ reference

const ORSDK2018::FBTime MinusInfinity

Time constant: Minus Infinity, the lowest negative time value.

See the C++ reference

const ORSDK2018::FBTime OneHour

Time constant: One Hour.

See the C++ reference

const ORSDK2018::FBTime OneMinute

Time constant: One Minute.

See the C++ reference

const ORSDK2018::FBTime OneSecond

Time constant: One Second.

See the C++ reference

const ORSDK2018::FBTime Zero

Time constant: Zero.

See the C++ reference

FBTime Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation