Firelight Technologies FMOD Studio API

FMOD_DSP_TRANSCEIVER

Parameter types for the FMOD_DSP_TYPE_TRANSCEIVER filter.

C/C++ Syntax

typedef enum {
  FMOD_DSP_TRANSCEIVER_TRANSMIT,
  FMOD_DSP_TRANSCEIVER_GAIN,
  FMOD_DSP_TRANSCEIVER_CHANNEL,
  FMOD_DSP_TRANSCEIVER_TRANSMITSPEAKERMODE
} FMOD_DSP_TRANSCEIVER;

JavaScript Syntax

FMOD.DSP_TRANSCEIVER_TRANSMIT
FMOD.DSP_TRANSCEIVER_GAIN
FMOD.DSP_TRANSCEIVER_CHANNEL
FMOD.DSP_TRANSCEIVER_TRANSMITSPEAKERMODE

Values

FMOD_DSP_TRANSCEIVER_TRANSMIT

(Type:bool) - [r/w] - FALSE = Transceiver is a 'receiver' (like a return) and accepts data from a channel. TRUE = Transceiver is a 'transmitter' (like a send). Default = FALSE.

FMOD_DSP_TRANSCEIVER_GAIN

(Type:float) - [r/w] - Gain to receive or transmit at in dB. -80.0 to 10.0. Default = 0.

FMOD_DSP_TRANSCEIVER_CHANNEL

(Type:int) - [r/w] - Integer to select current global slot, shared by all Transceivers, that can be transmitted to or received from. 0 to 31. Default = 0.

FMOD_DSP_TRANSCEIVER_TRANSMITSPEAKERMODE

(Type:int) - [r/w] - Speaker mode (transmitter mode only). Specifies either 0 (Auto) Default = 0.

Remarks

The transceiver only transmits and receives to a global array of 32 channels. The transceiver can be set to receiver mode (like a return) and can receive the signal at a variable gain (FMOD_DSP_TRANSCEIVER_GAIN). The transceiver can also be set to transmit to a chnnel (like a send) and can transmit the signal with a variable gain (FMOD_DSP_TRANSCEIVER_GAIN).

The FMOD_DSP_TRANSCEIVER_TRANSMITSPEAKERMODE is only applicable to the transmission format, not the receive format. This means this parameter is ignored in 'receive mode'. This allows receivers to receive at the speaker mode of the user's choice. Receiving from a mono channel, is cheaper than receiving from a surround channel for example. The 3 speaker modes FMOD_DSP_TRANSCEIVER_SPEAKERMODE_MONO, FMOD_DSP_TRANSCEIVER_SPEAKERMODE_STEREO, FMOD_DSP_TRANSCEIVER_SPEAKERMODE_SURROUND are stored as seperate buffers in memory for a tranmitter channel. To save memory, use 1 common speaker mode for a transmitter.

The transceiver is double buffered to avoid desyncing of transmitters and receivers. This means there will be a 1 block delay on a receiver, compared to the data sent from a transmitter.

Multiple transmitters sending to the same channel will be mixed together.

See Also

• DSP::setParameterFloat
• DSP::getParameterFloat
• DSP::setParameterInt
• DSP::getParameterInt
• DSP::setParameterBool
• DSP::getParameterBool
• FMOD_DSP_TYPE

Version 1.10.03 Built on Feb 1, 2018