org.jouvieje.fmodex.defines
Interface FMOD_INITFLAGS

public interface FMOD_INITFLAGS

Initialization flags. Use them with System::init in the flags parameter to change various behavior.

Remarks

Use System::setAdvancedSettings to adjust settings for some of the features that are enabled by these flags.

Platforms Supported

Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation 2, PlayStation Portable, PlayStation 3, Wii, Solaris, iPhone

See Also

System::init
System::update
System::setAdvancedSettings
Channel::set3DOcclusion

Field Summary

static int	FMOD_INIT_3D_RIGHTHANDED All platforms - FMOD will treat +X as right, +Y as up and +Z as backwards (towards you).
static int	FMOD_INIT_DISABLE_MYEARS Win32 - Disables MyEars HRTF 7.1 downmixing.
static int	FMOD_INIT_DSOUND_HRTFFULL Win32 only - for DirectSound output - FMOD_HARDWARE | FMOD_3D buffers use full quality 3D playback when 3d hardware acceleration is not present.
static int	FMOD_INIT_DSOUND_HRTFLIGHT Win32 only - for DirectSound output - FMOD_HARDWARE | FMOD_3D buffers use a slightly higher quality algorithm when 3D hardware acceleration is not present.
static int	FMOD_INIT_DSOUND_HRTFNONE Win32 only - for DirectSound output - FMOD_HARDWARE | FMOD_3D buffers use simple stereo panning/doppler/attenuation when 3D hardware acceleration is not present.
static int	FMOD_INIT_DTS_NEURALSURROUND Win32/Mac/Linux/Solaris/PS3/Xbox360 - Use DTS Neural surround downmixing from 7.1 if speakermode set to FMOD_SPEAKERMODE_STEREO or FMOD_SPEAKERMODE_5POINT1.
static int	FMOD_INIT_ENABLE_PROFILE All platforms - Enable TCP/IP based host which allows FMOD Designer or FMOD Profiler to connect to it, and view memory, CPU and the DSP network graph in real-time.
static int	FMOD_INIT_GEOMETRY_USECLOSEST All platforms - With the geometry engine, only process the closest polygon rather than accumulating all polygons the sound to listener line intersects.
static int	FMOD_INIT_NORMAL All platforms - Initialize normally
static int	FMOD_INIT_PS2_DISABLECORE0REVERB PS2 only - Disable reverb on CORE 0 to regain 256k SRAM.
static int	FMOD_INIT_PS2_DISABLECORE1REVERB PS2 only - Disable reverb on CORE 1 to regain 256k SRAM.
static int	FMOD_INIT_PS2_DONTUSESCRATCHPAD PS2 only - Disable FMOD's usage of the scratchpad.
static int	FMOD_INIT_PS2_SWAPDMACHANNELS PS2 only - Changes FMOD from using SPU DMA channel 0 for software mixing, and 1 for sound data upload/file streaming, to 1 and 0 respectively.
static int	FMOD_INIT_PS3_FORCE2CHLPCM PS3 only - Force PS3 system output mode to 2 channel LPCM.
static int	FMOD_INIT_PS3_PREFERDTS PS3 only - Prefer DTS over Dolby Digital if both are supported.
static int	FMOD_INIT_SOFTWARE_DISABLE All platforms - Disable software mixer to save memory.
static int	FMOD_INIT_SOFTWARE_HRTF All platforms - All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which causes sounds to sound duller when the sound goes behind the listener.
static int	FMOD_INIT_SOFTWARE_OCCLUSION All platforms - All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which is automatically used when Channel::set3DOcclusion is used or the geometry API.
static int	FMOD_INIT_SOFTWARE_REVERB_LOWMEM All platforms - SFX reverb is run using 22/24khz delay buffers, halving the memory required.
static int	FMOD_INIT_STREAM_FROM_UPDATE All platforms - No stream thread is created internally.
static int	FMOD_INIT_SYNCMIXERWITHUPDATE Win32/Wii/PS3/Xbox/Xbox 360 - FMOD Mixer thread is woken up to do a mix when System::update is called rather than waking periodically on its own timer.
static int	FMOD_INIT_SYSTEM_MUSICMUTENOTPAUSE Xbox 360 / PS3 - The "music" channelgroup which by default pauses when custom 360 dashboard / PS3 BGM music is played, can be changed to mute (therefore continues playing) instead of pausing, by using this flag.
static int	FMOD_INIT_VOL0_BECOMES_VIRTUAL All platforms - Any sounds that are 0 volume will go virtual and not be processed except for having their positions updated virtually.
static int	FMOD_INIT_WASAPI_EXCLUSIVE Win32 Vista only - for WASAPI output - Enable exclusive access to hardware, lower latency at the expense of excluding other applications from accessing the audio hardware.
static int	FMOD_INIT_WII_DISABLEDOLBY Wii only - Disable Dolby Pro Logic surround.

Field Detail

FMOD_INIT_NORMAL

public static final int FMOD_INIT_NORMAL

All platforms - Initialize normally

See Also:

Constant Field Values

FMOD_INIT_STREAM_FROM_UPDATE

public static final int FMOD_INIT_STREAM_FROM_UPDATE

All platforms - No stream thread is created internally. Streams are driven from System::update. Mainly used with non-realtime outputs.

See Also:

Constant Field Values

FMOD_INIT_3D_RIGHTHANDED

public static final int FMOD_INIT_3D_RIGHTHANDED

All platforms - FMOD will treat +X as right, +Y as up and +Z as backwards (towards you).

See Also:

Constant Field Values

FMOD_INIT_SOFTWARE_DISABLE

public static final int FMOD_INIT_SOFTWARE_DISABLE

All platforms - Disable software mixer to save memory. Anything created with FMOD_SOFTWARE will fail and DSP will not work.

See Also:

Constant Field Values

FMOD_INIT_SOFTWARE_OCCLUSION

public static final int FMOD_INIT_SOFTWARE_OCCLUSION

All platforms - All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which is automatically used when Channel::set3DOcclusion is used or the geometry API.

See Also:

Constant Field Values

FMOD_INIT_SOFTWARE_HRTF

public static final int FMOD_INIT_SOFTWARE_HRTF

All platforms - All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which causes sounds to sound duller when the sound goes behind the listener. Use System::setAdvancedSettings to adjust cutoff frequency.

See Also:

Constant Field Values

FMOD_INIT_SOFTWARE_REVERB_LOWMEM

public static final int FMOD_INIT_SOFTWARE_REVERB_LOWMEM

All platforms - SFX reverb is run using 22/24khz delay buffers, halving the memory required.

See Also:

Constant Field Values

FMOD_INIT_ENABLE_PROFILE

public static final int FMOD_INIT_ENABLE_PROFILE

All platforms - Enable TCP/IP based host which allows FMOD Designer or FMOD Profiler to connect to it, and view memory, CPU and the DSP network graph in real-time.

See Also:

Constant Field Values

FMOD_INIT_VOL0_BECOMES_VIRTUAL

public static final int FMOD_INIT_VOL0_BECOMES_VIRTUAL

All platforms - Any sounds that are 0 volume will go virtual and not be processed except for having their positions updated virtually. Use System::setAdvancedSettings to adjust what volume besides zero to switch to virtual at.

See Also:

Constant Field Values

FMOD_INIT_WASAPI_EXCLUSIVE

public static final int FMOD_INIT_WASAPI_EXCLUSIVE

Win32 Vista only - for WASAPI output - Enable exclusive access to hardware, lower latency at the expense of excluding other applications from accessing the audio hardware.

See Also:

Constant Field Values

FMOD_INIT_DSOUND_HRTFNONE

public static final int FMOD_INIT_DSOUND_HRTFNONE

Win32 only - for DirectSound output - FMOD_HARDWARE | FMOD_3D buffers use simple stereo panning/doppler/attenuation when 3D hardware acceleration is not present.

See Also:

Constant Field Values

FMOD_INIT_DSOUND_HRTFLIGHT

public static final int FMOD_INIT_DSOUND_HRTFLIGHT

Win32 only - for DirectSound output - FMOD_HARDWARE | FMOD_3D buffers use a slightly higher quality algorithm when 3D hardware acceleration is not present.

