KSPROPERTY_AUDIO_PEAKMETER
The KSPROPERTY_AUDIO_PEAKMETER property retrieves the maximum audio signal level that occurred at a peakmeter node (KSNODETYPE_PEAKMETER) since the last time the peakmeter node was reset.
Important
KSPROPERTY_AUDIO_PEAKMETER property is depreciated, and should not be used. Use KSPROPERTY_AUDIO_PEAKMETER2 instead.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
Yes |
No |
Node via Filter or Pin instance |
KSNODEPROPERTY_AUDIO_CHANNEL | LONG |
The property value (operation data) is of type LONG and specifies the peak sample value at the node. If the peak value is negative, its absolute value is used.
Return Value
A KSPROPERTY_AUDIO_PEAKMETER property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code. The following table shows a possible error status code.
| Status Code | Meaning |
|---|---|
STATUS_NOT_IMPLEMENTED |
The KS filter cannot return the current value of the peakmeter. |
Remarks
A KS audio filter handles this property request synchronously. If the request succeeds, it resets the peakmeter, which initializes the accumulated peak value to zero. If the request does not succeed, the peakmeter is not changed.
The system sends an IOCTL_KS_PROPERTY request for the KSPROPERTY_AUDIO_PEAKMETER property at IRQL PASSIVE_LEVEL.
Requirements
Header |
Ksmedia.h (include Ksmedia.h) |