ISpatialAudioObjectRenderStream
COM公式ドキュメント
空間オーディオオブジェクトレンダーストリームを制御するためのメソッドを提供します。ストリームの開始、停止、リセットなどが含まれます。
解説(Remarks)
メソッド 1
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
オーディオレンダリング用に ISpatialAudioObject をアクティブ化します。
| type | AudioObjectType | in | アクティブ化するオーディオオブジェクトの種類。動的オーディオオブジェクトの場合、この値は AudioObjectType_Dynamic でなければなりません。静的オーディオオブジェクトの場合は、列挙体の静的オーディオチャネル値のいずれかを指定します。AudioObjectType_None を指定すると、空間化されないオーディオオブジェクトが生成されます。 |
| audioObject | ISpatialAudioObject** | out | アクティブ化されたインターフェイスへのポインターを受け取ります。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合の戻り値には、次の表に示す値が含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| システムが同時に扱えるオーディオオブジェクトの最大数に達しました。 | |
| 空間オーディオストリームに関連付けられた ISpatialAudioClient は破棄されています。 | |
| オーディオエンドポイントデバイスが取り外されたか、オーディオハードウェアまたは関連するハードウェアリソースが再構成、無効化、削除、またはその他の理由で使用できない状態になりました。 | |
| 内部エラーが発生しました。 | |
| 空間オーディオストリームに関連付けられたメディアがサポートされていない形式を使用しています。 |
解説(Remarks)
動的な ISpatialAudioObject とは、ActivateSpatialAudioObject メソッドの type パラメーターに AudioObjectType_Dynamic を設定してアクティブ化されたものです。クライアントには、同時にアクティブ化できる動的空間オーディオオブジェクトの最大数に上限があります。この上限に達した後にさらにオーディオオブジェクトをアクティブ化しようとすると、このメソッドは SPTLAUDCLNT_E_NO_MORE_OBJECTS エラーを返します。これを回避するには、各動的 ISpatialAudioObject が使用されなくなった後に Release を呼び出してリソースを解放し、再割り当てできるようにしてください。空間オーディオオブジェクトの有効期間の管理について詳しくは、ISpatialAudioObject::IsActive および ISpatialAudioObject::SetEndOfStream を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ISpatialAudioObjectRenderStream "{BAB5F473-B423-477B-85F5-B5A332A04153}"
#usecom global ISpatialAudioObjectRenderStream IID_ISpatialAudioObjectRenderStream "{}"
#comfunc global ISpatialAudioObjectRenderStream_ActivateSpatialAudioObject 10 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。