Sections

TimeRange

A span of time: where it starts and how long it lasts.

Symbols in this group are spelled otio_time_range_…. An SDK drops that prefix, which is why the name beside each call is the short one.

before_range

method

Returns whether this range ends before another begins.

bool otio_time_range_before_range(
    OtioTimeRange range,
    OtioTimeRange other,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input
epsilon_s	double	input

before_time

method

Returns whether this range ends before an instant.

bool otio_time_range_before_time(
    OtioTimeRange range,
    OtioRationalTime time,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
time	OtioRationalTime	input
epsilon_s	double	input

begins_range

method

Returns whether another range starts where this one does.

bool otio_time_range_begins_range(
    OtioTimeRange range,
    OtioTimeRange other,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input
epsilon_s	double	input

begins_time

method

Returns whether this range starts at an instant.

bool otio_time_range_begins_time(
    OtioTimeRange range,
    OtioRationalTime time,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
time	OtioRationalTime	input
epsilon_s	double	input

clamped_range

method

Returns the range pulled inside this one, where it lies outside it.

OtioTimeRange otio_time_range_clamped_range(OtioTimeRange range, OtioTimeRange other);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input

clamped_time

method

Returns the instant pulled inside the range, if it lies outside it.

OtioRationalTime otio_time_range_clamped_time(
    OtioTimeRange range,
    OtioRationalTime time);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
time	OtioRationalTime	input

contains_range

method

Returns whether another range falls entirely inside this one.

bool otio_time_range_contains_range(
    OtioTimeRange range,
    OtioTimeRange other,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input
epsilon_s	double	input

contains_time

method

Returns whether an instant falls inside the range, the end excluded.

bool otio_time_range_contains_time(OtioTimeRange range, OtioRationalTime time);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
time	OtioRationalTime	input

duration_extended_by

method

Returns the range with its duration lengthened.

OtioTimeRange otio_time_range_duration_extended_by(
    OtioTimeRange range,
    OtioRationalTime by);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
by	OtioRationalTime	input

end_time_exclusive

getter

Returns the instant just after the range's end.

OtioRationalTime otio_time_range_end_time_exclusive(OtioTimeRange range);

Parameter	Type	Role
range	OtioTimeRange	what the call is about

end_time_inclusive

getter

Returns the last instant the range covers.

OtioRationalTime otio_time_range_end_time_inclusive(OtioTimeRange range);

Parameter	Type	Role
range	OtioTimeRange	what the call is about

extended_by

method

Returns the smallest range covering both of two ranges.

OtioTimeRange otio_time_range_extended_by(OtioTimeRange range, OtioTimeRange other);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input

finishes_range

method

Returns whether another range ends where this one does.

bool otio_time_range_finishes_range(
    OtioTimeRange range,
    OtioTimeRange other,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input
epsilon_s	double	input

finishes_time

method

Returns whether this range ends at an instant.

bool otio_time_range_finishes_time(
    OtioTimeRange range,
    OtioRationalTime time,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
time	OtioRationalTime	input
epsilon_s	double	input

from_start_end_time

constructor

Builds a range from its start and the instant after its end.

OtioTimeRange otio_time_range_from_start_end_time(
    OtioRationalTime start_time,
    OtioRationalTime end_time_exclusive);

Parameter	Type	Role
start_time	OtioRationalTime	input
end_time_exclusive	OtioRationalTime	input

from_start_end_time_inclusive

constructor

Builds a range from its start and its last instant.

OtioTimeRange otio_time_range_from_start_end_time_inclusive(
    OtioRationalTime start_time,
    OtioRationalTime end_time_inclusive);

Parameter	Type	Role
start_time	OtioRationalTime	input
end_time_inclusive	OtioRationalTime	input

intersects

method

Returns whether two ranges share more than a single boundary instant.

bool otio_time_range_intersects(
    OtioTimeRange range,
    OtioTimeRange other,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input
epsilon_s	double	input

is_valid

getter

Returns whether a range is usable: valid times and a duration of at least zero.

bool otio_time_range_is_valid(OtioTimeRange range);

Parameter	Type	Role
range	OtioTimeRange	what the call is about

meets

method

Returns whether this range ends exactly where another begins.

bool otio_time_range_meets(OtioTimeRange range, OtioTimeRange other, double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input
epsilon_s	double	input

overlaps_range

method

Returns whether two ranges share any time at all.

bool otio_time_range_overlaps_range(
    OtioTimeRange range,
    OtioTimeRange other,
    double epsilon_s);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
other	OtioTimeRange	input
epsilon_s	double	input

overlaps_time

method

Returns whether an instant falls inside the range, the ends included.

bool otio_time_range_overlaps_time(OtioTimeRange range, OtioRationalTime time);

Parameter	Type	Role
range	OtioTimeRange	what the call is about
time	OtioRationalTime	input