IDirectSound3DListener8::SetAllParameters 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 SetAllParameters method sets all 3D parameters of the sound environment and the listener.

Syntax

HRESULT SetAllParameters(
         LPCDS3DLISTENER pcListener,
         DWORD dwApply
)

Parameters

  • pcListener
    Address of a DS3DLISTENER structure that contains information describing all 3D listener parameters.
  • 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.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IDirectSound3DListener8