WODM_GETPITCH

The WODM_GETPITCH message requests a waveform output driver to return the specified device’s current pitch multiplier value.

Parameters

uDeviceId

Device identifier (0, 1, 2, and so on) for the target device.

uMsg

WODM_GETPITCH

dwUser

Device instance identifier.

dwParam1

Pointer to a DWORD location used to return the current pitch multiplier value. This is specified as a fixed-point value, where the high-order word of the DWORD contains the signed integer part of the number, and the low-order word contains the fractional part. The fraction consists of a WORD value, for which 0x8000 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.

dwParam2

Not used.

Return Value

The driver should return MMSYSERR_NOERROR if the operation succeeds. Otherwise it should return one of the MMSYSERR or WAVERR error codes defined in mmsystem.h. See waveOutGetPitch return values in the Win32 SDK.

Comments

A client sends the WODM_GETPITCH message by calling the user-mode driver’s wodMessage entry point, passing the specified parameters.

Support for the WODM_GETPITCH message by user-mode drivers is optional. If a driver supports the WODM_SETPITCH message, it must also support WODM_GETPITCH.

Typically, the user-mode driver calls DeviceIoControl to send the kernel-mode driver an IOCTL_WAVE_GET_PITCH control code.