AudioListener

DirectXTK	Audio

AudioListener is a helper object derived from X3DAUDIO_LISTENER that can be used by the Apply3D method of SoundEffectInstance, SoundStreamInstance, and DynamicSoundEffectInstance.

See AudioEmitter.

Related tutorial: Using positional audio

Header

#include <Audio.h>

Initialization

The default constructor creates a listener located at 0,0,0 facing -z and an up vector of +y.

When using left-handed coordinates, be sure to set OrientFront

Helpers

In addition to setting the members of X3DAUDIO_LISTENER directly, these helper functions are provided:

• SetPosition (XMVECTOR) or (XMFLOAT3): Sets the Position of the listener.

• SetVelocity (XMVECTOR) or (XMFLOAT3): Sets the Velocity of the listener.

• SetOrientation (XMVECTOR forward, XMVECTOR up) or (XMFLOAT3 forward, XMFLOAT3 up)

• SetOrientationFromQuaternion (XMVECTOR): Sets the OrientFront/OrientTop of the listener.

• Update (XMVECTOR newPos, XMVECTOR upDir, float dt ): Computes a direction and velocity for the listener based on the existing Position and the newPos, updating the OrientFront/OrientTop to match, and then setting the Position to the newPos. If dt is 0, the update is skipped.

Further reading

X3DAudio
X3DAudioCalculate

GameFest 2010: The (3D) Sound of Success: X3DAudio and Sound Positioning