Sections

Marker

A note pinned to a span of an item.

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

color

methodmay answer nothing

Returns a marker's 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 marker.

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

comment

getter

Returns a marker's note.

OtioStatus otio_marker_comment(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBuffer *out_comment,
    OtioBuffer *out_error);

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

marked_range

getter

Returns the span a marker covers.

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

new

constructor

Creates a marker covering `marked_range`.

OtioStatus otio_marker_new(
    OtioDocument *target,
    const char *name,
    OtioTimeRange marked_range,
    OtioNode *out_node,
    OtioBuffer *out_error);

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

set_color

setter

Sets a marker's tint. `name` may be null for an unnamed colour.

OtioStatus otio_marker_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_comment

setter

Sets a marker's note.

OtioStatus otio_marker_set_comment(
    OtioDocument *target,
    OtioNode node_handle,
    const char *comment,
    OtioBuffer *out_error);

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

set_marked_range

setter

Sets the span a marker covers.

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