KSPROPERTY_SYNTH_RUNNINGSTATS

The KSPROPERTY_SYNTH_RUNNINGSTATS property is used to query the miniport driver for the synthesizer's performance statistics.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

No

Pin

KSNODEPROPERTY

SYNTH_STATS

 

The property value (operation data) is a structure of type SYNTH_STATS. The miniport driver's property handler writes the following statistics into this structure:

  • The average number of voices playing

  • CPU usage

  • Number of notes lost

  • Amount of free memory

  • Peak volume level

Return Value

A KSPROPERTY_SYNTH_RUNNINGSTATS 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 some of the possible error codes.

Status CodeMeaning

STATUS_BUFFER_TOO_SMALL

The buffer was too small to complete the operation.

STATUS_UNSUCCESSFUL

The operation did not complete successfully.

STATUS_INVALID_DEVICE_REQUEST

The operation is invalid for this device.

 

Remarks

The synthesizer's performance statistics are continuously updated while the device remains in the KSSTATE_RUN state. Each time the device enters this state, it resets the statistics, which zeros cumulative values such as the peak volume and number of notes lost.

For additional information, see the description of the IDirectMusicPort::GetRunningStats method and the DMUS_SYNTHSTATS structure in the Microsoft Windows SDK documentation.

Requirements

Header

Dmusprop.h (include Dmusprop.h)

See also

KSNODEPROPERTY
SYNTH_STATS
IDirectMusicSynth::GetRunningStats

 

 

Send comments about this topic to Microsoft

Show: