FMOD_SPEAKERMODE

These are speaker types defined for use with the System::setSoftwareFormat command.

Enumeration

typedef enum {
  FMOD_SPEAKERMODE_DEFAULT,
  FMOD_SPEAKERMODE_RAW,
  FMOD_SPEAKERMODE_MONO,
  FMOD_SPEAKERMODE_STEREO,
  FMOD_SPEAKERMODE_QUAD,
  FMOD_SPEAKERMODE_SURROUND,
  FMOD_SPEAKERMODE_5POINT1,
  FMOD_SPEAKERMODE_7POINT1,
  FMOD_SPEAKERMODE_MAX
} FMOD_SPEAKERMODE;

Values

FMOD_SPEAKERMODE_DEFAULT

Default speaker mode based on operating system/output mode. Windows = control panel setting, Xbox = 5.1, PS3 = 7.1 etc.

FMOD_SPEAKERMODE_RAW

There is no specific speakermode. Sound channels are mapped in order of input to output. Use System::setSoftwareFormat to specify speaker count. See remarks for more information.

FMOD_SPEAKERMODE_MONO

The speakers are monaural.

FMOD_SPEAKERMODE_STEREO

The speakers are stereo.

FMOD_SPEAKERMODE_QUAD

4 speaker setup. This includes front left, front right, surround left, surround right.

FMOD_SPEAKERMODE_SURROUND

5 speaker setup. This includes front left, front right, center, surround left, surround right.

FMOD_SPEAKERMODE_5POINT1

5.1 speaker setup. This includes front left, front right, center, surround left, surround right and an LFE speaker.

FMOD_SPEAKERMODE_7POINT1

7.1 speaker setup. This includes front left, front right, center, surround left, surround right, back left, back right and an LFE speaker.

FMOD_SPEAKERMODE_MAX

Maximum number of speaker modes supported.

Remarks

These are important notes on speaker modes in regards to sounds created with FMOD_SOFTWARE.
Note below the phrase 'sound channels' is used. These are the subchannels inside a sound, they are not related and have nothing to do with the FMOD class "Channel".
For example a mono sound has 1 sound channel, a stereo sound has 2 sound channels, and an AC3 or 6 channel wav file have 6 "sound channels".

FMOD_SPEAKERMODE_RAW
---------------------
This mode is for output devices that are not specifically mono/stereo/quad/surround/5.1 or 7.1, but are multichannel.
Use System::setSoftwareFormat to specify the number of speakers you want to address, otherwise it will default to 2 (stereo).
Sound channels map to speakers sequentially, so a mono sound maps to output speaker 0, stereo sound maps to output speaker 0 & 1.
The user assumes knowledge of the speaker order. FMOD_SPEAKER enumerations may not apply, so raw channel indices should be used.
Multichannel sounds map input channels to output channels 1:1.
Channel::setPan and Channel::setPanLevels do not work.
Speaker levels must be manually set with Channel::setPanMatrix.

FMOD_SPEAKERMODE_MONO
---------------------
This mode is for a 1 speaker arrangement.
Panning does not work in this speaker mode.
Mono, stereo and multichannel sounds have each sound channel played on the one speaker unity.
Mix behavior for multichannel sounds can be set with Channel::setPanMatrix.
Channel::setPanLevels does not work.

FMOD_SPEAKERMODE_STEREO
-----------------------
This mode is for 2 speaker arrangements that have a left and right speaker.

Mono sounds default to an even distribution between left and right. They can be panned with Channel::setPan.

Stereo sounds default to the middle, or full left in the left speaker and full right in the right speaker.

They can be cross faded with Channel::setPan.

Multichannel sounds have each sound channel played on each speaker at unity.