Firelight Technologies FMOD Studio API

DSPConnection::getMixMatrix

Returns the panning matrix set by the user, for a connection.

C++ Syntax

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

C Syntax

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

C# Syntax

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

JavaScript Syntax

DSPConnection.getMixMatrix(
  matrix,                          // writes value to matrix.val
  outchannels,                     // writes value to outchannels.val
  inchannels,                      // writes value to inchannels.val
  inchannel_hop                    
);

Parameters

matrix

Address of a variable to recieve an array of floating point matrix data, where rows represent output speakers, and columns represent input channels.

outchannels

Address of a variable to receive the number of output channels in the set matrix.

inchannels

Address of a variable to receive the number of input channels in the set matrix.

inchannel_hop

Number of floating point values available in the destination n memory for a row, so that the destination memory can be skipped through correctly to write the right values, if the intended matrix memory to be written to 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::setMixMatrix

Version 1.10.03 Built on Feb 1, 2018