GetXmaChannelMaskFromStandardMask

Converts between WAVEFORMATEXTENSIBLE channel masks that are combinations of SPEAKER_xxx flags defined in the audiodef.h file, XBOX Media Audio (XMA) channel masks, and are limited to eight possible speaker positions.

Syntax

BYTE GetXmaChannelMaskFromStandardMask(  
         DWORD dwStandardMask  
)  

Parameters

dwStandardMask
Type: DWORD Standard mask.

Return value

Type: BYTE Byte mask.

Remarks

This function converts between WAVEFORMATEXTENSIBLE channel masks that are combinations of SPEAKER_xxx flags defined in the audiodefs.h file, XMA channel masks, and are limited to eight possible speaker positions. As shown in the code example below, these speaker positions include left, right, center, low frequency, side left, side right, back left, and back right.

__inline BYTE GetXmaChannelMaskFromStandardMask(DWORD dwStandardMask)
{
    BYTE bXmaMask = 0;

    if (dwStandardMask & SPEAKER_FRONT_LEFT)    bXmaMask |= XMA_SPEAKER_LEFT;
    if (dwStandardMask & SPEAKER_FRONT_RIGHT)   bXmaMask |= XMA_SPEAKER_RIGHT;
    if (dwStandardMask & SPEAKER_FRONT_CENTER)  bXmaMask |= XMA_SPEAKER_CENTER;
    if (dwStandardMask & SPEAKER_LOW_FREQUENCY) bXmaMask |= XMA_SPEAKER_LFE;
    if (dwStandardMask & SPEAKER_SIDE_LEFT)     bXmaMask |= XMA_SPEAKER_LEFT_SURROUND;
    if (dwStandardMask & SPEAKER_SIDE_RIGHT)    bXmaMask |= XMA_SPEAKER_RIGHT_SURROUND;
    if (dwStandardMask & SPEAKER_BACK_LEFT)     bXmaMask |= XMA_SPEAKER_LEFT_BACK;
    if (dwStandardMask & SPEAKER_BACK_RIGHT)    bXmaMask |= XMA_SPEAKER_RIGHT_BACK;

    return bXmaMask;
}

For more information about XMA2, see Overview of XMA2. For an overview of the audio architecture of XBOX One, see The sound of the future: The audio architecture in XBOX One.

Requirements

Header: xma2defs.h Supported platforms: XBOX One family consoles and XBOX Series consoles

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

GetXmaChannelMaskFromStandardMask

GetXmaChannelMaskFromStandardMask

Syntax

Parameters

Return value

Remarks

Requirements

See also

​GetXmaChannelMaskFromStandardMask

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

GetXmaChannelMaskFromStandardMask

Syntax

Parameters

Return value

Remarks

Requirements

See also