Expand Minimize

X3DAudioInitialize function

Sets all global 3D audio constants.

Syntax


void __stdcall X3DAudioInitialize(
  _In_   UINT32 SpeakerChannelMask,
  _In_   FLOAT32 SpeedOfSound,
  _Out_  X3AUDIO_HANDLE Instance
);

Parameters

SpeakerChannelMask [in]

Assignment of channels to speaker positions. This value must not be zero. The only permissible value on Xbox 360 is SPEAKER_XBOX.

SpeedOfSound [in]

Speed of sound, in user-defined world units per second. Use this value only for doppler calculations. It must be greater than or equal to FLT_MIN.

Instance [out]

3D audio instance handle. Use this handle when you call X3DAudioCalculate.

Return value

This function does not return a value.

Remarks

X3DAUDIO_HANDLE is an opaque data structure. Because the operating system doesn't allocate any additional storage for the 3D audio instance handle, you don't need to free or close it.

Platform Requirements

Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Windows Phone 8.1: This API is supported.

Requirements

Header

X3daudio.h

Library

XAudio2.lib

 

 

Community Additions

ADD
Show:
© 2014 Microsoft