Skip to content

Initialization

When you first add fmod addon to your godot project, you need to setup fmod options within projects parameters.
Parameters are split in several categories:
- General
- Software Format
- Dsp
- 3d Settings

General

  • "Auto Initialize": If true, will start fmod on engine startup.
  • "Channel Count": Maximum number of Channel objects available for playback, also known as virtual voices. Virtual voices will play with minimal overhead, with a subset of 'real' voices that are mixed, and selected based on priority and audibility. See the Virtual Voices guide for more information.
  • "Live update": Enable live update.
  • "Memory Tracking": Enables detailed memory usage statistics. Increases memory footprint and impacts performance. See Studio::Bus::getMemoryUsage and Studio::EventInstance::getMemoryUsage for more information. Implies FMOD_INIT_MEMORY_TRACKING.
  • Default Listener count: set max listener count (should be between 1 and 8).
  • Should Load by Name: If true will load events and parameters by name instead of id when using fmod nodes.

general-tab

Software Format

software-format-tab

Dsp

  • "Dsp Buffer Size": The mixer engine block size. Use this to adjust mixer update granularity. Units: Samples Default: 1024
  • "Dsp Buffer Count": The mixer engine number of buffers used. Use this to adjust mixer latency. Default: 4

dsp-tab

3d Settings

  • "Doppler Scale": A scaling factor for doppler shift. Default 1.
  • "Distance Factor": A factor for converting game distance units to FMOD distance units. Default 1.
    !!! warning In 2D this value represents pixels, so you should set it to the number of pixel for your world meter (If your world meter is 64px, set it to 64). In 3D this represents meter, so we recommend to set it to 1.
  • "Rolloff Scale": A scaling factor for distance attenuation. When a sound uses a roll-off mode other than FMOD_3D_CUSTOMROLLOFF and the distance is greater than the sound's minimum distance, the distance is scaled by the roll-off scale.

3d-tab

Fmod explorer

When all is setup you can explore your project's banks using Fmod Explorer.
fmod-explorer