Firelight Technologies FMOD Studio API

DSPConnection::setMixMatrix

Sets a NxN panning matrix on a DSP connection. Skipping/hop is supported, so memory for the matrix can be wider than the width of the inchannels parameter.

C++ Syntax

FMOD_RESULT DSPConnection::setMixMatrix(
  float *matrix,
  int outchannels,
  int inchannels,
  int inchannel_hop
);

C Syntax

FMOD_RESULT FMOD_DSPConnection_SetMixMatrix(
  FMOD_DSPCONNECTION *dspconnection,
  float *matrix,
  int outchannels,
  int inchannels,
  int inchannel_hop
);

C# Syntax

RESULT DSPConnection.setMixMatrix(
  float[] matrix,
  int outchannels,
  int inchannels,
  int inchannel_hop
);

JavaScript Syntax

DSPConnection.setMixMatrix(
  matrix,                          
  outchannels,                     
  inchannels,                      
  inchannel_hop                    
);

Parameters

matrix

Pointer to an array of floating point matrix data, where rows represent output speakers, and columns represent input channels.

outchannels

Number of output channels in the matrix being specified.

inchannels

Number of input channels in the matrix being specified.

inchannel_hop

Number of floating point values stored in memory for a row, so that the memory can be skipped through correctly to read the right values, if the intended matrix memory to be read from is wider than the matrix stored in the DSPConnection.

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.

See Also

• DSPConnection::getMixMatrix

Version 1.10.03 Built on Feb 1, 2018