FBTimeCode Class Reference
Detailed Description
TimeCode data structure.
- Examples
- UI/Edit.py, Tasks/TimeCodeKeying.py
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. |
|
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
Set timecode.
- Parameters:
-
pHour Hour value. pMinute Minute value. pSecond Second value. pFrame Frame value.
| str GetTimeCodeString | ( | FBTime.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.
| SetTimeCodeString | ( | str | pTime | ) |
| FBTime GetTime | ( | ) |
Return a Time corresponding to the timecode.
| SetTime | ( | FBTime | pTime | ) |
Set TimeCode according to the given time.
- Parameters:
-
pTime Time value to set.
| float GetFrame | ( | ) |
Return a frame number corresponding to the timecode.
| SetFrame | ( | float | pFrame | ) |
Set Frame according to the given time.
- Parameters:
-
pFrame Frame value to set.
| float GetFrameRate | ( | ) |
Return the rate of the timecode.
Member Data Documentation
-29.97f.
-25.0f.
-29.971f Currently not supported : "1" is added just to differentiate from NTSC_FULL(-29.97f).
-24.0f.
-23.976f.
-30.0f.
-59.94f.
