IAudio::Stop

HRESULT Stop(void);

Informs an audio object to stop playing or recording data.

· Returns NOERROR if successful, or one of these error values:

E_INVALIDARG
AUDERR_NEEDWAVEFORMAT

An audio-destination object stops playing data from its internal buffer, essentially pausing the output stream. An audio-source object stops recording data, but does not clear any data that already exists in its internal buffer.

To restart playing or recording, an application can call the IAudio::Start member function. Any data left in the buffer when Stop was called will still be there, and the object will resume playing or recording the data.

If Start made an implicit call to the IAudio::Claim member function for the audio-source object, Stop makes an implicit call to the IAudio::UnClaim member function. For additional error messages that Stop may return if it makes an implicit call to UnClaim, see the description of UnClaim.