Sections

Item

Anything that occupies time.

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

append_effect

method

Adds an effect to an item. Effects apply in the order they are added.

OtioStatus otio_item_append_effect(
    OtioDocument *target,
    OtioNode node_handle,
    OtioNode effect_handle,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
effect_handle	node	input
out_error	text	why the call failed, or null to skip it

append_marker

method

Adds a marker to an item.

OtioStatus otio_item_append_marker(
    OtioDocument *target,
    OtioNode node_handle,
    OtioNode marker_handle,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
marker_handle	node	input
out_error	text	why the call failed, or null to skip it

available_range

getter

Returns the span of media an object could draw on, before trimming.

OtioStatus otio_item_available_range(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioTimeRange *out_range,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_range	OtioTimeRange	written through, not read
out_error	text	why the call failed, or null to skip it

clear_color

clearer

Clears an item's display tint.

OtioStatus otio_item_clear_color(
    OtioDocument *target,
    OtioNode node_handle,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
out_error	text	why the call failed, or null to skip it

clear_source_range

clearer

Clears an item's source range, so that it takes all of its media.

OtioStatus otio_item_clear_source_range(
    OtioDocument *target,
    OtioNode node_handle,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
out_error	text	why the call failed, or null to skip it

color

methodmay answer nothing

Returns an item's display tint, and the name that goes with it.

`out_name` may be null if the name is not wanted. Reports `OTIO_STATUS_NO_VALUE` for an untinted item.

OtioStatus otio_item_color(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioColor *out_color,
    OtioBuffer *out_name,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_color	OtioColor	written through, not read
out_name ?	text	written through, not read
out_error	text	why the call failed, or null to skip it

duration

getter

Returns how long an object occupies its parent's timeline.

OtioStatus otio_item_duration(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioRationalTime *out_duration,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_duration	OtioRationalTime	written through, not read
out_error	text	why the call failed, or null to skip it

effect_at

method

Returns one of an item's effects.

OtioStatus otio_item_effect_at(
    const OtioDocument *source,
    OtioNode node_handle,
    size_t index,
    OtioNode *out_effect,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
index	size	input
out_effect	node	written through, not read
out_error	text	why the call failed, or null to skip it

effect_count

getter

Returns how many effects an item carries.

OtioStatus otio_item_effect_count(
    const OtioDocument *source,
    OtioNode node_handle,
    size_t *out_count,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_count	size	written through, not read
out_error	text	why the call failed, or null to skip it

enabled

getter

Returns whether an item contributes to its composition.

OtioStatus otio_item_enabled(
    const OtioDocument *source,
    OtioNode node_handle,
    bool *out_enabled,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_enabled	bool	written through, not read
out_error	text	why the call failed, or null to skip it

marker_at

method

Returns one of an item's markers.

OtioStatus otio_item_marker_at(
    const OtioDocument *source,
    OtioNode node_handle,
    size_t index,
    OtioNode *out_marker,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
index	size	input
out_marker	node	written through, not read
out_error	text	why the call failed, or null to skip it

marker_count

getter

Returns how many markers an item carries.

OtioStatus otio_item_marker_count(
    const OtioDocument *source,
    OtioNode node_handle,
    size_t *out_count,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_count	size	written through, not read
out_error	text	why the call failed, or null to skip it

new

constructor

Creates a bare item: something that occupies time without saying what fills it.

OtioStatus otio_item_new(
    OtioDocument *target,
    const char *name,
    OtioNode *out_node,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
name ?	text	input
out_node	node	written through, not read
out_error	text	why the call failed, or null to skip it

range_in_parent

getter

Returns where an object sits in its parent's clock.

OtioStatus otio_item_range_in_parent(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioTimeRange *out_range,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_range	OtioTimeRange	written through, not read
out_error	text	why the call failed, or null to skip it

remove_effect

method

Removes one of an item's effects, and returns it.

OtioStatus otio_item_remove_effect(
    OtioDocument *target,
    OtioNode node_handle,
    size_t index,
    OtioNode *out_effect,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
index	size	input
out_effect	node	written through, not read
out_error	text	why the call failed, or null to skip it

remove_marker

method

Removes one of an item's markers, and returns it.

The marker stays in the document; remove it with `otio_document_remove_recursive` if nothing else holds it.

OtioStatus otio_item_remove_marker(
    OtioDocument *target,
    OtioNode node_handle,
    size_t index,
    OtioNode *out_marker,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
index	size	input
out_marker	node	written through, not read
out_error	text	why the call failed, or null to skip it

set_color

setter

Sets an item's display tint. `name` may be null for an unnamed colour.

OtioStatus otio_item_set_color(
    OtioDocument *target,
    OtioNode node_handle,
    OtioColor color,
    const char *name,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
color	OtioColor	input
name ?	text	input
out_error	text	why the call failed, or null to skip it

set_enabled

setter

Sets whether an item contributes to its composition.

OtioStatus otio_item_set_enabled(
    OtioDocument *target,
    OtioNode node_handle,
    bool enabled,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
enabled	bool	input
out_error	text	why the call failed, or null to skip it

set_source_range

setter

Sets the portion of its media an item uses.

OtioStatus otio_item_set_source_range(
    OtioDocument *target,
    OtioNode node_handle,
    OtioTimeRange range,
    OtioBuffer *out_error);

Parameter	Type	Role
target	document	the document, changed
node_handle	node	what the call is about
range	OtioTimeRange	input
out_error	text	why the call failed, or null to skip it

source_range

gettermay answer nothing

Returns the portion of its media an item uses.

Reports `OTIO_STATUS_NO_VALUE` for an item that takes all of it.

OtioStatus otio_item_source_range(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioTimeRange *out_range,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_range	OtioTimeRange	written through, not read
out_error	text	why the call failed, or null to skip it

trimmed_range

getter

Returns the span of media an object uses, in its own clock.

OtioStatus otio_item_trimmed_range(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioTimeRange *out_range,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_range	OtioTimeRange	written through, not read
out_error	text	why the call failed, or null to skip it

trimmed_range_in_parent

gettermay answer nothing

Returns where an object sits in its parent's clock, after the parent's own trim.

Reports `OTIO_STATUS_NO_VALUE` when the parent's trim excludes the object entirely.

OtioStatus otio_item_trimmed_range_in_parent(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioTimeRange *out_range,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_range	OtioTimeRange	written through, not read
out_error	text	why the call failed, or null to skip it

visible_range

getter

Returns the span of media an object shows, including what its transitions reach into.

OtioStatus otio_item_visible_range(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioTimeRange *out_range,
    OtioBuffer *out_error);

Parameter	Type	Role
source ?	document	the document, borrowed
node_handle	node	what the call is about
out_range	OtioTimeRange	written through, not read
out_error	text	why the call failed, or null to skip it