Firelight Technologies FMOD Studio API
System::getDefaultMixMatrix
Gets the default matrix used to convert from one speaker mode to another.
C++ Syntax
FMOD_RESULT System::getDefaultMixMatrix(
FMOD_SPEAKERMODE sourcespeakermode,
FMOD_SPEAKERMODE targetspeakermode,
float *matrix,
int matrixhop
);
C Syntax
FMOD_RESULT FMOD_System_GetDefaultMixMatrix(
FMOD_SYSTEM *system,
FMOD_SPEAKERMODE sourcespeakermode,
FMOD_SPEAKERMODE targetspeakermode,
float *matrix,
int matrixhop
);
C# Syntax
RESULT System.getDefaultMixMatrix(
SPEAKERMODE sourcespeakermode,
SPEAKERMODE targetspeakermode,
float[] matrix,
int matrixhop
);
JavaScript Syntax
System.getDefaultMixMatrix(
sourcespeakermode,
targetspeakermode,
matrix, // writes value to matrix.val
matrixhop
);
Parameters
- sourcespeakermode
- The speaker mode being converted from.
- targetspeakermode
- The speaker mode being converted to.
- matrix
- The output matrix. Its minumum size in floats must be the number of source channels multiplied by the number of target channels. Source and target channels cannot exceed FMOD_MAX_CHANNEL_WIDTH.
- matrixhop
- The number of source channels in the matrix. Optional. If this is 0, the number of source channels will be derived from 'sourcespeakermode'. Maximum of FMOD_MAX_CHANNEL_WIDTH.
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
The gain for source channel 's' to target channel 't' is matrix[t * matrixhop + s].
If 'sourcespeakermode' or 'targetspeakermode' is FMOD_SPEAKERMODE_RAW, this function will return FMOD_ERR_INVALID_PARAM.
See Also
Version 1.10.03 Built on Feb 1, 2018