IDirectSound3DListener8::SetOrientation Method

Article
09/10/2011

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

Syntax

HRESULT SetOrientation(
         D3DVALUE xFront,
         D3DVALUE yFront,
         D3DVALUE zFront,
         D3DVALUE xTop,
         D3DVALUE yTop,
         D3DVALUE zTop,
         DWORD dwApply
)

Parameters

xFront
Value that specifies the x coordinate of the front orientation vector. D3DVALUE is defined as float.
yFront
Value that specifies the y coordinate of the front orientation vector. D3DVALUE is defined as float.
zFront
Value that specifies the z coordinate of the front orientation vector. D3DVALUE is defined as float.
xTop
Value that specifies the x coordinates of the top orientation vector.
yTop
Value that specifies the y coordinates of the top orientation vector.
zTop
Value that specifies the z coordinates of the top orientation vector.

dwApply
Value that specifies when the setting should be applied. This value must be one of the following:

Value	Description
DS3D_DEFERRED	Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.
DS3D_IMMEDIATE	Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.

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 top vector must be at right angles to the front vector. If necessary, DirectSound adjusts the top vector after setting the front vector.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

Partager via