IDirectSound3DListener8::GetOrientation Method

[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 GetOrientation method retrieves the orientation of the listener's head.

Syntax

HRESULT GetOrientation(
         D3DVECTOR * pvOrientFront,
          D3DVECTOR * pvOrientTop
)

Parameters

  • pvOrientFront
    Address of a D3DVECTOR structure that receives the listener's front orientation vector.
  • pvOrientTop
    Address of a D3DVECTOR structure that receives the listener's top orientation vector.

Return Value

If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.

Remarks

The front vector points in the direction of the listener's nose, and the top vector points up from the top of the listener's head. By default, the front vector is (0,0,1.0) and the top vector is (0,1.0,0).

The values returned are not necessarily the same as those set by using SetOrientation. DirectSound normalizes orientation vectors so that they are at right angles and have a magnitude of less than or equal to 1.0.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IDirectSound3DListener8