Share via

WODM_PAUSE (Compact 2013)

  • Article

3/26/2014

This message is used in an MMDRV_MESSAGE_PARAMS structure passed to the WAV_IOControl function to request a waveform output driver to pause playback of a waveform.

Parameters

  • uDeviceId
    Device identifier - 0, 1, 2, and so on - for the target device.
  • uMsg
    Specifies this message.
  • dwUser
    Specifies a device instance identifier.
  • dwParam1
    Not used.
  • dwParam2
    Not used.

Return Values

MMSYSERR_NOERROR indicates success. Otherwise, the driver returns one of the MMSYSERR or WAVEERR error values declared in the Mmsystem.h header file.

Remarks

The waveform API manager sends this message by calling the audio driver's WAV_IOControl entry point through the DeviceIoControl function.

The driver stops playing the waveform and saves the current position. Playback continues from this position when the driver receives a WODM_RESTART message. The driver places any output buffers received with the WODM_WRITE message while playback is paused in the output queue.

If the driver receives this message when output is already paused, it returns MMSYSERR_NOERROR.

Requirements

Header

mmddk.h

See Also

Reference

Waveform Output Driver Messages
MMDRV_MESSAGE_PARAMS
WAV_IOControl