FMOD
[Sound]

Functionality specific to the FMOD SFX implementation. More...

Classes
class	SFXFMODEvent
	A playable sound event in an FMOD Designer audio project. More...
class	SFXFMODEventGroup
	A group of events in an imported FMOD Designer project. More...
class	SFXFMODEventSource
	A sound source controller playing an FMOD Designer event (SFXFMODEvent). More...
class	SFXFMODProject
	An FMOD Designer project loaded into Torque. More...
Functions
void	fmodDumpDSPInfo ()
	Dump information about the standard DSP effects.
void	fmodDumpMemoryStats ()
Variables
bool	$pref::SFX::FMOD::disableSoftware
	Whether to disable the FMOD software mixer to conserve memory.
string	$pref::SFX::FMOD::DSoundHRTF
	The type of HRTF to use for hardware-mixed 3D sounds when FMOD is using DirectSound for sound output and hardware-acceleration is not available.
bool	$pref::SFX::FMOD::enableProfile
	Whether to enable support for FMOD's profiler.
int	$SFX::Device::fmodCoreMem
	Current number of bytes allocated by the core FMOD sound system.
int	$SFX::Device::fmodEventMem
	Current number of bytes allocated by the FMOD Designer event system.
int	$SFX::Device::fmodNumEventSources
	The current number of SFXFMODEventSource instances in the system.
string	$pref::SFX::FMOD::pluginPath
	Path to additional FMOD plugins.
bool	$pref::SFX::FMOD::useSoftwareHRTF
	Whether to enable HRTF in FMOD's software mixer.
bool	$pref::SFX::FMOD::useSoftwareReverbLowmem
	If true, FMOD's SFX reverb is run using 22/24kHz delay buffers, halving the memory required.

---

Detailed Description

Functionality specific to the FMOD SFX implementation.

When using FMOD for audio output in combination with Torque's sound system, an extended set of features is available to the user. This includes:

• Reverb support
• Enhanced voice virtualization
• Support for multiple listeners
• Enhanced sound format support
  • .aiff
  • .asf
  • .asx
  • .dls
  • .flac
  • .fsb
  • .it
  • .m3u
  • .mid
  • .mod
  • .mp2
  • .mp3
  • .ogg
  • .pls
  • .s3m
  • .vag
  • .wav
  • .wax
  • .wma
  • .xm
  • .xma (on Xbox only)
• FMOD Designer enhanced audio design support

See also:

http://www.fmod.org

FMOD Designer Audio

Using the FMOD Profiler with Torque

FMOD's profiler tool allows to inspect the operation of the FMOD sound system at runtime. To use the tool with Torque, set $pref::SFX::FMOD::enableProfile to true and either restart Torque or reinitialize the FMOD device (e.g. by switching back and forth to the device). After that, you can connect to the running Torque instance from within the FMOD profiler tool.

---

Function Documentation

void fmodDumpDSPInfo

(

)

Dump information about the standard DSP effects.

void fmodDumpMemoryStats

(

)

Returns:

Prints the current memory consumption of the FMOD module

---

Variable Documentation

bool $pref::SFX::FMOD::disableSoftware

Whether to disable the FMOD software mixer to conserve memory.

All sounds not created with SFXDescription::useHardware or using DSP effects will fail to load.

Note:

Only applies when using an FMOD sound device.

string $pref::SFX::FMOD::DSoundHRTF

The type of HRTF to use for hardware-mixed 3D sounds when FMOD is using DirectSound for sound output and hardware-acceleration is not available.

Options are

• "none": simple stereo panning/doppler/attenuation
• "light": slightly higher quality than "none"
• "full": full quality 3D playback

Note:

Only applies when using an FMOD sound device.

bool $pref::SFX::FMOD::enableProfile

Whether to enable support for FMOD's profiler.

Note:

Only applies when using an FMOD sound device.

Using the FMOD Profiler with Torque

int $SFX::Device::fmodCoreMem

Current number of bytes allocated by the core FMOD sound system.

Note:

Only relevant if an FMOD sound device is used.

int $SFX::Device::fmodEventMem

Current number of bytes allocated by the FMOD Designer event system.

Note:

Only relevant if an FMOD sound device is used and the FMOD event DLL is loaded.

int $SFX::Device::fmodNumEventSources

The current number of SFXFMODEventSource instances in the system.

This tells the number of sounds in the system that are currently playing FMOD Designer events.

Note:

Only relevant if an FMOD sound device is used.

string $pref::SFX::FMOD::pluginPath

Path to additional FMOD plugins.

Note:

Only applies when using an FMOD sound device.

bool $pref::SFX::FMOD::useSoftwareHRTF

Whether to enable HRTF in FMOD's software mixer.

This will add a lowpass filter effect to the DSP effect chain of all sounds mixed in software.

Note:

Only applies when using an FMOD sound device.

bool $pref::SFX::FMOD::useSoftwareReverbLowmem

If true, FMOD's SFX reverb is run using 22/24kHz delay buffers, halving the memory required.

Note:

Only applies when using an FMOD sound device.