See Also:

Constant Field Values

FMOD_INIT_DSOUND_HRTFFULL

public static final int FMOD_INIT_DSOUND_HRTFFULL

Win32 only - for DirectSound output - FMOD_HARDWARE | FMOD_3D buffers use full quality 3D playback when 3d hardware acceleration is not present.

See Also:

Constant Field Values

FMOD_INIT_PS2_DISABLECORE0REVERB

public static final int FMOD_INIT_PS2_DISABLECORE0REVERB

PS2 only - Disable reverb on CORE 0 to regain 256k SRAM.

See Also:

Constant Field Values

FMOD_INIT_PS2_DISABLECORE1REVERB

public static final int FMOD_INIT_PS2_DISABLECORE1REVERB

PS2 only - Disable reverb on CORE 1 to regain 256k SRAM.

See Also:

Constant Field Values

FMOD_INIT_PS2_DONTUSESCRATCHPAD

public static final int FMOD_INIT_PS2_DONTUSESCRATCHPAD

PS2 only - Disable FMOD's usage of the scratchpad.

See Also:

Constant Field Values

FMOD_INIT_PS2_SWAPDMACHANNELS

public static final int FMOD_INIT_PS2_SWAPDMACHANNELS

PS2 only - Changes FMOD from using SPU DMA channel 0 for software mixing, and 1 for sound data upload/file streaming, to 1 and 0 respectively.

See Also:

Constant Field Values

FMOD_INIT_PS3_PREFERDTS

public static final int FMOD_INIT_PS3_PREFERDTS

PS3 only - Prefer DTS over Dolby Digital if both are supported. Note: 8 and 6 channel LPCM is always preferred over both DTS and Dolby Digital.

See Also:

Constant Field Values

FMOD_INIT_PS3_FORCE2CHLPCM

public static final int FMOD_INIT_PS3_FORCE2CHLPCM

PS3 only - Force PS3 system output mode to 2 channel LPCM.

See Also:

Constant Field Values

FMOD_INIT_WII_DISABLEDOLBY

public static final int FMOD_INIT_WII_DISABLEDOLBY

Wii only - Disable Dolby Pro Logic surround. Speakermode will be set to STEREO even if user has selected surround in the Wii system settings.

See Also:

Constant Field Values

FMOD_INIT_SYSTEM_MUSICMUTENOTPAUSE

public static final int FMOD_INIT_SYSTEM_MUSICMUTENOTPAUSE

Xbox 360 / PS3 - The "music" channelgroup which by default pauses when custom 360 dashboard / PS3 BGM music is played, can be changed to mute (therefore continues playing) instead of pausing, by using this flag.

See Also:

Constant Field Values

FMOD_INIT_SYNCMIXERWITHUPDATE

public static final int FMOD_INIT_SYNCMIXERWITHUPDATE

Win32/Wii/PS3/Xbox/Xbox 360 - FMOD Mixer thread is woken up to do a mix when System::update is called rather than waking periodically on its own timer.

See Also:

Constant Field Values

FMOD_INIT_DTS_NEURALSURROUND

public static final int FMOD_INIT_DTS_NEURALSURROUND

Win32/Mac/Linux/Solaris/PS3/Xbox360 - Use DTS Neural surround downmixing from 7.1 if speakermode set to FMOD_SPEAKERMODE_STEREO or FMOD_SPEAKERMODE_5POINT1. Always 7.1 -> 5.1 downmix for Xbox360 and PS3. Internal DSP structure will be set to 7.1.

See Also:

Constant Field Values

FMOD_INIT_GEOMETRY_USECLOSEST

public static final int FMOD_INIT_GEOMETRY_USECLOSEST

All platforms - With the geometry engine, only process the closest polygon rather than accumulating all polygons the sound to listener line intersects.

See Also:

Constant Field Values

FMOD_INIT_DISABLE_MYEARS

public static final int FMOD_INIT_DISABLE_MYEARS

Win32 - Disables MyEars HRTF 7.1 downmixing. MyEars will otherwise be disbaled if speakermode is not set to FMOD_SPEAKERMODE_STEREO or the data file is missing.

See Also:

Constant Field Values