TimecodeRange

class timecode.TimecodeRange(*, start: Timecode | str | int | None = None, duration: Timecode | str | int | None = None, end: Timecode | str | int | None = None)

An unbroken sequence of timecodes between a specified range

Creating A Range

TimecodeRange requires at least two of the following parameters: start, duration, end. The third parameter will be calculated from the other two if it is not given.

>>> from timecode import Timecode, TimecodeRange
>>> from timecode.modes import DropFrame, NonDropFrame
..
>>> # Create a `TimecodeRange` from a start and duration
>>> tc_start    = Timecode("00:59:59:00")
>>> tc_duration = Timecode("01:02:00")
>>> TimecodeRange(start=tc_start, duration=tc_duration)
<TimecodeRange 00:59:59:00 - 01:01:01:00 (1488) @ 24 NDF>

>>> # Create a `TimecodeRange` from a start and an end
>>> tc_start  = Timecode("00:59:59:00")
>>> tc_end    = Timecode("01:01:01:00")
>>> TimecodeRange(start=tc_start, end=tc_end)
<TimecodeRange 00:59:59:00 - 01:01:01:00 (1488) @ 24 NDF>

start, duration, and end can be provided as Timecode objects, or as any of the standard types supported by the Timecode constructor (str or int). The types can be mixed and matched for each input parameter.

>>> # Create a `TimecodeRange` that is 48 frames long
>>> tc_start     = Timecode("01:00:00:00")
>>> frm_duration = 48
>>> TimecodeRange(start=tc_start, duration=frm_duration)
<TimecodeRange 01:00:00:00 - 01:00:02:00 (48) @ 24 NDF>

CountingModes and Rates

The CountingMode and rate of the TimecodeRange object is determined by the mode and rate of the input Timecode objects; or by the Timecode defaults if none are provided. Thus, to set the mode and/or rate for a TimecodeRange, at least one of the inputs should be a Timecode object with the desired settings.

>>> # Create a `TimecodeRange` that is 60 FPS drop frame (oh my)
>>> tc_start = Timecode("01:00:00;00", rate=60, mode=DropFrame())
>>> duration = 120
>>> TimecodeRange(start=tc_start, duration=duration)
<TimecodeRange 01;00;00;00 - 01;00;02;00 (120) @ 60 DF>

Warning

If more than one of the input parameters are Timecode objects, they must all have matching CountingModes and rates. Otherwise, TimecodeRange will raise an exception.

Using TimecodeRange

>>> from timecode import Timecode, TimecodeRange
...
>>> tc_start = Timecode("01:00:00:00")
>>> tc_duration = Timecode("00:10")
>>> tc_range = TimecodeRange(start=tc_start, duration=tc_duration)
>>> tc_range
<TimecodeRange 01:00:00:00 - 01:00:00:10 (10) @ 24 NDF>

Accessing Properties

start, duration, and end, properties return Timecode objects.

>>> tc_range.start
<Timecode 01:00:00:00 @ 24 NDF>
..
>>> tc_range.start.frame_number
86400
..
>>> tc_range.duration
<Timecode 00:00:00:10 @ 24 NDF>
..
>>> tc_range.end
<Timecode 01:00:00:10 @ 24 NDF>
..
>>> tc_range.end.frame_number
86410

Iterating over a TimecodeRange

>>> len(tc_range)
10
..
>>> for tc in tc_range:
...     repr(tc)
...
'<Timecode 01:00:00:00 @ 24 NDF>'
'<Timecode 01:00:00:01 @ 24 NDF>'
'<Timecode 01:00:00:02 @ 24 NDF>'
'<Timecode 01:00:00:03 @ 24 NDF>'
'<Timecode 01:00:00:04 @ 24 NDF>'
'<Timecode 01:00:00:05 @ 24 NDF>'
'<Timecode 01:00:00:06 @ 24 NDF>'
'<Timecode 01:00:00:07 @ 24 NDF>'
'<Timecode 01:00:00:08 @ 24 NDF>'
'<Timecode 01:00:00:09 @ 24 NDF>'

Checking For Membership

>>> # Based on Timecode string
>>> "01:00:00:05" in tc_range
True
..
>>> # Based on frame number
>>> 86405 in tc_range
True
..
>>> # Based on a `Timecode` object
>>> Timecode("01:00:00:05") in tc_range
True

Subsets

>>> # Check if all frames in a `TimecodeRange` exist in another `TimecodeRange`
>>> tc_range_inner = TimecodeRange(start="01:00:00:05", duration=2)
>>> tc_range_inner in tc_range
True

More Info

See timecode.TimecodeRange in the the API Documentation.