ISpatialAudioObjectRenderStreamBase::Reset method (spatialaudioclient.h)
Reset a stopped audio stream.
Syntax
HRESULT Reset();
Return value
If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.
| Return code | Description |
|---|---|
|
The audio stream has not been stopped. Stop the stream by calling Stop. |
|
The ISpatialAudioClient associated with the spatial audio stream has been destroyed. |
|
The audio endpoint device has been unplugged, or the audio hardware or associated hardware resources have been reconfigured, disabled, removed, or otherwise made unavailable for use. |
|
An internal error has occurred. |
|
The media associated with the spatial audio stream uses an unsupported format. |
Remarks
Resetting the audio stream flushes all pending data and resets the audio clock stream position to 0. Resetting the stream also causes all active ISpatialAudioObject instances to be revoked.
A subsequent call to Start causes the stream to start from 0 position.
The stream must have been previously stopped with a call to Stop or the method will fail and return SPTLAUDCLNT_E_STREAM_NOT_STOPPED.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | spatialaudioclient.h |