KSPROPERTY_SYNTH_VOLUMEBOOST
The KSPROPERTY_SYNTH_VOLUMEBOOST property specifies the amount by which a synthesizer device's volume is boosted.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
Yes |
Yes |
Pin |
LONG |
The property value (operation data) is of type LONG and specifies by how much to boost the audio signal after the mix stage. This is the amount of volume to add to the final output of the synthesizer after all voice articulation and mixing have been completed. The volume boost amount is specified in 1/100ths of a decibel. This value can be positive or negative.
Return Value
A KSPROPERTY_SYNTH_VOLUMEBOOST 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 Code | Meaning |
|---|---|
STATUS_BUFFER_TOO_SMALL |
The buffer was too small to complete the operation. |
STATUS_UNSUCCESSFUL |
The operation did not complete successfully. |
Remarks
No other boost should be added to the output. The synthesizer should follow strict DLS Level-1 conventions for articulation.
This property is used to equalize the volume of the synthesizer with other audio output in the system, and boost amounts should therefore be interpreted in a consistent manner across all devices.
Requirements
Header |
Dmusprop.h (include Dmusprop.h) |
See also