DirectSound.GetSpeakerConfig

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

object.GetSpeakerConfig() As CONST_DSSPEAKERFLAGS

Parameters

object

Object expression that resolves to a DirectSound object.

Return Values

If the method succeeds, one or more of the following constants of the CONST_DSSPEAKERFLAGS enumeration is returned.

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.

Error Codes

If the method fails, an error is raised and Err.Number may be one of the following error values:

Remarks

The speaker geometry is by default set to 0 which states that the speaker geometry has not been defined. The geometry must be explicitly set by using the DirectSound.SetSpeakerConfig method and passing one of the speaker geometry flags with the DSSPEAKER_STEREO flag.

See Also

DirectSound.SetSpeakerConfig