Skip to main content
Version: 2.x

Update APM Playback

Updates the specified APM effect's sample buffer for processing the reverse (playback) audio stream. The provided samples must be interleaved float values in the range [-1, 1]. The delay parameter is used to align the reverse stream processing with the forward (capture) stream.

note

The delay can be expressed as:

delay = (t_render - t_analyze) + (t_process - t_capture)

where:

  • t_render is the time the first sample of the same frame is rendered by the audio hardware.

  • t_analyze is the time the frame is processed in the reverse stream.

  • t_capture is the time the first sample of a frame is captured by the audio hardware.

  • t_process is the time the frame is processed in the forward stream.

Inputs​

NameTypeDescription
TargetOdin PipelineThe Odin Pipeline to call this function on.
Effect IdIntegereffect id
DelayIntegerdelay in milliseconds (ms) Default: 10.

Outputs​

NameTypeDescription
SamplesArray of Floataudio buffer
Return ValueBooleantrue on success