Struct gdnative_bindings_lily::AudioEffectCompressor [−][src]
pub struct AudioEffectCompressor { /* fields omitted */ }
Expand description
core class AudioEffectCompressor
inherits AudioEffect
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
AudioEffectCompressor inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Compressor’s reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000.
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet).
Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48.
Compressor’s delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000.
Reduce the sound level using another audio bus for threshold detection.
The level above which compression is applied to the audio. Value can range from -60 to 0.
Compressor’s reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000.
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet).
Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48.
Compressor’s delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000.
Reduce the sound level using another audio bus for threshold detection.
The level above which compression is applied to the audio. Value can range from -60 to 0.
Trait Implementations
type Target = AudioEffect
type Target = AudioEffect
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for AudioEffectCompressor
impl !Send for AudioEffectCompressor
impl !Sync for AudioEffectCompressor
impl Unpin for AudioEffectCompressor
impl UnwindSafe for AudioEffectCompressor