Godot Fmod GdExtension

https://fmod-gdextension.readthedocs.io/en/latest/
Admin
A Godot C++ GDExtension for Godot 4 that integrates the FMOD Studio API, exposing most Studio API...
Tokens:5,425
Snippets:42
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get performance data in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/8-other-low-level-examples

Shows how to retrieve performance statistics from FMOD, including CPU, memory, and file streaming usage. Useful for profiling and monitoring audio system performance during development.

```GDScript
# called every frame
var perf_data = FmodServer.get_performance_data()

print(perf_data.CPU)
print(perf_data.memory)
print(perf_data.file)
```

--------------------------------

### Reduce audio latency in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/8-other-low-level-examples

Demonstrates how to adjust DSP buffer settings to reduce audio playback latency. These settings must be configured before FMOD initialization. Includes functions to query current buffer settings.

```GDScript
FmodServer.set_dsp_buffer_size(512, 4)
# retrieve the buffer length
FmodServer.get_dsp_buffer_length()
# retrieve the number of buffers
FmodServer.get_dsp_num_buffers()
```

--------------------------------

### Change audio output device in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/8-other-low-level-examples

Illustrates how to change the default audio output device in FMOD. Requires getting available drivers first and then setting the desired one by ID. Useful for implementing audio device selection in options menus.

```GDScript
# retrieve all available audio drivers
var drivers = FmodServer.get_available_drivers() # change the audio driver
# you must pass in the id of the respective driver
FmodServer.set_driver(id) # retrieve the id of the currently set driver var id = FmodServer.get_driver()
```

--------------------------------

### Load Banks using FmodServer API in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/4-loading-banks

Demonstrates how to load FMOD audio banks programmatically using the FmodServer singleton in GDScript. It shows loading 'Master.bank', 'Master.strings.bank', and 'Music.bank' with the normal loading flags. Ensure dependency banks are loaded first.

```gdscript
var banks := Array()

func _ready():
    banks.append(FmodServer.load_bank("res://Master.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL))
    banks.append(FmodServer.load_bank("res://Master.strings.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL))
    banks.append(FmodServer.load_bank("res://Music.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL))

```

--------------------------------

### Playing Sounds with FMOD in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/7-playing-sounds

This GDScript example demonstrates loading a music file, connecting area enter/exit signals, creating and playing sound instances on entry, releasing sounds on exit, and unloading the file when the node is removed from the scene tree. It depends on FMOD GDExtension and Godot's Area2D node. Inputs include signal connections; outputs are sound playback and console prints. Limitations include assuming the OGG file path is correct and handling of sound resources.

```GDScript
extends Area2D

# Declare member variables here. Examples:
# var a = 2
var music: FmodSound = null

# Called when the node enters the scene tree for the first time.
func _ready():
    FmodServer.load_file_as_music("res://assets/Music/jingles_SAX07.ogg")
# warning-ignore:return_value_discarded
    body_entered.connect(enter)
# warning-ignore:return_value_discarded
    body_exited.connect(leave)

# warning-ignore:unused_argument
func enter(_area):
    print("enter")
    music = FmodServer.create_sound_instance("res://assets/Music/jingles_SAX07.ogg")
    music.play()

# warning-ignore:unused_argument
func leave(_area):
    print("leave")
    music.release()

func _exit_tree():
    FmodServer.unload_file("res://assets/Music/jingles_SAX07.ogg")

```

--------------------------------

### Mute all events using FmodServer in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/8-other-low-level-examples

Demonstrates how to mute all audio events in FMOD. This function mutes the master bus and can be used to temporarily silence all audio. Requires FMOD initialization and bank loading beforehand.

