IC8 Python API:RLPy RFps
Contents
- 1 Description
- 2 Constructor & Destructor
- 3 Member Functions
- 3.1 BaseOneIndexedFrameTime (self, nFrameIndex)
- 3.2 EqualFrameTime (self, kA, kB)
- 3.3 FrameTimeFromSecond (self, fSecond)
- 3.4 FromTimecodeFormattedString (self, strTimecode)
- 3.5 GetFrameIndex (self, kTime)
- 3.6 GetFrameTime (self, kTime)
- 3.7 GetNextFrameTime (self, kTime)
- 3.8 GetPreviousFrameTime (self, kTime)
- 3.9 IndexedFrameTime (self, nFrameIndex)
- 3.10 IsSameFrame (self, kTime1, kTime2)
- 3.11 LessEqualFrameTime (self, kA, kB)
- 3.12 LessFrameTime (self, kA, kB)
- 3.13 RoundFrameIndex (self, kTime)
- 3.14 SecondFromFrameTime (self, kTime)
- 3.15 TickPerFrame (self)
- 3.16 ToDouble (self)
- 3.17 ToFloat (self)
- 3.18 ToInt (self)
- 3.19 ToInt64 (self)
- 3.20 ToLong (self)
- 3.21 ToTimecodeFormattedString (self, kTime)
- 3.22 ToUInt32 (self)
- 3.23 UpFrameIndex (self, kTime)
- 3.24 __eq__ (self, kFps)
- 3.25 __ge__ (self, kFps)
- 3.26 __gt__ (self, kFps)
- 3.27 __le__ (self, kFps)
- 3.28 __lt__ (self, kFps)
- 3.29 __ne__ (self, kFps)
- 4 Properties
- 5 Constants
- 5.1 ByTick
- 5.2 Fps1
- 5.3 Fps10
- 5.4 Fps100
- 5.5 Fps1000
- 5.6 Fps12
- 5.7 Fps120
- 5.8 Fps1200
- 5.9 Fps125
- 5.10 Fps15
- 5.11 Fps150
- 5.12 Fps1500
- 5.13 Fps16
- 5.14 Fps2
- 5.15 Fps20
- 5.16 Fps200
- 5.17 Fps2000
- 5.18 Fps24
- 5.19 Fps240
- 5.20 Fps25
- 5.21 Fps250
- 5.22 Fps3
- 5.23 Fps30
- 5.24 Fps300
- 5.25 Fps3000
- 5.26 Fps375
- 5.27 Fps4
- 5.28 Fps40
- 5.29 Fps400
- 5.30 Fps48
- 5.31 Fps5
- 5.32 Fps50
- 5.33 Fps500
- 5.34 Fps6
- 5.35 Fps60
- 5.36 Fps600
- 5.37 Fps6000
- 5.38 Fps75
- 5.39 Fps750
- 5.40 Fps8
- 5.41 Fps80
- 5.42 Unknown
Description
This class provides frame-rate utilities for converting seconds, frame indices, frame times, and timecode strings.
Constructor & Destructor
__init__ (self, tFps)
Initializes a new frame-rate helper instance.
Parameters
- tFps
Member Functions
BaseOneIndexedFrameTime (self, nFrameIndex)
Returns the time value for a one-based frame index.
Parameters
- nFrameIndex
EqualFrameTime (self, kA, kB)
Reports whether two time values represent the same frame.
Parameters
- kA
- kB
FrameTimeFromSecond (self, fSecond)
Converts seconds to the corresponding frame time.
Parameters
- fSecond
FromTimecodeFormattedString (self, strTimecode)
Parses a timecode string and returns the corresponding time value.
Parameters
- strTimecode
GetFrameIndex (self, kTime)
Returns the frame index corresponding to the supplied time value.
Parameters
- kTime
GetFrameTime (self, kTime)
Returns the time value for the supplied frame index.
Parameters
- kTime
GetNextFrameTime (self, kTime)
Returns the time of the next frame after the supplied time.
Parameters
- kTime
GetPreviousFrameTime (self, kTime)
Returns the time of the previous frame before the supplied time.
Parameters
- kTime
IndexedFrameTime (self, nFrameIndex)
Returns the time value for a zero-based frame index.
Parameters
- nFrameIndex
IsSameFrame (self, kTime1, kTime2)
Reports whether two frame-time values fall on the same frame.
Parameters
- kTime1
- kTime2
LessEqualFrameTime (self, kA, kB)
Reports whether one frame time is less than or equal to another.
Parameters
- kA
- kB
LessFrameTime (self, kA, kB)
Reports whether one frame time precedes another.
Parameters
- kA
- kB
RoundFrameIndex (self, kTime)
Rounds a time value to the nearest frame index.
Parameters
- kTime
SecondFromFrameTime (self, kTime)
Converts a frame time to seconds.
Parameters
- kTime
TickPerFrame (self)
Returns the number of time ticks in one frame.
ToDouble (self)
Returns this frame rate as a double-precision number.
ToFloat (self)
Returns this frame rate as a floating-point number.
ToInt (self)
Returns this frame rate as an integer.
ToInt64 (self)
Returns this frame rate as a 64-bit integer.
ToLong (self)
Returns this frame rate as a long integer.
ToTimecodeFormattedString (self, kTime)
Formats a time value as a timecode string.
Parameters
- kTime
ToUInt32 (self)
Returns this frame rate as an unsigned 32-bit integer.
UpFrameIndex (self, kTime)
Advances a frame index to the next frame.
Parameters
- kTime
__eq__ (self, kFps)
Reports whether this value equals another value.
Parameters
- kFps
__ge__ (self, kFps)
Reports whether this value is greater than or equal to another value.
Parameters
- kFps
__gt__ (self, kFps)
Reports whether this value is greater than another value.
Parameters
- kFps
__le__ (self, kFps)
Reports whether this value is less than or equal to another value.
Parameters
- kFps
__lt__ (self, kFps)
Reports whether this value is less than another value.
Parameters
- kFps
__ne__ (self, kFps)
Reports whether this value differs from another value.
Parameters
- kFps
Properties
thisown
Indicates whether this SWIG proxy owns the underlying C++ object.
