IXAudio2Voice::SetOutputMatrix method (xaudio2.h)

Article
10/13/2021

Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input channels of a specified destination voice.

Syntax

\\HRESULT SetOutputMatrix(
  [in] IXAudio2Voice *pDestinationVoice,
  [in] UINT32        SourceChannels,
  [in] UINT32        DestinationChannels,
  [in] const float   *pLevelMatrix,
  [in] UINT32        OperationSet
);

Parameters

[in] pDestinationVoice

Pointer to a destination IXAudio2Voice for which to set volume levels.

Note If the voice sends to a single target voice then specifying NULL will cause SetOutputMatrix to operate on that target voice.

[in] SourceChannels

Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain.

[in] DestinationChannels

Confirms the input channel count of the destination voice.

[in] pLevelMatrix

Array of [SourceChannels × DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels × D + S].

For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels—but is absent from the center and low-frequency channels—the matrix might have the values shown in the following table.

Output	Left Input [Array Index]	Right Input [Array Index]
Left	1.0 [0]	0.0 [1]
Right	0.0 [2]	1.0 [3]
Front Center	0.0 [4]	0.0 [5]
LFE	0.0 [6]	0.0 [7]
Rear Left	0.8 [8]	0.0 [9]
Rear Right	0.0 [10]	0.8 [11]

Note The left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels.

See Remarks for more information on volume levels.

[in] OperationSet

Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.

Return value

Returns S_OK if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.

Remarks

This method is valid only for source and submix voices, because mastering voices write directly to the device with no matrix mixing.

Volume levels are expressed as floating-point amplitude multipliers between -XAUDIO2_MAX_VOLUME_LEVEL and XAUDIO2_MAX_VOLUME_LEVEL (-2²⁴ to 2²⁴), with a maximum gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. Negative levels can be used to invert the audio's phase. See XAudio2 Volume and Pitch Control for additional information on volume control.

The X3DAudio function X3DAudioCalculate can produce an output matrix for use with SetOutputMatrix based on a sound's position and a listener's position.

Note IXAudio2Voice::GetOutputMatrix always returns the levels most recently set by IXAudio2Voice::SetOutputMatrix. However, they may not actually be in effect yet: they only take effect the next time the audio engine runs after the IXAudio2Voice::SetOutputMatrix call (or after the corresponding IXAudio2::CommitChanges call, if IXAudio2Voice::SetOutputMatrix was called with a deferred operation ID).

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Requirement	Value
Target Platform	Windows
Header	xaudio2.h