ISpatialAudioObjectForHrtf::SetDirectivity method (spatialaudiohrtf.h)

Sets the spatial audio directivity model for the ISpatialAudioObjectForHrtf.

Syntax

HRESULT SetDirectivity(
  SpatialAudioHrtfDirectivityUnion *directivity
);

Parameters

directivity

The spatial audio directivity model. This value can be one of the following structures:

• SpatialAudioHrtfDirectivity
• SpatialAudioHrtfDirectivityCardioid
• SpatialAudioHrtfDirectivityCone

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	ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects was not called before the call to SetDirectivity.
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 ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects and ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects).

Remarks

The SpatialAudioHrtfDirectivity structure represents an omnidirectional model that can be linearly interpolated with a cardioid or cone model.

If SetDirectivity is not called, the default type of SpatialAudioHrtfDirectivity_OmniDirectional is used with no interpolation.

Requirements

Requirement	Value
Target Platform	Windows
Header	spatialaudiohrtf.h

See also

ISpatialAudioObjectForHrtf