Sections

MediaReference

What a clip draws its pictures from.

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

available_image_bounds

gettermay answer nothing

Returns the image bounds a reference says its media has.

OtioStatus otio_media_reference_available_image_bounds(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBox2d *out_bounds,
    OtioBuffer *out_error);

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

available_range

gettermay answer nothing

Returns the span of media a reference says is available.

Reports `OTIO_STATUS_NO_VALUE` for a reference that does not say.

OtioStatus otio_media_reference_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_available_image_bounds

clearer

Clears the image bounds a reference says its media has.

OtioStatus otio_media_reference_clear_available_image_bounds(
    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_available_range

clearer

Clears the span of media a reference says is available.

OtioStatus otio_media_reference_clear_available_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

set_available_image_bounds

setter

Sets the image bounds a reference says its media has.

OtioStatus otio_media_reference_set_available_image_bounds(
    OtioDocument *target,
    OtioNode node_handle,
    OtioBox2d bounds,
    OtioBuffer *out_error);

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

set_available_range

setter

Sets the span of media a reference says is available.

OtioStatus otio_media_reference_set_available_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