KSPROPERTY_AUDIO_VOLUMELIMIT_ENGAGED

KSPROPERTY_AUDIO_VOLUMELIMIT_ENGAGED, is a new KS property that has been added into the KSPROPSETID_Audio property set in Windows 8.1.

The KSPROPERTY_AUDIO_VOLUMELIMIT_ENGAGED property request passes an end user’s volume level limit preference to the underlying driver. The scope of this property is per pin (or per audio endpoint, from an end-user’s point of view).

Usage Summary Table

Get	Set	Target	Property descriptor type	Property value type
No	Yes	Pin instance	KSP_PIN	BOOL

The property value is of type BOOL, and it indicates whether an end-user allows the max volume to be over a certain limit. A value of TRUE indicates that an end-user has allowed the volume level to be over the posted limit, whereas FALSE indicates the opposite. In the case of a child account, the value will always be FALSE.

The driver stores the value of this property in an internal variable and initializes the value to TRUE during startup. While this property is TRUE, the driver limits the maximum volume level. When the property is set to FALSE the driver can remove these limits.

The driver can also change the value of this property automatically. For example, the driver can automatically switch the property value from TRUE to FALSE, and then begin limiting the volume level after some amount of time above certain sound levels has elapsed.

Whenever the value of the property changes, regardless of whether it is automatic or due to a caller setting the property value, the driver should generate the KSEVENT_PINCAPS_VOLUMELIMITCHANGE event.

Return Value

The KSPROPERTY_AUDIO_VOLUMELIMIT_ENGAGED property request returns STATUS_SUCCESS when the request is successful.

Requirements

Version	Windows 8.1
Header	Ksmedia.h (include Ksmedia.h)