IDirectSound::GetSpeakerConfig

The IDirectSound::GetSpeakerConfig method retrieves the speaker configuration specified for this DirectSound object.

HRESULT GetSpeakerConfig(
  LPDWORD lpdwSpeakerConfig  
);

Parameters

lpdwSpeakerConfig
Address of the speaker configuration for this DirectSound object. The speaker configuration is specified with one of the following values:
DSSPEAKER_HEADPHONE
The audio is played through headphones.
DSSPEAKER_MONO
The audio is played through a single speaker.
DSSPEAKER_QUAD
The audio is played through quadraphonic speakers.
DSSPEAKER_STEREO
The audio is played through stereo speakers (default value).
DSSPEAKER_SURROUND
The audio is played through surround speakers.

DSSPEAKER_STEREO may be combined with one of the following values:

DSSPEAKER_GEOMETRY_WIDE
The speakers are directed over an arc of 20 degrees
DSSPEAKER_GEOMETRY_NARROW
The speakers are directed over an arc of 10 degrees
DSSPEAKER_GEOMETRY_MIN
The speakers are directed over an arc of 5 degrees
DSSPEAKER_GEOMETRY_MAX
The speakers are directed over an arc of 180 degrees

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be one of the following error values:

DSERR_INVALIDPARAM
DSERR_UNINITIALIZED

Remarks

The value returned at lpdwSpeakerConfig may be a packed DWORD containing both configuration and geometry information. Use the DSSPEAKER_CONFIG and DSSPEAKER_GEOMETRY macros to unpack the DWORD, as in the following example:

if (DSSPEAKER_CONFIG(dwSpeakerConfig) == DSSPEAKER_STEREO)
    {
    if (DSSPEAKER_GEOMETRY(dwSpeakerConfig) ==
                      DSSPEAKER_GEOMETRY_WIDE)
       {...}
    }

QuickInfo

  Windows NT: Use version 4.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in dsound.h.
  Import Library: Use dsound.lib.

See Also

IDirectSound::SetSpeakerConfig