KSPROPERTY_AUDIO_MIC_ARRAY_GEOMETRY
The KSPROPERTY_AUDIO_MIC_ARRAY_GEOMETRY property specifies the geometry of the microphone array.
Usage Summary Table
Usage Summary Table
Get |
Set |
Target |
Property descriptor type |
Property value type |
Yes |
No |
Filter |
KSP_PIN | KSAUDIO_MIC_ARRAY_GEOMETRY |
The property value (operation data) is of type KSAUDIO_MIC_ARRAY_GEOMETRY. See the definition of the KSAUDIO_MIC_ARRAY_GEOMETRY structure for details.
Return Value
A KSPROPERTY_AUDIO_MIC_ARRAY_GEOMETRY property request returns a STATUS_SUCCESS upon successful completion of the request.
If the pin indicated by the PinId member of the KSP_PIN structure does not support a mic array request, the property request will return STATUS_NOT_SUPPORTED.
If the buffer size of the request is set to zero, the property request will return a STATUS_BUFFER_OVERFLOW status. Additionally, the request will use the return status block to indicate the size of the KSAUDIO_MIC_ARRAY_GEOMETRY structure supported by the pin.
If the buffer size of the request is set to any buffer size that is too small to accommodate the returned structure, the request returns a status of STATUS_BUFFER_TOO_SMALL. The request will then use the return status block to indicate the size of the KSAUDIO_MIC_ARRAY_GEOMETRY structure that is supported by the pin.
Remarks
The KSPROPERTY_AUDIO_MIC_ARRAY_GEOMETRY property only supports KSPROPERTY_TYPE_GET requests. In order for the client to determine the correct size of buffer necessary to accommodate the entire geometry structure, it must first make the request with a zero buffer size. The client can then use the value returned in the status block to set the buffer size correctly and then make another property request with the correctly sized buffer.
For more information about how to process a microphone array in Windows, refer to the following resources:
Microphone Array Geometry Property
Microphone Array Support in Windows (white paper)
Requirements
Header |
Ksmedia.h (include Ksmedia.h) |