Python Reference Guide
 
Loading...
Searching...
No Matches
FBTime Class Reference

Time data structure. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBTime:

Public Member Functions

 FBTime (long pTime=0)
 
 FBTime (int pHour, int pMinute, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault)
 Constructor.
 
long Get ()
 Get time value (long)
 
long Get ()
 Get time value (long)
 
long GetFrame (FBTimeMode pTimeMode=kFBTimeModeDefault)
 Get the frame count.
 
long GetMilliSeconds ()
 Get milliseconds for time.
 
float GetSecondDouble ()
 Get seconds as double.
 
str GetTimeString (FBTimeMode pMode=kFBTimeModeDefault, ETimeFormats pFormat=eDefaultFormat)
 Get time as a string.
 
bool IsExactlyOnFrame (FBTimeMode pTimeMode=kFBTimeModeDefault)
 Is the time falling exactly on a frame?
 
 Set (long pTime)
 Set time value from a long.
 
 SetFrame (long pFrames, FBTimeMode pTimeMode=kFBTimeModeDefault)
 Set time in frame format.
 
 SetMilliSeconds (long pMilliSeconds)
 Set milliseconds time.
 
 SetSecondDouble (float pTime)
 Set seconds from double.
 
 SetTime (int pHour, int pMinute=0, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault)
 Set time (from separate values)
 
 SetTimeString (str pTime)
 Set time from string.
 

Public Attributes

FBTime Infinity
 Time constant: Infinity, the largest time value.

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

 
FBTime OneHour
 Time constant: One Hour.

 
FBTime OneMinute
 Time constant: One Minute.

 
FBTime OneSecond
 Time constant: One Second.

 
FBTime Zero
 Time constant: Zero.

 

Detailed Description

Constructor & Destructor Documentation

◆ FBTime() [1/2]

FBTime ( long  pTime = 0)

◆ FBTime() [2/2]

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

Constructor.

Parameters
pHourHour value.
pMinuteMinute value.
pSecondSecond value.
pFrameFrame value.
pFieldField value.
pTimeModeTime mode(default=kFBTimeModeDefault).

Member Function Documentation

◆ Get() [1/2]

long Get ( )

Get time value (long)

Returns
Time value as long.

◆ Get() [2/2]

long Get ( )

Get time value (long)

Returns
Time value as long.

◆ GetFrame()

long GetFrame ( FBTimeMode  pTimeMode = kFBTimeModeDefault)

Get the frame count.

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

Parameters
pTimeModeTime mode to get the constant (default is kFBTimeModeDefault).
Returns
Frames per second constant for the specified time mode.

◆ GetMilliSeconds()

long GetMilliSeconds ( )

Get milliseconds for time.

Returns
MilliSeconds value.

◆ GetSecondDouble()

float GetSecondDouble ( )

Get seconds as double.

Returns
Seconds in double form.

◆ GetTimeString()

str GetTimeString ( FBTimeMode  pMode = kFBTimeModeDefault,
ETimeFormats  pFormat = eDefaultFormat 
)

Get time as a string.

Parameters
pModeTime mode (default=kFBTimeModeDefault) to use (call FBSystem().GetTransportFps() to the the current UI displayed mode).
pFormatFormat to use for the returned string(default=FBTime::eDefaultFormat).
Returns
String value of time.

◆ IsExactlyOnFrame()

bool IsExactlyOnFrame ( FBTimeMode  pTimeMode = kFBTimeModeDefault)

Is the time falling exactly on a frame?

# The following Python snippet shows a scenario where calling IsExactlyOnFrame might be useful.
# Frame 1054
myTime = FBTime( 0, 0, 0, 1054 )
# Frame 1054 with a very small offset
myTime2 = FBTime( 0 )
myTime2.Set( myTime.Get() + 10 )
print( "myTime as frame :", myTime.GetFrame() )
print( "myTime as string :", myTime.GetTimeString( FBTimeMode.kFBTimeModeDefault, FBTime.eSMPTE ) )
print( "myTime on exact frame? :", myTime.IsExactlyOnFrame() )
print( "myTime2 as frame :", myTime2.GetFrame() )
print( "myTime2 as string :", myTime2.GetTimeString( FBTimeMode.kFBTimeModeDefault, FBTime.eSMPTE ) )
print( "myTime2 on exact frame? :", myTime2.IsExactlyOnFrame() )
Time data structure.
Definition: pyfbsdk_generated.h:19596
long Get()
Get time value (long)
str GetTimeString(FBTimeMode pMode=kFBTimeModeDefault, ETimeFormats pFormat=eDefaultFormat)
Get time as a string.
long GetFrame(FBTimeMode pTimeMode=kFBTimeModeDefault)
Get the frame count.
Set(long pTime)
Set time value from a long.
bool IsExactlyOnFrame(FBTimeMode pTimeMode=kFBTimeModeDefault)
Is the time falling exactly on a frame?
Different time modes available.
Definition: pyfbsdk_generated.h:19808
Parameters
pTimeModeTime mode to get time as.
Returns
True if the time falls exactly on a frame, false otherwise.

◆ Set()

Set ( long  pTime)

Set time value from a long.

Parameters
pTimeTime value to set.

◆ SetFrame()

SetFrame ( long  pFrames,
FBTimeMode  pTimeMode = kFBTimeModeDefault 
)

Set time in frame format.

Parameters
pFramesThe number of frames.
pTimeModeThe time mode identifier which will dictate the extraction algorithm.

◆ SetMilliSeconds()

SetMilliSeconds ( long  pMilliSeconds)

Set milliseconds time.

Parameters
pMilliSecondsMilliSeconds value.

◆ SetSecondDouble()

SetSecondDouble ( float  pTime)

Set seconds from double.

Parameters
pTimeTime to set seconds from.

◆ SetTime()

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

Set time (from separate values)

Parameters
pHourHour value.
pMinuteMinute value(default=0).
pSecondSecond value(default=0).
pFrameFrame value(default=0).
pFieldField value(default=0).
pTimeModeTime mode to get time as(default=kFBTimeModeDefault).

◆ SetTimeString()

SetTimeString ( str  pTime)

Set time from string.

Parameters
pTimeString to set time from.

Member Data Documentation

◆ Infinity

FBTime Infinity

Time constant: Infinity, the largest time value.

◆ MinusInfinity

FBTime MinusInfinity

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

◆ OneHour

FBTime OneHour

Time constant: One Hour.

◆ OneMinute

FBTime OneMinute

Time constant: One Minute.

◆ OneSecond

FBTime OneSecond

Time constant: One Second.

◆ Zero

FBTime Zero

Time constant: Zero.