KSPROPERTY_AUDIO_ALGORITHM_INSTANCE
The KSPROPERTY_AUDIO_ALGORITHM_INSTANCE property specifies the digital signal processing (DSP) 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.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
Yes |
Yes |
Filter |
GUID |
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_AGC
Reserved for future use
KSALGORITHMINSTANCE_SYSTEM_ACOUSTIC_ECHO_CANCEL
System default acoustic echo cancellation algorithm
KSALGORITHMINSTANCE_SYSTEM_MICROPHONE_ARRAY_PROCESSOR
Reserved for future use
KSALGORITHMINSTANCE_SYSTEM_NOISE_SUPPRESS
System default noise suppression algorithm
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.
Remarks
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 Microsoft Windows SDK documentation.
Requirements
Header |
Ksmedia.h (include Ksmedia.h) |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for