pipeline.h File Reference

#include "irelease.h"
#include <cstdint>

Go to the source code of this file.

Classes
class	audio_effects_sdk::IPipeline
	Audio processing interface that applies noise suppression. More...

Enumerations
enum	audio_effects_sdk::LatencyMode : int32_t { audio_effects_sdk::file = 0 , audio_effects_sdk::streaming = 1 , audio_effects_sdk::playback = 2 }
	Latency mode indicates to the SDK how to handle delay based on different scenarios. More...

Enumeration Type Documentation

LatencyMode

enum audio_effects_sdk::LatencyMode : int32_t

Latency mode indicates to the SDK how to handle delay based on different scenarios.

Enumerator
file	Audio file processing scenario. Recommended when there is no real-time audio consumer (e.g., media file processing). Introduces no additional delay or buffering time beyond required processing. Disables smooth noise suppression startup. Note A small delay may occur if sample rate conversion is required. Residual audio can be read using IPipeline::flush().
streaming	For balanced real-time audio I/O processing. (Default mode). Optimized for audio streaming scenarios (e.g., WebRTC). Introduces minimal buffering and additional latency.
playback	Optimized for intermittent audio processing or loopback playing scenarios. This mode has the substantial buffering and higher delay.