AudioEffectLimiter
Adds a soft-clip limiter audio effect to an Audio bus.
AudioEffectLimiter.swift:20class AudioEffectLimiter
A limiter is similar to a compressor, but it’s less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master bus is always recommended to reduce the effects of clipping.
Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.
Superclasses
class AudioEffect
Base class for audio effect resources.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with no conversion. These include all of the Variant types from Godot (for exampleGString
,Rect
,Plane
), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
var ceilingDb: Double
The waveform’s maximum allowed value, in decibels. Value can range from -20 to -0.1.
var softClipDb: Double
Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.
var softClipRatio: Double
var thresholdDb: Double
Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.