Microsoft DirectX 9.0

IDirectSound8::GetCaps

The GetCaps method retrieves the capabilities of the hardware device that is represented by the device object.

Syntax

HRESULT GetCaps(
  LPDSCAPS pDSCaps 
);

Parameters

pDSCaps

Address of a DSCAPS structure that receives the capabilities of this sound device.

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be one of the error values shown in the following table.

Return code
DSERR_GENERIC
DSERR_INVALIDPARAM
DSERR_UNINITIALIZED

Remarks

Information retrieved in the DSCAPS structure describes the maximum capabilities of the sound device and those currently available, such as the number of hardware mixing channels and the amount of on-board sound memory. You can use this information to fine-tune performance and optimize resource allocation.

Because of resource-sharing requirements, the maximum capabilities in one area might be available only at the cost of another area.

Requirements

  Header: Declared in dsound.h.

See Also