Partager via

IDirectSound3DBuffer8::SetMode 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 SetMode method sets the operation mode for 3D sound processing.

Syntax

HRESULT SetMode(
         DWORD dwMode,
         DWORD dwApply
)

Parameters

  • dwMode
    Flag specifying the 3D sound processing mode to be set. The flags in the following table are defined.

    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.

  • dwApply
    Value that specifies when the setting should be applied. This value must be one of those in the following table.

    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.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IDirectSound3DBuffer8