waveOutGetPitch function (mmeapi.h)
The waveOutGetPitch function retrieves the current pitch setting for the specified waveform-audio output device.
Syntax
MMRESULT waveOutGetPitch(
HWAVEOUT hwo,
LPDWORD pdwPitch
);
Parameters
hwo
Handle to the waveform-audio output device.
pdwPitch
Pointer to a variable to be filled with the current pitch multiplier setting. The pitch multiplier indicates the current change in pitch from the original authored setting. The pitch multiplier must be a positive value.
The pitch multiplier is specified as a fixed-point value. The high-order word of the variable contains the signed integer part of the number, and the low-order word contains the fractional part. A value of 0x8000 in the low-order word represents one-half, and 0x4000 represents one-quarter. For example, the value 0x00010000 specifies a multiplier of 1.0 (no pitch change), and a value of 0x000F8000 specifies a multiplier of 15.5.
Return value
Returns MMSYSERR_NOERROR if successful or an error otherwise. Possible error values include the following.
| Return code | Description |
|---|---|
|
Specified device handle is invalid. |
|
No device driver is present. |
|
Unable to allocate or lock memory. |
|
Function isn't supported. |
Remarks
Changing the pitch does not change the playback rate, sample rate, or playback time. Not all devices support pitch changes. To determine whether the device supports pitch control, use the WAVECAPS_PITCH flag to test the dwSupport member of the WAVEOUTCAPS structure (filled by the waveOutGetDevCaps function).
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | mmeapi.h (include Windows.h) |
| Library | Winmm.lib |
| DLL | Winmm.dll |