KSPROPERTY_AUDIOSIGNALPROCESSING_MODES

The KSPROPERTY_AUDIOSIGNALPROCESSING_MODES property returns the list of audio signal processing modes supported by a pin factory.

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

No

Pin factory (via Filter instance)

KSP_PIN

KSMULTIPLE_ITEM

The property value is a structure, followed by zero (0) or more GUIDs.

Return Value

KSPROPERTY_AUDIOSIGNALPROCESSING_MODES returns a KSMULTIPLE_ITEM followed by zero (0) or more GUIDS. The KSMULTIPLE_ITEM.Count member contains the number of GUIDs. The KSMULTIPLE_ITEM.Size member contains the total size of the property value. Each GUID identifies a signal processing mode supported by the audio driver for the Pin ID specified in the PinId member of the KSP_PIN structure.

In Windows 8.1 there were two defined audio signal processing modes:

  • AUDIO_SIGNALPROCESSINGMODE_DEFAULT
  • AUDIO_SIGNALPROCESSINGMODE_RAW.

In Windows 10, five additional mode are defined:

  • AUDIO_SIGNALPROCESSINGMODE_COMMUNICATIONS
  • AUDIO_SIGNALPROCESSINGMODE_SPEECH
  • AUDIO_SIGNALPROCESSINGMODE_MEDIA
  • AUDIO_SIGNALPROCESSINGMODE_MOVIE
  • AUDIO_SIGNALPROCESSINGMODE_NOTIFICATION

For more information, see Audio Signal Processing Modes.

Remarks

The basic support handler for KSPROPERTY_AUDIOSIGNALPROCESSING_MODES should be handed a KSP_PIN structure, and should advertise support only on non-loopback streaming pins. Audio drivers should support signal processing modes only on host and offload pins. For loopback or bridge pins the audio driver should still support the property, but return a KSMULTIPLE_ITEM structure with its Count parameter set to zero (0).

Any audio miniport driver that is developed to work with the Microsoft audio port Class driver (Portcls) can implement the IMiniportAudioSignalProcessing::GetModes method.

Requirements

Version

Windows 8.1

Header

Ksmedia.h

See also

IMiniportAudioSignalProcessing::GetModes

KSMULTIPLE_ITEM

KSP_PIN