ISpatialAudioObjectForHrtf interface

Represents an object that provides audio data to be rendered from a position in 3D space, relative to the user, a head-relative transfer function (HRTF). Spatial audio objects can be static or dynamic, which you specify with the type parameter to the ISpatialAudioObjectRenderStream::ForHrtfActivateSpatialAudioObject method. Dynamic audio objects can be placed in an arbitrary position in space and can be moved over time. Static audio objects are assigned to one or more channels, defined in the AudioObjectType enumeration, that each correlate to a fixed speaker location that may be a physical or a virtualized speaker

This interface is a part of Windows Sonic, Microsoft’s audio platform for more immersive audio which includes integrated spatial sound on Xbox and Windows.

Members

The ISpatialAudioObjectForHrtf interface inherits from the IUnknown interface. ISpatialAudioObjectForHrtf also has these types of members:

Methods

The ISpatialAudioObjectForHrtf interface has these methods.

MethodDescription
GetAudioObjectType

Gets a value specifying the type of audio object that is represented by the ISpatialAudioObjectForHrtf. This value indicates if the object is dynamic or static. If the object is static, one and only one of the static audio channel values to which the object is assigned is returned.

GetBuffer

Gets a buffer that is used to supply the audio data for the ISpatialAudioObjectForHrtf.

IsActive

Gets a value indicating whether the ISpatialAudioObjectForHrtf is valid.

SetDirectivity

Sets the spatial audio directivity model for the ISpatialAudioObjectForHrtf.

SetDistanceDecay

Sets the decay model that is applied over distance from the position of an ISpatialAudioObjectForHrtf to the position of the listener.

SetEndOfStream

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.

SetEnvironment

Sets the type of acoustic environment that is simulated when audio is processed for the ISpatialAudioObjectForHrtf.

SetGain

Sets the gain for the ISpatialAudioObjectForHrtf.

SetOrientation

Sets the orientation in 3D space, relative to the listener's frame of reference, from which the ISpatialAudioObjectForHrtf audio data will be rendered.

SetPosition

Sets the position in 3D space, relative to the listener, from which the ISpatialAudioObjectForHrtf audio data will be rendered.

 

Requirements

Minimum supported client

Windows 10, version 1703 [desktop apps only]

Minimum supported server

Windows Server 2016 [desktop apps only]

Header

Spatialaudiohrtf.h

 

 

Show: