ISpatialAudioObjectRenderStreamForMetadata::Stop method

Stops a running audio stream.

Syntax


HRESULT Stop();

Parameters

This method has no parameters.

Return value

If the method succeeds, it returns S_OK. If the stream is not running when this method is called, it returns S_FALSE.

Remarks

Stopping stream causes data to stop flowing between the endpoint buffer and the audio engine. You can consider this operation to pause the stream because it leaves the stream's audio clock at its current stream position and does not reset it to 0. A subsequent call to Start causes the stream to resume running from the current position. Call Reset to reset the clock position to 0 and cause all active ISpatialAudioObjectForMetadataCommands or ISpatialAudioObjectForMetadataItems instances to be revoked.

See also

ISpatialAudioObjectRenderStreamForMetadata

 

 

Show: