Sections

Transition

A dissolve or a wipe.

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

enabled

getter

Returns whether a transition is applied.

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

in_offset

getter

Returns how far a transition reaches into the item before it.

OtioStatus otio_transition_in_offset(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioRationalTime *out_offset,
    OtioBuffer *out_error);

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

new

constructor

Creates a transition. Its offsets start at zero.

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

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

out_offset

getter

Returns how far a transition reaches into the item after it.

OtioStatus otio_transition_out_offset(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioRationalTime *out_offset,
    OtioBuffer *out_error);

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

set_enabled

setter

Sets whether a transition is applied.

OtioStatus otio_transition_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_in_offset

setter

Sets how far a transition reaches into the item before it.

OtioStatus otio_transition_set_in_offset(
    OtioDocument *target,
    OtioNode node_handle,
    OtioRationalTime offset,
    OtioBuffer *out_error);

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

set_out_offset

setter

Sets how far a transition reaches into the item after it.

OtioStatus otio_transition_set_out_offset(
    OtioDocument *target,
    OtioNode node_handle,
    OtioRationalTime offset,
    OtioBuffer *out_error);

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

set_type

setter

Sets the kind of transition.

OtioStatus otio_transition_set_type(
    OtioDocument *target,
    OtioNode node_handle,
    const char *transition_type,
    OtioBuffer *out_error);

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

type

getter

Returns the kind of transition, such as `"SMPTE_Dissolve"`.

OtioStatus otio_transition_type(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBuffer *out_type,
    OtioBuffer *out_error);

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