KSPROPERTY_AUDIO_ALGORITHM_INSTANCE

The KSPROPERTY_AUDIO_ALGORITHM_INSTANCE property specifies the DSP (digital-signal processing) algorithm that is used to achieve the third-party effect that the node applies to the audio data stream. The effects that are defined for this property include acoustic echo cancellation and noise suppression.

The property value (operation data) is a GUID that identifies the effect that the pin applies to its data stream. This value can be one of the following GUIDs from header file ksmedia.h:

KSALGORITHMINSTANCE_SYSTEM_ACOUSTIC_ECHO_CANCEL

System default acoustic echo cancellation

KSALGORITHMINSTANCE_SYSTEM_NOISE_SUPPRESS

System default noise suppression

Return Value

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

Headers

Declared in ksmedia.h. Include ksmedia.h.

Comments

This property is used to control the DSP algorithm that is performed by an AEC node (KSNODETYPE_ACOUSTIC_ECHO_CANCEL) or noise-suppression node (KSNODETYPE_NOISE_SUPPRESS).

The algorithm-instance GUID matches the value in the guidDSCFXInstance member of a DSCEFFECTDESC structure that a caller passes to the IDirectSoundCapture::CreateCaptureBuffer method or DirectSoundFullDuplexCreate function. For more information, see the Platform SDK documentation.

See Also

KSNODEPROPERTY, KSNODETYPE_ACOUSTIC_ECHO_CANCEL, KSNODETYPE_NOISE_SUPPRESS