Skip to content

Latest commit

 

History

History
101 lines (80 loc) · 3.76 KB

nf-spatialaudioclient-ispatialaudioclient-getstaticobjectposition.md

File metadata and controls

101 lines (80 loc) · 3.76 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:spatialaudioclient.ISpatialAudioClient.GetStaticObjectPosition
ISpatialAudioClient::GetStaticObjectPosition (spatialaudioclient.h)
Gets the position in 3D space of the specified static spatial audio channel.
GetStaticObjectPosition
GetStaticObjectPosition method [Core Audio]
GetStaticObjectPosition method [Core Audio]
ISpatialAudioClient interface
ISpatialAudioClient interface [Core Audio]
GetStaticObjectPosition method
ISpatialAudioClient.GetStaticObjectPosition
ISpatialAudioClient::GetStaticObjectPosition
coreaudio.ispatialaudioclient_getstaticobjectposition
spatialaudioclient/ISpatialAudioClient::GetStaticObjectPosition
coreaudio\ispatialaudioclient_getstaticobjectposition.htm
CoreAudio
F8CD558A-994D-46E0-98A0-1D7AD3B919C0
12/05/2018
GetStaticObjectPosition, GetStaticObjectPosition method [Core Audio], GetStaticObjectPosition method [Core Audio],ISpatialAudioClient interface, ISpatialAudioClient interface [Core Audio],GetStaticObjectPosition method, ISpatialAudioClient.GetStaticObjectPosition, ISpatialAudioClient::GetStaticObjectPosition, coreaudio.ispatialaudioclient_getstaticobjectposition, spatialaudioclient/ISpatialAudioClient::GetStaticObjectPosition
spatialaudioclient.h
Windows
Windows
19H1
ISpatialAudioClient::GetStaticObjectPosition
spatialaudioclient/ISpatialAudioClient::GetStaticObjectPosition
c++
APIRef
kbSyntax
COM
spatialaudioclient.h
ISpatialAudioClient.GetStaticObjectPosition

ISpatialAudioClient::GetStaticObjectPosition

-description

Gets the position in 3D space of the specified static spatial audio channel.

-parameters

-param type [in]

A value indicating the static spatial audio channel for which the position is being queried. This method will return E_INVALIDARG if the value does not represent a static channel, including AudioObjectType_Dynamic and AudioObjectType_None.

-param x [out]

The x coordinate of the static audio channel, in meters, relative to the listener. Positive values are to the right of the listener and negative values are to the left.

-param y [out]

The y coordinate of the static audio channel, in meters, relative to the listener. Positive values are above the listener and negative values are below.

-param z [out]

The z coordinate of the static audio channel, in meters, relative to the listener. Positive values are behind the listener and negative values are in front.

-returns

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
E_INVALIDARG
The supplied AudioObjectType value does not represent a static channel.

-remarks

Position values use a right-handed Cartesian coordinate system, where each unit represents 1 meter. The coordinate system is relative to the listener where the origin (x=0.0, y=0.0, z=0.0) represents the center point between the listener's ears.

-see-also

ISpatialAudioClient