AudioEffectType

Enumerates the types of audio effects available in the Klarinet SDK.

Each value corresponds to a native DSP processor that can be instantiated via AudioEngine.createEffect. The associated parameter constants object (e.g., GainParams, CompressorParams) defines the parameter IDs for configuring each effect type.

See also

Entries

Link copied to clipboard

Adjusts the signal level. Use GainParams for parameter IDs.

Link copied to clipboard

Controls stereo positioning by distributing signal between left and right channels. Use PanParams for parameter IDs.

Link copied to clipboard

Mutes or solos the signal, useful in multi-track mixing scenarios. Use MuteSoloParams for parameter IDs.

Link copied to clipboard

Reduces dynamic range by attenuating signals above a threshold, making loud and quiet parts more even. Use CompressorParams for parameter IDs.

Link copied to clipboard

Prevents signal from exceeding a ceiling level, acting as a brick-wall compressor with a very high ratio. Use LimiterParams for parameter IDs.

Link copied to clipboard

Silences signals that fall below a threshold, reducing background noise during quiet passages. Use NoiseGateParams for parameter IDs.

Link copied to clipboard

A multi-band equalizer that boosts or cuts specific frequency ranges with adjustable center frequency, gain, Q factor, and filter type per band. Use EQParams for parameter IDs.

Link copied to clipboard

Attenuates frequencies above a cutoff point, allowing only lower frequencies to pass through. Use LPFParams for parameter IDs.

Link copied to clipboard

Attenuates frequencies below a cutoff point, allowing only higher frequencies to pass through. Use HPFParams for parameter IDs.

Link copied to clipboard

Passes frequencies within a range around a center frequency and attenuates those outside it. Use BPFParams for parameter IDs.

Link copied to clipboard

Creates echoes by repeating the signal after a configurable time interval with optional feedback. Use DelayParams for parameter IDs.

Link copied to clipboard

Simulates acoustic spaces by blending the original signal with reflections, producing a sense of room or hall ambience. Use ReverbParams for parameter IDs.

Link copied to clipboard

Creates a shimmering, thickened sound by mixing the signal with slightly detuned, modulated copies of itself. Use ChorusParams for parameter IDs.

Link copied to clipboard

Produces a sweeping, jet-like effect by mixing the signal with a short, modulated delayed copy and feeding it back. Use FlangerParams for parameter IDs.

Link copied to clipboard

Creates a sweeping, notch-filter effect by splitting the signal through a series of all-pass filters with modulated phase shifts. Use PhaserParams for parameter IDs.

Link copied to clipboard

Produces a rhythmic volume modulation by periodically varying the signal amplitude. Use TremoloParams for parameter IDs.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
expect val name: String
Link copied to clipboard
expect val ordinal: Int

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.