|
|
|
The KSPROPERTY_SYNTH_DLS_WAVEFORMAT property is used to query the synthesizer for its output wave format.
| Get | Set | Target | Property Descriptor Type | Property Value Type |
|---|---|---|---|---|
| Yes | No | Pin | KSNODEPROPERTY | WAVEFORMATEX |
The property value (operation data) is of type WAVEFORMATEX and specifies the wave format of the synthesizer's output stream.
A KSPROPERTY_SYNTH_DLS_WAVEFORMAT 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. |
Declared in dmusprop.h. Include dmusprop.h.
A property-value buffer of sizeof(WAVEFORMATEX) bytes might not be large enough for all wave formats. For example, a multichannel format requires a buffer of sizeof(WAVEFORMATEXTENSIBLE) bytes. If the property request returns a status code of STATUS_BUFFER_TOO_SMALL, the client can check the property-value size that the miniport driver outputs, allocate a larger buffer, and then submit a second request.
For more information, see the description of the IDirectMusicPort::GetFormat method in the Platform SDK documentation.