Sections

Effect

Something applied to an item that changes how it plays.

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

effect_name

getter

Returns an effect's own name, such as `"LinearTimeWarp"`.

OtioStatus otio_effect_effect_name(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBuffer *out_name,
    OtioBuffer *out_error);

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

enabled

getter

Returns whether an effect is applied.

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

new

constructor

Creates an effect. `effect_name` is the effect's own name, such as `"Blur"`, which is separate from the object's name.

OtioStatus otio_effect_new(
    OtioDocument *target,
    const char *name,
    const char *effect_name,
    OtioNode *out_node,
    OtioBuffer *out_error);

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

set_effect_name

setter

Sets an effect's own name.

OtioStatus otio_effect_set_effect_name(
    OtioDocument *target,
    OtioNode node_handle,
    const char *effect_name,
    OtioBuffer *out_error);

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

set_enabled

setter

Sets whether an effect is applied.

OtioStatus otio_effect_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_time_scalar

setter

Sets a speed change's multiplier.

OtioStatus otio_effect_set_time_scalar(
    OtioDocument *target,
    OtioNode node_handle,
    double scalar,
    OtioBuffer *out_error);

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

time_scalar

getter

Returns a speed change's multiplier.

Only a `LinearTimeWarp` and a `FreezeFrame` have one; anything else reports `OTIO_STATUS_WRONG_KIND`.

OtioStatus otio_effect_time_scalar(
    const OtioDocument *source,
    OtioNode node_handle,
    double *out_scalar,
    OtioBuffer *out_error);

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