ISpatialAudioRenderStreamForHrtf::Start method

Starts the spatial audio stream.

Syntax

HRESULT Start();

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
SPTLAUDCLNT_E_STREAM_NOT_STOPPED

The audio stream has not been stopped. Stop the stream by calling Stop.

 

Remarks

Starting the stream causes data flow between the endpoint buffer and the audio engine. The first time this method is called, the stream's audio clock position will be at 0. Otherwise, the clock resumes from its position at the time that the stream was last paused with a call to Stop. Call Reset to reset the clock position to 0 and cause all active ISpatialAudioObjectForHrtf instances to be revoked.

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

Header

Spatialaudiohrtf.h

See also

ISpatialAudioRenderStreamForHrtf