KSPROPERTY_AUDIO_STEREO_SPEAKER_GEOMETRY

The KSPROPERTY_AUDIO_STEREO_SPEAKER_GEOMETRY property is used in combination with KSPROPERTY_AUDIO_CHANNEL_CONFIG to implement the DirectSound speaker-configuration property for hardware-accelerated 3D audio. This is an optional property of DAC nodes (KSNODETYPE_DAC) and 3D nodes (KSNODETYPE_3D_EFFECTS).

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Pin/Filter

KSNODEPROPERTY

LONG

 

The property value (operation data) is of type LONG and specifies the speaker geometry. This value can be set to one of the following constants, which are defined in header file Ksmedia.h:

  • KSAUDIO_STEREO_SPEAKER_GEOMETRY_HEADPHONES

  • KSAUDIO_STEREO_SPEAKER_GEOMETRY_MIN

  • KSAUDIO_STEREO_SPEAKER_GEOMETRY_NARROW

  • KSAUDIO_STEREO_SPEAKER_GEOMETRY_WIDE

  • KSAUDIO_STEREO_SPEAKER_GEOMETRY_MAX

The preceding parameters are equivalent in meaning (but not equal in value) to the following values, which are used by the IDirectSound::GetSpeakerConfig method (see the Microsoft Windows SDK documentation) and are defined in header file Dsound.h:

  • DSSPEAKER_HEADPHONE

  • DSSPEAKER_STEREO | DSSPEAKER_GEOMETRY_MIN

  • DSSPEAKER_STEREO | DSSPEAKER_GEOMETRY_NARROW

  • DSSPEAKER_STEREO | DSSPEAKER_GEOMETRY_WIDE

  • DSSPEAKER_STEREO | DSSPEAKER_GEOMETRY_MAX

Return Value

A KSPROPERTY_AUDIO_STEREO_SPEAKER_GEOMETRY property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.

Remarks

DirectSound treats KSPROPERTY_AUDIO_STEREO_SPEAKER_GEOMETRY as a filter property on a DAC node, and as a pin property on a 3D node.

For additional information, see DirectSound Speaker-Configuration Settings.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSPROPERTY_AUDIO_CHANNEL_CONFIG
KSNODETYPE_DAC
KSNODETYPE_3D_EFFECTS
KSNODEPROPERTY

 

 

Send comments about this topic to Microsoft

Show: