Skip to content

Commit

Permalink
Fix header level
Browse files Browse the repository at this point in the history
Signed-off-by: Spencer Magnusson <[email protected]>
  • Loading branch information
semagnum committed Jul 10, 2024
1 parent 0b2c98e commit 4e4f66a
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/tutorials/time-ranges.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,24 +112,24 @@ The `trimmed_range_in_parent()` is specified in the parent time frame.

## Tracks

#### `Track.available_range()`
### `Track.available_range()`

Total duration of the track, totalling all items inside it.
For example, if there is a clip and a gap in the track,
and each is 5 seconds long, the `available_range()`
would return 10 seconds.

#### `Track.range_of_child_at_index(index)`
### `Track.range_of_child_at_index(index)`

Returns range of nth item (specified by `index`) in the track.
Same as item's `duration`, including transition time.

#### `Track.trimmed_range_of_child_at_index(index)`
### `Track.trimmed_range_of_child_at_index(index)`

Same as `range_of_child_at_index()`,
but trimmed relative to the track's source range.

#### `Track.range_of_all_children()`
### `Track.range_of_all_children()`

Returns a list of every item,
mapped to their trimmed range in the track.
Expand All @@ -153,49 +153,49 @@ time.

## Transitions

#### `Transition.range_in_parent()`
### `Transition.range_in_parent()`

Range of transition for whatever holds the transition.
Calls its parent's `range_in_child()`.

#### `Transition.trimmed_range_in_parent()`
### `Transition.trimmed_range_in_parent()`

The same as `range_in_parent()`,
but trimmed relative to the parent.
Calls its parent's `trimmed_range_in_child()`.

## Gaps

#### `Gap.source_range`
### `Gap.source_range`

Time range of the gap, in between other items like Clips.

## Stacks

#### `Stack.source_range`
### `Stack.source_range`

Defined range for the set of tracks.

#### `Stack.available_range()`
### `Stack.available_range()`

Returns a range representing its tracks' longest duration
(based on the underlying clip `duration()`s).

#### `Stack.range_of_child_at_index(int index)`
### `Stack.range_of_child_at_index(int index)`

Returns the total duration of the track at position `index`.

#### `Stack.trimmed_range_of_child_at_index(int index)`
### `Stack.trimmed_range_of_child_at_index(int index)`

Same as `range_of_child_at_index()`, but trimmed relative
to the duration of the `source_range` of the stack.

#### `Stack.range_of_all_children()`
### `Stack.range_of_all_children()`

Returns set of Tracks mapped to their individual time ranges.

## Timelines

#### `Timeline.range_of_child(child)`
### `Timeline.range_of_child(child)`

Get trimmed time range of direct as well as indirect children (like clips and gaps).

0 comments on commit 4e4f66a

Please sign in to comment.