DS3DLISTENER Structure

  • Article

[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The DS3DLISTENER structure describes the 3D world parameters and the position of the listener. This structure is used with the IDirectSound3DListener8::GetAllParameters and IDirectSound3DListener8::SetAllParameters methods.

Syntax

typedef struct DS3DLISTENER {
    DWORD dwSize;
    D3DVECTOR vPosition;
    D3DVECTOR vVelocity;
    D3DVECTOR vOrientFront;
    D3DVECTOR vOrientTop;
    D3DVALUE flDistanceFactor;
    D3DVALUE flRolloffFactor;
    D3DVALUE flDopplerFactor;
} DS3DLISTENER;

Members

  • dwSize
    Size of the structure, in bytes. This member must be initialized before the structure is used.
  • vPosition
    D3DVECTOR structure that describes the listener's position.
  • vVelocity
    D3DVECTOR structure that describes the listener's velocity.
  • vOrientFront
    D3DVECTOR structure that describes the listener's front orientation.
  • vOrientTop
    D3DVECTOR structure that describes the listener's top orientation.
  • flDistanceFactor
    Number of meters in a vector unit.
  • flRolloffFactor
    Ratio of attenuation over distance to that in the real world.
  • flDopplerFactor
    Ratio of Doppler effect to that in the real world.

Requirements

Header: Declared in DSound.h.

See Also

DirectSound 3D Listeners