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
);
C# Syntax
RESULT DSP.getChannelFormat(
out CHANNELMASK channelmask,
out int numchannels,
out SPEAKERMODE source_speakermode
);
JavaScript Syntax
DSP.getChannelFormat(
channelmask, // writes value to channelmask.val
numchannels, // writes value to numchannels.val
source_speakermode // writes value to source_speakermode.val
);
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
Version 1.10.03 Built on Feb 1, 2018