ISpatialAudioObjectRenderStreamForMetadata::Reset method
Reset a stopped audio stream.
Syntax
HRESULT Reset();
Parameters
This method has no parameters.
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. |
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 ISpatialAudioObjectForMetadataCommands or ISpatialAudioObjectForMetadataItems 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.
See also