```GDScript
func _ready():
    FmodServer.set_software_format(0, FmodServer.FMOD_SPEAKERMODE_STEREO, 0)
    FmodServer.init(1024, FmodServer.FMOD_STUDIO_INIT_LIVEUPDATE, FmodServer.FMOD_INIT_NORMAL)
    FmodServer.set_sound_3d_settings(1.0, 64.0, 1.0)

    # load banks
    FmodServer.load_bank("res://Master.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)
    FmodServer.load_bank("res://Master.strings.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)
    FmodServer.load_bank("res://Music.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)

    # register listener
    FmodServer.add_listener(0, self)

    # play some events
    FmodServer.play_one_shot("event:/Music/Level 02", self)
    var my_music_event = FmodServer.create_event_instance("event:/Music/Level 01")
    FmodServer.start_event(my_music_event)
    var t = Timer.new()
    t.set_wait_time(3)
    t.set_one_shot(true)
    self.add_child(t)
    t.start()
    yield(t, "timeout")
    FmodServer.mute_all_events();
    t = Timer.new()
    t.set_wait_time(3)
    t.set_one_shot(true)
    self.add_child(t)
    t.start()
    yield(t, "timeout")
    FmodServer.unmute_all_events()
```

--------------------------------

### Setting and Getting FMOD Parameters Using Methods in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/5-playing-events

This example shows how to use set_parameter, set_parameter_by_id, get_parameter, and get_parameter_by_id methods on an FmodEventEmitter to modify and retrieve parameter values. It assumes an emitter instance and a loaded event with named or ID-based parameters like 'RPM'. Useful for precise control without property paths; IDs are specific to FMOD events.

```GDScript
emitter.set_parameter("RPM", 1000)
emitter.set_parameter_by_id(5864137074015534804, 1000)

emitter.get_parameter("RPM")
emitter.get_parameter_by_id(5864137074015534804)
```

--------------------------------

### Pause all events using FmodServer in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/8-other-low-level-examples

Shows how to pause all audio events in FMOD. This can be used to temporarily stop all audio playback. Requires FMOD initialization and bank loading similar to muting functionality.

```GDScript
func _ready():
    # set up FMOD
    FmodServer.set_software_format(0, FmodServer.FMOD_SPEAKERMODE_STEREO, 0)
    FmodServer.init(1024, FmodServer.FMOD_STUDIO_INIT_LIVEUPDATE, FmodServer.FMOD_INIT_NORMAL)
    FmodServer.set_sound_3d_settings(1/0, 64.0, 1.0)

    # load banks
    FmodServer.load_bank("res://Master.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)
    FmodServer.load_bank("res://Master.strings.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)
    FmodServer.load_bank("res://Music.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)

    # register listener
    FmodServer.add_listener(0, self)

    # play some events
    FmodServer.play_one_shot("event:/Music/Level 02", self)
    var my_music_event = FmodServer.create_event_instance("event:/Music/Level 01")
    FmodServer.start_event(my_music_event)
    var t = Timer.new()
    t.set_wait_time(3)
    t.set_one_shot(true)
    self.add_child(t)
    t.start()
    yield(t, "timeout")
    FmodServer.pause_all_events(true)
    t = Timer.new()
    t.set_wait_time(3)
    t.set_one_shot(true)
    self.add_child(t)
    t.start()
    yield(t, "timeout")
    FmodServer.pause_all_events(false)
```

--------------------------------

### Configuring FmodEventEmitter with Programmer Callback in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/5-playing-events

This script creates a new FmodEventEmitter2D instance, sets its event GUID, enables autoplay, assigns a programmer callback from an audio table, and adds it to the scene. Requires the relevant FMOD bank (e.g., Dialogue_EN.bank) to be loaded beforehand for the callback to function. The callback key like 'welcome' triggers custom FMOD logic during playback.

```GDScript
var event_emitter = FmodEventEmitter2D.new()
event_emitter.event_guid = "{9aa2ecc5-ea4b-4ebe-85c3-054b11b21dcd}" # event:/Character/Dialogue from sfx bank.
event_emitter.autoplay = true
event_emitter.set_programmer_callback("welcome") # welcome key from audio table in Dialogue_EN.bank, Dialogue_JP.bank and Dialogue_CN.bank. One of those bank should be loaded.
add_child(event_emitter)
```

--------------------------------

### Create and Control FMOD Event Instance in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/5-playing-events

Creates an FMOD event instance, sets its 2D attributes and parameters, and controls playback. It uses the FmodServer to create the event and allows pausing/resuming playback via input actions. Dependencies include the FmodServer and FmodEvent classes.

