Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioEffect

Hérite de : Resource < RefCounted < Object

Hérité par : AudioEffectAmplify, AudioEffectCapture, AudioEffectChorus, AudioEffectCompressor, AudioEffectDelay, AudioEffectDistortion, AudioEffectEQ, AudioEffectFilter, AudioEffectHardLimiter, AudioEffectLimiter, AudioEffectPanner, AudioEffectPhaser, AudioEffectPitchShift, AudioEffectRecord, AudioEffectReverb, AudioEffectSpectrumAnalyzer, AudioEffectStereoEnhance

Classe de base pour les ressources d'effet audio.

Description

The base Resource for every audio effect. In the editor, an audio effect can be added to the current bus layout through the Audio panel. At run-time, it is also possible to manipulate audio effects through AudioServer.add_bus_effect(), AudioServer.remove_bus_effect(), and AudioServer.get_bus_effect().

When applied on a bus, an audio effect creates a corresponding AudioEffectInstance. The instance is directly responsible for manipulating sound, based on the original audio effect's properties.

Tutoriels

• Bus audio

• Audio effects

• Démo d'enregistrement de l'audio du microphone

Méthodes

AudioEffectInstance

_instantiate() virtual required

---

Descriptions des méthodes

AudioEffectInstance _instantiate() virtual required 🔗

Surcharger cette méthode pour personnaliser l'AudioEffectInstance créée lorsque cet effet est appliqué sur un bus dans le panneau Audio de l'éditeur, ou par AudioServer.add_bus_effect().

extends AudioEffect

@export var force = 4.0

func _instantiate():
    var effet = CustomAudioEffectInstance.new()
    effet.base = self

    return effet

Note : Il est recommandé de garder une référence à l'AudioEffect original dans la nouvelle instance. En fonction de l'implémentation, cela permet à l'instance d'effet d'écouter les changements durant l'exécution et d'être modifiée en conséquence.