Sections

Metadata

The free-form dictionary every named object carries.

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

clear

method

Empties an object's metadata.

OtioStatus otio_metadata_clear(
    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

contains

method

Returns whether anything sits at a path.

OtioStatus otio_metadata_contains(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    bool *out_contains,
    OtioBuffer *out_error);

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

get_bool

method

Reads a boolean from the metadata.

OtioStatus otio_metadata_get_bool(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    bool *out_value,
    OtioBuffer *out_error);

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

get_box2d

method

Reads a rectangle from the metadata.

OtioStatus otio_metadata_get_box2d(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioBox2d *out_value,
    OtioBuffer *out_error);

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

get_color

method

Reads a colour, and the name that goes with it, from the metadata.

`out_name` may be null if the name is not wanted.

OtioStatus otio_metadata_get_color(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioColor *out_value,
    OtioBuffer *out_name,
    OtioBuffer *out_error);

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

get_double

method

Reads a number from the metadata.

OtioStatus otio_metadata_get_double(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    double *out_value,
    OtioBuffer *out_error);

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

get_int

method

Reads a signed integer from the metadata.

OtioStatus otio_metadata_get_int(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    int64_t *out_value,
    OtioBuffer *out_error);

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

get_object

method

Reads a handle to an OTIO object held in the metadata.

OtioStatus otio_metadata_get_object(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioNode *out_value,
    OtioBuffer *out_error);

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

get_rational_time

method

Reads a time from the metadata.

OtioStatus otio_metadata_get_rational_time(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioRationalTime *out_value,
    OtioBuffer *out_error);

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

get_string

method

Reads a string from the metadata.

OtioStatus otio_metadata_get_string(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioBuffer *out_value,
    OtioBuffer *out_error);

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

get_time_range

method

Reads a span from the metadata.

OtioStatus otio_metadata_get_time_range(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioTimeRange *out_value,
    OtioBuffer *out_error);

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

get_time_transform

method

Reads a transform from the metadata.

OtioStatus otio_metadata_get_time_transform(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioTimeTransform *out_value,
    OtioBuffer *out_error);

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

get_uint

method

Reads an unsigned integer from the metadata.

OtioStatus otio_metadata_get_uint(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    uint64_t *out_value,
    OtioBuffer *out_error);

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

get_v2d

method

Reads a point from the metadata.

OtioStatus otio_metadata_get_v2d(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioV2d *out_value,
    OtioBuffer *out_error);

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

key_at

methodmay answer nothing

Returns the key at an index of a dictionary at a path.

Keys are ordered, so walking the indices walks them the same way twice.

OtioStatus otio_metadata_key_at(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    size_t index,
    OtioBuffer *out_key,
    OtioBuffer *out_error);

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

kind

methodmay answer nothing

Returns what kind of value sits at a path.

An empty or null path names the metadata dictionary itself, which is always `OTIO_VALUE_DICTIONARY`.

OtioStatus otio_metadata_kind(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    OtioValueKind *out_kind,
    OtioBuffer *out_error);

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

len

methodmay answer nothing

Returns how many entries a dictionary or an array at a path holds.

OtioStatus otio_metadata_len(
    const OtioDocument *source,
    OtioNode node_handle,
    const char *path,
    size_t *out_len,
    OtioBuffer *out_error);

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

remove

methodmay answer nothing

Removes whatever sits at a path.

Removing a key of a dictionary takes the key with it; removing an element of an array shortens the array.

OtioStatus otio_metadata_remove(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioBuffer *out_error);

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

set_bool

setter

Writes a boolean into the metadata.

OtioStatus otio_metadata_set_bool(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    bool value,
    OtioBuffer *out_error);

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

set_box2d

setter

Writes a rectangle into the metadata.

OtioStatus otio_metadata_set_box2d(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioBox2d value,
    OtioBuffer *out_error);

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

set_color

setter

Writes a colour into the metadata. `name` may be null for an unnamed one.

OtioStatus otio_metadata_set_color(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioColor value,
    const char *name,
    OtioBuffer *out_error);

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

set_dictionary

setter

Writes an empty dictionary into the metadata, to be filled through deeper paths.

OtioStatus otio_metadata_set_dictionary(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioBuffer *out_error);

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

set_double

setter

Writes a number into the metadata.

OtioStatus otio_metadata_set_double(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    double value,
    OtioBuffer *out_error);

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

set_int

setter

Writes a signed integer into the metadata.

OtioStatus otio_metadata_set_int(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    int64_t value,
    OtioBuffer *out_error);

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

set_null

setter

Writes a null into the metadata.

OtioStatus otio_metadata_set_null(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioBuffer *out_error);

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

set_object

setter

Writes a handle to an OTIO object into the metadata.

The object stays where it is and the metadata names it. The handle must come from `target`, as every handle passed with a document must. Nothing checks that it is live, because a document being built may not hold the object yet.

OtioStatus otio_metadata_set_object(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioNode value,
    OtioBuffer *out_error);

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

set_rational_time

setter

Writes a time into the metadata.

OtioStatus otio_metadata_set_rational_time(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioRationalTime value,
    OtioBuffer *out_error);

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

set_string

setter

Writes a string into the metadata.

OtioStatus otio_metadata_set_string(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    const char *value,
    OtioBuffer *out_error);

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

set_time_range

setter

Writes a span into the metadata.

OtioStatus otio_metadata_set_time_range(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioTimeRange value,
    OtioBuffer *out_error);

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

set_time_transform

setter

Writes a transform into the metadata.

OtioStatus otio_metadata_set_time_transform(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioTimeTransform value,
    OtioBuffer *out_error);

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

set_uint

setter

Writes an unsigned integer into the metadata.

OtioStatus otio_metadata_set_uint(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    uint64_t value,
    OtioBuffer *out_error);

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

set_v2d

setter

Writes a point into the metadata.

OtioStatus otio_metadata_set_v2d(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    OtioV2d value,
    OtioBuffer *out_error);

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

set_vector

setter

Writes an array of `len` nulls into the metadata, to be filled by index.

OtioStatus otio_metadata_set_vector(
    OtioDocument *target,
    OtioNode node_handle,
    const char *path,
    size_t len,
    OtioBuffer *out_error);

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