KSPROPERTY_AUDIO_MIC_SENSITIVITY2

The KSPROPERTY_AUDIO_MIC_SENSITIVITY2 property specifies the microphone sensitivity in decibels relative to full scale (dBFS) units including any hardware gain. This value includes any hardware integration that impacts mic sensitivity, prior to any software gain. The KSPROPERTY_AUDIO_MIC_SENSITIVITY2 property does not include any software gain that is applied from the audio stack.

Usage Summary Table

Get

Set

Target

Property descriptor type

Property value type

Yes

No

Pin Instance

KSP_PIN LONG

The property value (operation data) is of type LONG and contains sensitivity information in decibels relative to dBFS units. The sensitivity value uses the following scale. The value uses fixed point decimal representation. The data is stored as a 16.16 fixed point value. The upper 16 bits are used for the whole number of the value and the lower 16 bits are used for the fractional portion of the value.

Return Value

A KSPROPERTY_AUDIO_MIC_SENSITIVITY2 property request returns a STATUS_SUCCESS upon successful completion of the request. Otherwise, the request returns an appropriate error status code.

Remarks

The audio driver can obtain microphone sensitivity for each microphone. This property allows this information to be retrieved from driver.

For Windows 10 voice recognition experiences, such as Cortana, to accurately detect and analyze a user's voice on various devices with different microphones, the OS needs to know certain characteristics of the input signal. Based on that information, the OS can calculate effective sensitivity and apply appropriate gain to enhance the input signal. For more information, see Voice Activation.

KSPROPERTY_AUDIO_MIC_SENSITIVITY2 is available beginning with Windows 10 Version 1803 and supersedes KSPROPERTY_AUDIO_MIC_SENSITIVITY.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See Also

KSPROPERTY_AUDIO_MIC_SENSITIVITY