Win32 API 日本語リファレンス
ホーム › Media.Audio › ISpatialAudioObject

ISpatialAudioObject

COM
📘 Microsoft Learn (日本語) · English
IIDdde28967-521b-46e5-8f00-bd6f2bc8ab1d継承元ISpatialAudioObjectBase自前メソッド開始 vtbl7

公式ドキュメント

ユーザーを基準とした3D空間内の位置からレンダリングされるオーディオデータを提供するオブジェクトを表します。

解説(Remarks)

Note このインターフェイスが提供するメソッドの多くは、継承元の ISpatialAudioObjectBase インターフェイスで実装されています。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 7 HRESULT SetPosition(FLOAT x, FLOAT y, FLOAT z)

ISpatialAudioObject のオーディオデータをレンダリングする、リスナーを基準とした3D空間内の位置を設定します。

xFLOATinオーディオオブジェクトの x 位置(リスナーを基準としたメートル単位)。正の値はリスナーの右側、負の値は左側を表します。
yFLOATinオーディオオブジェクトの y 位置(リスナーを基準としたメートル単位)。正の値はリスナーの上方、負の値は下方を表します。
zFLOATinオーディオオブジェクトの z 位置(リスナーを基準としたメートル単位)。正の値はリスナーの後方、負の値は前方を表します。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには、以下の表に示す値が含まれます(ただしこれらに限定されません)。

戻り値コード 説明
SPTLAUDCLNT_E_OUT_OF_ORDER

SetPosition の呼び出しの前に ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects が呼び出されていませんでした。
SPTLAUDCLNT_E_RESOURCES_INVALIDATED

以前のオーディオ処理パスで SetEndOfStream が明示的または暗黙的に呼び出されました。オーディオ処理パス内(ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects と ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects の呼び出しの間)で GetBuffer が呼び出されなかった場合、SetEndOfStream はシステムによって暗黙的に呼び出されます。
SPTLAUDCLNT_E_PROPERTY_NOT_SUPPORTED
ISpatialAudioObject が AudioObjectType_Dynamic 型ではありません。ISpatialAudioObjectRenderStreamBase::ActivateSpatialAudioObject メソッドの type パラメーターでオーディオオブジェクトの型を設定してください。

解説(Remarks)

このメソッドは、AudioObjectType_Dynamic 型の ISpatialAudioObject に対してのみ呼び出すことができます。ISpatialAudioObjectRenderStreamBase::ActivateSpatialAudioObject メソッドの type パラメーターでオーディオオブジェクトの型を設定してください。

位置の値は右手系のデカルト座標系を使用し、各単位は1メートルを表します。座標系はリスナーを基準としており、原点(x=0.0, y=0.0, z=0.0)はリスナーの両耳の中間点を表します。

SetPosition が一度も呼び出されない場合、原点(x=0.0, y=0.0, z=0.0)が既定の位置として使用されます。SetPosition が呼び出されると、設定された位置は、別の SetPosition の呼び出しによって位置が変更されるまで、オーディオオブジェクトに対して使用されます。

vtbl 8 HRESULT SetVolume(FLOAT volume)

ISpatialAudioObject が提供するオーディオデータに、オーディオレンダリングエンジンへ送信される前に適用される振幅乗数を設定します。

volumeFLOATinオーディオデータに対する振幅乗数。0.0 から 1.0 の間の値でなければなりません。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには、以下の表に示す値が含まれます(ただしこれらに限定されません)。

戻り値コード 説明
SPTLAUDCLNT_E_OUT_OF_ORDER

SetVolume の呼び出しの前に ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects が呼び出されていませんでした。
SPTLAUDCLNT_E_RESOURCES_INVALIDATED

以前のオーディオ処理パスで SetEndOfStream が明示的または暗黙的に呼び出されました。オーディオ処理パス内(ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects と ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects の呼び出しの間)で GetBuffer が呼び出されなかった場合、SetEndOfStream はシステムによって暗黙的に呼び出されます。

解説(Remarks)

SetVolume が一度も呼び出されない場合、既定値の 1.0 が使用されます。SetVolume が呼び出されると、設定された音量は、別の SetVolume の呼び出しによって音量が変更されるまで、オーディオオブジェクトに対して使用されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

#define global IID_ISpatialAudioObject "{DDE28967-521B-46E5-8F00-BD6F2BC8AB1D}"
#usecom global ISpatialAudioObject IID_ISpatialAudioObject "{}"
#comfunc global ISpatialAudioObject_SetPosition  7 float,float,float
#comfunc global ISpatialAudioObject_SetVolume    8 float
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。