IAudioClient::Reset Method

The Reset method resets the audio stream.

Syntax

public:
HRESULT Reset(
         void
)

Parameters

Type: void

This method does not take any parameters.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method succeeds and the stream was already reset, the method returns S_FALSE. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return codes

Return code	Description
AUDCLNT_E_NOT_INITIALIZED	The audio stream has not been successfully initialized.
AUDCLNT_E_NOT_STOPPED	The audio stream was not stopped at the time the call was made.
AUDCLNT_E_BUFFER_OPERATION_PENDING	The client is currently writing to or reading from the buffer.
AUDCLNT_E_SERVICE_NOT_RUNNING	The audio service is not running.

Refer to WASAPI error codes.

Remarks

This method requires prior initialization of the IAudioClient interface. All calls to this method will fail with the error AUDCLNT_E_NOT_INITIALIZED until the client initializes the audio stream by successfully calling the IAudioClient::Initialize method.

Reset is a control method that the client calls to reset a stopped audio stream. Resetting the stream flushes all pending data and resets the audio clock stream position to 0. This method fails if it is called on a stream that is not stopped.

Requirements

Header: Declared in audioclient.h.

Library: Use mmdevapi.lib.