ISpatialAudioObjectForHrtf::SendEndOfStream method
Instructs the system that the final block of audio data has been submitted for the ISpatialAudioObjectForHrtf so that the object can be deactivated and it's resources reused.
Syntax
HRESULT SendEndOfStream(
[in] UINT32 frameCount
);
Parameters
- frameCount [in]
The number of audio frames in the audio buffer that should be included in the final processing pass. This number may be smaller than or equal to the value returned in the frameCountPerBuffer parameter to ISpatialAudioObjectRenderStreamForHrtf::BeginUpdatingAudioObjects.
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_OUT_OF_ORDER | ISpatialAudioObjectRenderStreamForHrtf::BeginUpdatingAudioObjects was not called before the call to SetEndOfStream. |
| SPTLAUDCLNT_E_RESOURCES_INVALIDATED | SetEndOfStream was called either explicitly or implicitly in a previous audio processing pass. SetEndOfStream is called implicitly by the system if GetBuffer is not called within an audio processing pass (between calls to ISpatialAudioObjectRenderStreamForHrtf::BeginUpdatingAudioObjects and ISpatialAudioObjectRenderStreamForHrtf::EndUpdatingAudioObjects). |
Remarks
Call Release after calling SetEndOfStream to make free the audio object resources for future use.
Requirements
Header |
Spatialaudiohrtf.h |