KSPROPERTY_INTERLEAVEDAUDIO_FORMATINFORMATION
The KSPROPERTY_INTERLEAVEDAUDIO_FORMATINFORMATION property provides additional information about the interleaving of loopback audio and capture audio.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
| Yes | No | Pin | KS_PIN | INTERLEAVED_AUDIO_FORMAT_INFORMATION |
Return Value
For the get, KSPROPERTY_INTERLEAVEDAUDIO_FORMATINFORMATION returns an INTERLEAVED_AUDIO_FORMAT_INFORMATION structure which contains additional information about the interleaving of loopback audio and capture audio in the audio stream.
Starting in Windows 10 19H1, setting the KSPROPERTY_INTERLEAVEDAUDIO_FORMATINFORMATION property key is a requirement for systems that support the Hardware Keyword Spotter (HW KWS) that combine microphone and loopback audio into a single stream, in order to use an AEC APO on the keyword burst output. For more information, see Voice Activation.
Remarks
This property is intended only for the Hardware Keyword Spotter pin and provides a way to include loopback audio interleaved with the microphone audio. This is done by interleaving the Hardware Keyword Spotter pin audio and loopback audio together into a single PCM audio stream and then communicating, via this property, the channels containing loopback vs. microphone audio.
A sample APO is available that makes use of this property. It is on GitHub as part of the sysvad sample driver and is called KWSApo. The sample APO simply strips out the loopback audio, providing only the primary microphone audio upstream.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 10 Version 19H1 |
| Header | 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