Godot-FmodPlayer Documentation#
Godot-FmodPlayer is a Godot 4 GDExtension plugin based on the FMOD Core API. It provides audio playback, mixing, DSP effects, 3D audio, and performance monitoring.
It is suitable for projects that need finer control than Godot’s built-in audio system, such as dynamic mixing, real-time audio processing, long streaming audio, spatial audio, and lower-level FMOD API integration.
Key Features#
Supports audio formats such as MP3, WAV, OGG, FLAC, MOD, XM, S3M, IT, and MIDI.
Supports streaming, sample loading, memory loading, and loading resources from Godot PCK files.
Provides
FmodAudioStreamPlayer,FmodAudioStreamPlayer2D, andFmodAudioStreamPlayer3Dplayback nodes.Supports channels, channel groups, audio buses, and real-time mixing control.
Provides DSP effects such as reverb, EQ, filtering, delay, distortion, compression, and spectrum analysis.
Supports FMOD CPU and file I/O performance monitoring.
Provides an editor importer, audio preview, and custom resource types.
Platform Support#
Platform |
Architecture |
Status |
|---|---|---|
Windows |
x86_64 |
Supported |
Android |
arm64 |
Supported |
Getting Started#
If this is your first time using the plugin, read the following sections in order:
Note
This plugin uses the FMOD Core API, not the FMOD Studio API. If your project depends on FMOD Studio Events, Banks, or the Studio workflow, see fmod-gdextension.
Important
The Godot-FmodPlayer plugin itself uses the MIT license. FMOD Engine is a proprietary audio engine by Firelight Technologies Pty Ltd. For commercial projects, read FMOD Licensing.
Documentation Navigation#
Getting Started
User Guide
- Audio Resources
- Playback Control
- Mixing System
- When is a mixing system needed
- Core Concepts
- Send Audio to a Bus
- Control Bus Volume, Mute, and Solo
- Synchronize with Godot Audio Buses
- Create Your Own Buses
- Add Effects to a Bus
- Fade In and Fade Out
- Lower Music to Make Room for Dialogue
- Advanced: When to Look at the Mix Matrix
- Performance and Troubleshooting
- Recommendations
- DSP Effects
- FAQ
- What licenses apply when using Godot-FmodPlayer?
- Does Godot-FmodPlayer support FMOD Studio Events or Banks?
- Why does Godot report that a specified module cannot be found after importing the plugin?
- Why is there no sound during playback?
- Which loading mode should I use for background music and short sound effects?
- Why does audio fail to play after export?
- Can Godot AudioStreamPlayer and FmodAudioStreamPlayer be used together?
- When do I need to release audio resources manually?
- What should I do if a DSP effect does not work?
- What should I watch out for on mobile platforms?
- How should I investigate crashes or FMOD errors?
API Reference
- Core API
- Audio Resource API
- Playback Control API
- Node API
- DSP Effect API
- FmodDSP
- FmodDSPConnection
- FmodAudioEffect
- FmodAudioEffectAmplify
- FmodAudioEffectFilter
- FmodAudioEffectEQ
- FmodAudioEffectEQ6
- FmodAudioEffectEQ10
- FmodAudioEffectEQ21
- FmodAudioEffectDelay
- FmodAudioEffectChorus
- FmodAudioEffectDistortion
- FmodAudioEffectPhaser
- FmodAudioEffectPitchShift
- FmodAudioEffectCompressor
- FmodAudioEffectHardLimiter
- FmodAudioEffectPanner
- FmodAudioEffectReverb
- FmodAudioEffectStereoEnhance
- FmodAudioEffectSpectrumAnalyzer
- FmodAudioEffectRecord
- FmodAudioEffectCapture
- Mixer API
- Spatial Audio API
贡献
Other