IDirectSound3DBuffer8::GetMode Method

  • 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 GetMode method retrieves the operation mode for 3D sound processing.

Syntax

HRESULT GetMode(
         LPDWORD pdwMode
)

Parameters

  • pdwMode
    Address of a variable that receives the mode setting. This value will be one of those in the following table.
    Value Description
    DS3DMODE_DISABLE Processing of 3D sound is disabled. The sound seems to originate from the center of the listener's head.
    DS3DMODE_HEADRELATIVE Sound parameters (position, velocity, and orientation) are relative to the listener's parameters. In this mode, the absolute parameters of the sound are updated automatically as the listener's parameters change, so that the relative parameters remain constant.
    DS3DMODE_NORMAL Normal processing. This is the default mode.

Return Value

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

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IDirectSound3DBuffer8