FMOD_DSP_TRANSCEIVER_SPEAKERMODE

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_DSP_TRANSCEIVER_SPEAKERMODE

Parameter types for the FMOD_DSP_TRANSCEIVER_SPEAKERMODE parameter for FMOD_DSP_TYPE_TRANSCEIVER effect.

C/C++ Syntax

typedef enum {
  FMOD_DSP_TRANSCEIVER_SPEAKERMODE_AUTO,
  FMOD_DSP_TRANSCEIVER_SPEAKERMODE_MONO,
  FMOD_DSP_TRANSCEIVER_SPEAKERMODE_STEREO,
  FMOD_DSP_TRANSCEIVER_SPEAKERMODE_SURROUND
} FMOD_DSP_TRANSCEIVER_SPEAKERMODE;

JavaScript Syntax

FMOD.DSP_TRANSCEIVER_SPEAKERMODE_AUTO
FMOD.DSP_TRANSCEIVER_SPEAKERMODE_MONO
FMOD.DSP_TRANSCEIVER_SPEAKERMODE_STEREO
FMOD.DSP_TRANSCEIVER_SPEAKERMODE_SURROUND

Values

FMOD_DSP_TRANSCEIVER_SPEAKERMODE_AUTO

A transmitter will use whatever signal channel count coming in to the transmitter, to determine which speaker mode is allocated for the transceiver channel.

FMOD_DSP_TRANSCEIVER_SPEAKERMODE_MONO

A transmitter will always downmix to a mono channel buffer.

FMOD_DSP_TRANSCEIVER_SPEAKERMODE_STEREO

A transmitter will always upmix or downmix to a stereo channel buffer.

FMOD_DSP_TRANSCEIVER_SPEAKERMODE_SURROUND

A transmitter will always upmix or downmix to a surround channel buffer. Surround is the speaker mode of the system above stereo, so could be quad/surround/5.1/7.1.

Remarks

The speaker mode of a transceiver buffer (of which there are up to 32 of) is determined automatically depending on the signal flowing through the transceiver effect, or it can be forced. Use a smaller fixed speaker mode buffer to save memory.

Only relevant for transmitter dsps, as they control the format of the transceiver channel's buffer.

If multiple transceivers transmit to a single buffer in different speaker modes, it will allocate memory for each speaker mode. This uses more memory than a single speaker mode. If there are multiple receivers reading from a channel with multiple speaker modes, it will read them all and mix them together.

If the system's speaker mode is stereo or mono, it will not create a 3rd buffer, it will just use the mono/stereo speaker mode buffer.

See Also



Version 1.10.03 Built on Feb 1, 2018