FMOD_SPEAKERMODE

FMOD Studio API

previous page next page

Firelight Technologies FMOD Studio API

FMOD_SPEAKERMODE

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

C/C++ Syntax

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_7POINT1POINT4,
  FMOD_SPEAKERMODE_MAX
} FMOD_SPEAKERMODE;

JavaScript Syntax

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_FORCEINT

Values

FMOD_SPEAKERMODE_DEFAULT

Default speaker mode for the chosen output mode which will resolve after System::init.

FMOD_SPEAKERMODE_RAW

Assume there is no special mapping from a given channel to a speaker, channels map 1:1 in order. Use System::setSoftwareFormat to specify the speaker count.

FMOD_SPEAKERMODE_MONO

1 speaker setup (monaural).

FMOD_SPEAKERMODE_STEREO

2 speaker setup (stereo) front left, front right.

FMOD_SPEAKERMODE_QUAD

4 speaker setup (4.0) front left, front right, surround left, surround right.

FMOD_SPEAKERMODE_SURROUND

5 speaker setup (5.0) front left, front right, center, surround left, surround right.

FMOD_SPEAKERMODE_5POINT1

6 speaker setup (5.1) front left, front right, center, low frequency, surround left, surround right.

FMOD_SPEAKERMODE_7POINT1

8 speaker setup (7.1) front left, front right, center, low frequency, surround left, surround right, back left, back right.

FMOD_SPEAKERMODE_7POINT1POINT4

12 speaker setup (7.1.4) front left, front right, center, low frequency, surround left, surround right, back left, back right, top front left, top front right, top back left, top back right.

FMOD_SPEAKERMODE_MAX

Maximum number of speaker modes supported.

Remarks

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.
  • Mix behavior for multichannel sounds can be set with Channel::setPanMatrix.
  • Channel::setPanLevels works but only front left and right parameters are used, the rest are ignored.

    FMOD_SPEAKERMODE_QUAD
    ------------------------
    This mode is for 4 speaker arrangements that have a front left, front right, surround left and a surround right speaker.
  • Mono sounds default to an even distribution between front left and front right. They can be panned with Channel::setPan.
  • Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right.
  • They can be cross faded with Channel::setPan.
  • Multichannel sounds default to all of their sound channels being played on each speaker in order of input.
  • Mix behavior for multichannel sounds can be set with Channel::setPanMatrix.
  • Channel::setPanLevels works but rear left, rear right, center and lfe are ignored.

    FMOD_SPEAKERMODE_SURROUND
    ------------------------
    This mode is for 5 speaker arrangements that have a left/right/center/surround left/surround right.
  • Mono sounds default to the center speaker. They can be panned with Channel::setPan.
  • Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right.
  • They can be cross faded with Channel::setPan.
  • Multichannel sounds default to all of their sound channels being played on each speaker in order of input.
  • Mix behavior for multichannel sounds can be set with Channel::setPanMatrix.
  • Channel::setPanLevels works but rear left / rear right are ignored.

    FMOD_SPEAKERMODE_5POINT1
    ---------------------------------------------------------
    This mode is for 5.1 speaker arrangements that have a left/right/center/surround left/surround right and a subwoofer speaker.
  • Mono sounds default to the center speaker. They can be panned with Channel::setPan.
  • Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right.
  • They can be cross faded with Channel::setPan.
  • Multichannel sounds default to all of their sound channels being played on each speaker in order of input.
  • Mix behavior for multichannel sounds can be set with Channel::setPanMatrix.
  • Channel::setPanLevels works but rear left / rear right are ignored.

    FMOD_SPEAKERMODE_7POINT1
    ------------------------
    This mode is for 7.1 speaker arrangements that have a left/right/center/surround left/surround right/rear left/rear right and a subwoofer speaker.
  • Mono sounds default to the center speaker. They can be panned with Channel::setPan.
  • Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right.
  • They can be cross faded with Channel::setPan.
  • Multichannel sounds default to all of their sound channels being played on each speaker in order of input.
  • Mix behavior for multichannel sounds can be set with Channel::setPanMatrix.
  • Channel::setPanLevels works and every parameter is used to set the balance of a sound in any speaker.

    • See Also




    Version 1.10.03 Built on Feb 1, 2018


    previous page start next page