GetStandardChannelMaskFromXmaMask

Converts between WAVEFORMATEXTENSIBLE channel masks that are combinations of SPEAKER_xxx flags defined in the audiodef.h file and the XBOX Media Audio (XMA) channel masks.

Syntax

DWORD GetStandardChannelMaskFromXmaMask(  
         BYTE bXmaMask  
)  

Parameters

bXmaMask
Type: BYTE Input byte mask.

Return value

Type: DWORD Standard mask.

Remarks

This function converts WAVEFORMATEXTENSIBLE channel masks that are combinations of SPEAKER_xxx flags defined in the audiodef.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 DWORD GetStandardChannelMaskFromXmaMask(BYTE bXmaMask)
{
    DWORD dwStandardMask = 0;

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

    return dwStandardMask;
}

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

GetStandardChannelMaskFromXmaMask

GetStandardChannelMaskFromXmaMask

Syntax

Parameters

Return value

Remarks

Requirements

See also

​GetStandardChannelMaskFromXmaMask

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

GetStandardChannelMaskFromXmaMask

Syntax

Parameters

Return value

Remarks

Requirements

See also