IXAudio2MasteringVoice::GetChannelMask Method

Returns the channel mask for this voice.

Syntax

public:
HRESULT GetChannelMask(
         DWORD *pChannelmask
)

Parameters

pChannelmask
Type: DWORD *

[out] Returns the channel mask for this voice. This corresponds to the dwChannelMask member of the WAVEFORMATEXTENSIBLE structure.

Return value

Type: HRESULT

See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.

Remarks

The pChannelMask argument is a bit-mask of the various channels in the speaker geometry reported by the audio system. This information is needed for the X3DAudioInitializeSpeakerChannelMask parameter.

The X3DAUDIO.H header declares a number of SPEAKER_ positional defines to decode these channels masks.

Examples include:

SPEAKER_STEREO // SPEAKER_FRONT_LEFT (0x1) | SPEAKER_FRONT_RIGHT (0x2) 

SPEAKER_5POINT1 // SPEAKER_FRONT_LEFT (0x1) | SPEAKER_FRONT_RIGHT (0x2)
                                    // | SPEAKER_FRONT_CENTER (0x4)
                                    // | SPEAKER_LOW_FREQUENCY (0x8)
                                    // | SPEAKER_BACK_LEFT (0x10) | SPEAKER_BACK_RIGHT (0x20)

Requirements

Header: Declared in xaudio2.h.