Sections

ImageSequenceReference

Media held as numbered frames on disk.

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

name_prefix

getter

Returns the part of each frame's filename before the frame number.

OtioStatus otio_image_sequence_reference_name_prefix(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBuffer *out_prefix,
    OtioBuffer *out_error);

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

name_suffix

getter

Returns the part of each frame's filename after the frame number.

OtioStatus otio_image_sequence_reference_name_suffix(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBuffer *out_suffix,
    OtioBuffer *out_error);

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

new

constructor

Creates a media reference for a numbered sequence of image files.

The filename parts and the numbers start empty and at zero; set them with [`otio_image_sequence_reference_set_numbers`] and the calls beside it.

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

numbers

getter

Returns the numbers describing how an image sequence is laid out.

OtioStatus otio_image_sequence_reference_numbers(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioImageSequence *out_numbers,
    OtioBuffer *out_error);

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

set_name_prefix

setter

Sets the part of each frame's filename before the frame number.

OtioStatus otio_image_sequence_reference_set_name_prefix(
    OtioDocument *target,
    OtioNode node_handle,
    const char *prefix,
    OtioBuffer *out_error);

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

set_name_suffix

setter

Sets the part of each frame's filename after the frame number.

OtioStatus otio_image_sequence_reference_set_name_suffix(
    OtioDocument *target,
    OtioNode node_handle,
    const char *suffix,
    OtioBuffer *out_error);

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

set_numbers

setter

Sets the numbers describing how an image sequence is laid out.

OtioStatus otio_image_sequence_reference_set_numbers(
    OtioDocument *target,
    OtioNode node_handle,
    OtioImageSequence numbers,
    OtioBuffer *out_error);

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

set_target_url_base

setter

Sets the directory an image sequence's frames sit in.

OtioStatus otio_image_sequence_reference_set_target_url_base(
    OtioDocument *target,
    OtioNode node_handle,
    const char *url_base,
    OtioBuffer *out_error);

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

target_url_base

getter

Returns the directory an image sequence's frames sit in.

OtioStatus otio_image_sequence_reference_target_url_base(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBuffer *out_url_base,
    OtioBuffer *out_error);

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