```gdscript
extends Area2D

var event: FmodEvent = null
var isPlaying = true

# Called when the node enters the scene tree for the first time.
func _ready():
    event = FmodServer.create_event_instance("event:/Vehicles/Car Engine")
    event.set_2d_attributes(self.global_transform)
    event.set_parameter_by_name("RPM", 600)
    event.volume = 2
    event.start()

# warning-ignore:unused_argument
func _process(_delta):
    if Input.is_action_just_pressed("space"):
        isPlaying = !isPlaying
        if(isPlaying):
            print("Mower playing")
            event.paused = false
        else:
            print("Mower paused")
            event.paused = true
    elif Input.is_action_just_pressed("kill_event"):
        self.queue_free()
```

--------------------------------

### Load Bank and Set Programmer Callback for FMOD Event in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/5-playing-events

Loads an FMOD bank containing audio table entries and creates an event instance. It then sets a programmer callback using a key from the audio table to specify which audio to play. This is useful for events with specific audio table entries referenced by keys.

```gdscript
FmodServer.load_bank("res://assets/Banks/Dialogue_EN.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)
var event_instance = FmodServer.create_event_instance("event:/Character/Dialogue") # event from sfx bank.
event_instance.set_programmer_callback("welcome") # welcome key in audio table from Dialogue bank.
event_instance.start()
```

--------------------------------

### Adjusting FMOD Parameters Using Property Paths in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/5-playing-events

This snippet demonstrates controlling FMOD event parameters dynamically via Godot's property paths in a script extending FmodEventEmitter2D. It increments or decrements the 'RPM' parameter based on input actions in the _process function. Requires an event with the 'RPM' parameter loaded; outputs affect event audio behavior.

```GDScript
extends FmodEventEmitter2D

func _process(_delta):
    if Input.is_action_pressed("engine_power_up"):
        self["fmod_parameters/RPM"] = self["fmod_parameters/RPM"] + 10
    if Input.is_action_pressed("engine_power_down"):
        self["fmod_parameters/RPM"] = self["fmod_parameters/RPM"] - 10
```

--------------------------------

### Add FMOD Listener using FmodServer API (GDScript)

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/6-listeners

Adds an FMOD listener with a specified index and attaches it to the current node. This is useful for defining audio listener points in your game world.

```gdscript
func _ready():
    FmodServer.add_listener(0, self)
```

--------------------------------

### Set FMOD Event Callback and Connect Signals in GDScript

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/5-playing-events

Creates an FMOD event instance and attaches a callback function that modifies the node's color on timeline beats. It also connects signals for body entry and exit to control event pausing. Dependencies include FmodServer, FmodEvent, Sprite2D, and Area2D.

```gdscript
extends Area2D

var event: FmodEvent = null
var icon: Sprite2D

# Called when the node enters the scene tree for the first time.
func _ready():
    event = FmodServer.create_event_instance("event:/Music/Level 02")
    event.set_callback(Callable(self, "change_color"), FmodServer.FMOD_STUDIO_EVENT_CALLBACK_ALL)
    body_entered.connect(enter)
    body_exited.connect(leave)
    event.start()
    event.paused = true

# warning-ignore:unused_argument
func enter(_area):
    print("enter")
    event.paused = false

# warning-ignore:unused_argument
func leave(_area):
    print("leave")
    event.paused = true

# warning-ignore:unused_argument
func change_color(_dict: Dictionary, type: int):
    if type == FmodServer.FMOD_STUDIO_EVENT_CALLBACK_TIMELINE_BEAT:
        $icon.self_modulate = Color(randf_range(0,1), randf_range(0,1), randf_range(0,1), 1)
```

--------------------------------

### Set FMOD Listener Weight using FmodServer API (GDScript)

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/6-listeners

Sets the weight for a specific FMOD listener index. Listener weight is used in calculating the relative contribution of a listener to the final sound mix.

```gdscript
FmodServer.set_system_listener_weight(0, 1.5)
```

--------------------------------

### Remove FMOD Listener using FmodServer API (GDScript)

Source: https://fmod-gdextension.readthedocs.io/en/latest/user-guide/6-listeners

Removes an FMOD listener with a specified index that is attached to the current node. This is used when a listener is no longer needed or its context has changed.

```gdscript
func _ready():
    FmodServer.remove_listener(0, self)
```
Tokens:
Raw