Skip to main content

odin_pipeline_insert_custom_effect

enum OdinError odin_pipeline_insert_custom_effect(const struct OdinPipeline *pipeline,
uint32_t index,
OdinCustomEffectCallback callback,
const void *user_data,
uint32_t *out_effect_id);

Overview

Inserts a user-defined custom effect at the specified index in the audio pipeline. The effect is implemented via a callback function and associated user data. A unique effect identifier is returned.

Parameters

NameTypeDescription
pipelineconst struct OdinPipeline *The pipeline handle.
indexuint32_tThe index at which to insert the effect.
callbackOdinCustomEffectCallbackThe callback function for the effect.
user_dataconst void *User data passed to the callback.
out_effect_iduint32_t *Pointer to receive the new effect ID.

Return Value

TypeDescription
OdinErrorODIN_ERROR_SUCCESS on success.