ISpatialAudioObjectForMetadataCommands::SendEndOfStream method

Instructs the system that the final block of audio data has been submitted for the ISpatialAudioObjectForMetadataCommands so that the object can be deactivated and it's resources reused.

Syntax

HRESULT SendEndOfStream(
  [in] UINT32 frameCount
);

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_OUT_OF_ORDER

ISpatialAudioObjectRenderStreamForMetadata::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 ISpatialAudioObjectRenderStreamForMetadata::BeginUpdatingAudioObjects and ISpatialAudioObjectRenderStreamForMetadata::EndUpdatingAudioObjects).

 

Remarks

Call Release after calling SetEndOfStream to make free the audio object resources for future use.

Requirements

Header

Spatialaudioclient.h

See also

ISpatialAudioObjectForMetadataCommands