Firelight Technologies FMOD Studio API

Channel::setMixLevelsOutput

Sets the speaker volume levels for each speaker individually, this is a helper to avoid calling ChannelControl::setMixMatrix.

C++ Syntax

FMOD_RESULT Channel::setMixLevelsOutput(
  float frontleft,
  float frontright,
  float center,
  float lfe,
  float surroundleft,
  float surroundright,
  float backleft,
  float backright
);

C Syntax

FMOD_RESULT FMOD_Channel_SetMixLevelsOutput(
  FMOD_CHANNEL *channel,
  float frontleft,
  float frontright,
  float center,
  float lfe,
  float surroundleft,
  float surroundright,
  float backleft,
  float backright
);

C# Syntax

RESULT Channel.setMixLevelsOutput(
  float frontleft,
  float frontright,
  float center,
  float lfe,
  float surroundleft,
  float surroundright,
  float backleft,
  float backright
);

JavaScript Syntax

Channel.setMixLevelsOutput(
  frontleft,                       
  frontright,                      
  center,                          
  lfe,                             
  surroundleft,                    
  surroundright,                   
  backleft,                        
  backright                        
);

Parameters

frontleft

Volume level for the front left speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

frontright

Volume level for the front right speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

center

Volume level for the center speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

lfe

Volume level for the subwoofer speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

surroundleft

Volume level for the surround left speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

surroundright

Volume level for the surround right speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

backleft

Volume level for the back left speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

backright

Volume level for the back right speaker of a multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).

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

NOTE: This function overwrites any pan/mixlevel by overwriting the ChannelControl's Matrix.

Levels can be below 0 to invert a signal and above 1 to amplify the signal. Note that increasing the signal level too far may cause audible distortion. Speakers specified that don't exist will simply be ignored. For more advanced speaker control, including sending the different channels of a stereo sound to arbitrary speakers, see ChannelControl::setMixMatrix.

See Also

• ChannelControl::setMixMatrix
• ChannelControl::getMixMatrix

Version 1.10.03 Built on Feb 1, 2018