Firelight Technologies FMOD Studio API

DSP::getChannelFormat

Gets the input signal format for a dsp units read/process callback, to determine which speakers the signal will be processed on and how many channels will be processed.

C++ Syntax

FMOD_RESULT DSP::getChannelFormat(
  FMOD_CHANNELMASK *channelmask,
  int *numchannels,
  FMOD_SPEAKERMODE *source_speakermode
);

C Syntax

FMOD_RESULT FMOD_DSP_GetChannelFormat(
  FMOD_DSP *dsp,
  FMOD_CHANNELMASK *channelmask,
  int *numchannels,
  FMOD_SPEAKERMODE *source_speakermode
);

Parameters

channelmask

Address of a variable that receives the FMOD_CHANNELMASK which determines which speakers are represented by the channels in the input signal.

numchannels

Address of a variable that receives the number of channels to be processed on this unit.

source_speakermode

Address of a variable that receives the source speaker mode where the signal came from.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

source_speakermode is informational, when channelmask describes what bits are active, and numchannels describes how many channels are in a buffer, source_speakermode describes where the channels originated from. For example if numchannels = 2 then this could describe for the DSP if the original signal started from a stereo signal or a 5.1 signal. In the 5.1 signal the channels described might only represent 2 surround speakers for example.

See Also

• FMOD_CHANNELMASK
• DSP::setChannelFormat

Version 1.03.06 Built on Apr 17, 2014