Skip to content

Advanced Audio

Pro Extension

Pro audio effects animate properties on AudioStreamPlayer, AudioStreamPlayer2D, AudioStreamPlayer3D, and AudioServer buses.

Advanced Audio

Audio Pitch

GFFAudioPitch animates pitch_scale on an audio player.

Property Description
target_pitch Goal pitch value
pitch_mode TO_PITCH, ADDITIVE, or MULTIPLICATIVE
# Slow down a sound effect
GameFeelFlow.play("audio_pitch", $AudioStreamPlayer, GFFParams.create(1.0, 0.5).with_float("pitch", 0.5))

# Custom effect
var effect = GFFAudioPitch.new()
effect.target_pitch = 0.5
effect.pitch_mode = GFFAudioPitch.PitchMode.TO_PITCH
effect.duration = 0.5
GameFeelFlow.play(effect, $AudioStreamPlayer)

Audio Filter

GFFAudioFilter animates a low-pass filter cutoff on an audio player or bus.

GameFeelFlow.play("audio_filter", $AudioStreamPlayer, GFFParams.create(1.0, 0.5).with_float("cutoff", 500.0))

Audio Bus Volume

GFFAudioBusVolume animates the volume of an AudioServer bus.

Property Description
bus_name Name of the audio bus
target_volume_db Goal volume in decibels
# Duck the music bus during a cutscene
var effect = GFFAudioBusVolume.new()
effect.bus_name = "Music"
effect.target_volume_db = -20.0
effect.duration = 1.0
effect.restore_after_play = true
GameFeelFlow.play(effect, get_tree().root)

Restore Behavior

All Pro audio effects support restore_after_play. When enabled, the original pitch, filter, or volume is restored after the effect finishes.