ホーム › Media.Audio › ISpatialAudioObjectRenderStreamForMetadata

ISpatialAudioObjectRenderStreamForMetadata

COM

📘 Microsoft Learn (日本語) · English

IIDbbc9c907-48d5-4a2e-a0c7-f7f0d67c1fb1継承元ISpatialAudioObjectRenderStreamBase自前メソッド開始 vtbl10

公式ドキュメント

メタデータ用の空間オーディオオブジェクトレンダーストリームを制御するためのメソッドを提供します。ストリームの開始、停止、リセットなどを行います。

解説(Remarks)

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

メソッド 2

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

vtbl 10 HRESULT ActivateSpatialAudioObjectForMetadataCommands(AudioObjectType type, ISpatialAudioObjectForMetadataCommands** audioObject)

レンダリング用に ISpatialAudioObjectForMetadataCommands をアクティブ化します。

type	AudioObjectType	in	アクティブ化するオーディオオブジェクトの種類。動的オーディオオブジェクトの場合、この値は AudioObjectType_Dynamic でなければなりません。静的オーディオオブジェクトの場合は、列挙体の静的オーディオチャネル値のいずれかを指定します。AudioObjectType_None を指定すると、空間化されないオーディオオブジェクトが生成されます。
audioObject	ISpatialAudioObjectForMetadataCommands**	out	アクティブ化されたインターフェイスへのポインターを受け取ります。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合の戻り値には、次の表に示す値が含まれますが、これらに限定されません。

Return code	Description
SPTLAUDCLNT_E_NO_MORE_OBJECTS	同時に使用できる空間オーディオオブジェクトの最大数を超えました。追加のオブジェクトをアクティブ化する前に、使用していないオーディオオブジェクトに対して Release を呼び出してください。
SPTLAUDCLNT_E_STATIC_OBJECT_NOT_AVAILABLE	type パラメーターで指定された静的チャネルが、ISpatialAudioClient::ActivateSpatialAudioStream に渡された SpatialAudioObjectRenderStreamForMetadataActivationParams の StaticObjectTypeMask フィールドに含まれていませんでした。
SPTLAUDCLNT_E_OBJECT_ALREADY_ACTIVE	type パラメーターで指定された静的チャネルに対して、空間オーディオオブジェクトが既にアクティブ化されています。
E_POINTER	指定されたポインターが無効です。
E_INVALIDARG	type パラメーターで指定された値が、AudioObjectType 列挙体で定義された値のいずれでもありません。
SPTLAUDCLNT_E_DESTROYED	空間オーディオストリームに関連付けられた ISpatialAudioClient が破棄されています。
AUDCLNT_E_DEVICE_INVALIDATED	オーディオエンドポイントデバイスが取り外されたか、オーディオハードウェアまたは関連するハードウェアリソースが再構成、無効化、削除、その他の理由で使用できなくなっています。
SPTLAUDCLNT_E_INTERNAL	内部エラーが発生しました。
AUDCLNT_E_UNSUPPORTED_FORMAT	空間オーディオストリームに関連付けられたメディアが、サポートされていない形式を使用しています。

解説(Remarks)

動的な ISpatialAudioObjectForMetadataCommands とは、ActivateSpatialAudioObjectForMetadataCommands メソッドの type パラメーターを AudioObjectType_Dynamic に設定してアクティブ化されたものを指します。クライアントには、同時にアクティブ化できる動的空間オーディオオブジェクトの最大数に上限があります。上限に達した後にさらにオーディオオブジェクトをアクティブ化しようとすると、このメソッドは SPTLAUDCLNT_E_NO_MORE_OBJECTS エラーを返します。これを回避するには、各動的 ISpatialAudioObjectForMetadataCommands が不要になった時点で Release を呼び出し、リソースを解放して再割り当てできるようにしてください。空間オーディオオブジェクトの有効期間の管理について詳しくは、ISpatialAudioObjectBase::IsActive および ISpatialAudioObjectBase::SetEndOfStream を参照してください。

vtbl 11 HRESULT ActivateSpatialAudioObjectForMetadataItems(AudioObjectType type, ISpatialAudioObjectForMetadataItems** audioObject)

レンダリング用に ISpatialAudioObjectForMetadataItems をアクティブ化します。

type	AudioObjectType	in	アクティブ化するオーディオオブジェクトの種類。動的オーディオオブジェクトの場合、この値は AudioObjectType_Dynamic でなければなりません。静的オーディオオブジェクトの場合は、列挙体の静的オーディオチャネル値のいずれかを指定します。AudioObjectType_None を指定すると、空間化されないオーディオオブジェクトが生成されます。
audioObject	ISpatialAudioObjectForMetadataItems**	out	アクティブ化されたインターフェイスへのポインターを受け取ります。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合の戻り値には、次の表に示す値が含まれますが、これらに限定されません。

Return code	Description
SPTLAUDCLNT_E_NO_MORE_OBJECTS	同時に使用できる空間オーディオオブジェクトの最大数を超えました。追加のオブジェクトをアクティブ化する前に、使用していないオーディオオブジェクトに対して Release を呼び出してください。
SPTLAUDCLNT_E_STATIC_OBJECT_NOT_AVAILABLE	type パラメーターで指定された静的チャネルが、ISpatialAudioClient::ActivateSpatialAudioStream に渡された SpatialAudioObjectRenderStreamForMetadataActivationParams の StaticObjectTypeMask フィールドに含まれていませんでした。
SPTLAUDCLNT_E_OBJECT_ALREADY_ACTIVE	type パラメーターで指定された静的チャネルに対して、空間オーディオオブジェクトが既にアクティブ化されています。
E_POINTER	指定されたポインターが無効です。
E_INVALIDARG	type パラメーターで指定された値が、AudioObjectType 列挙体で定義された値のいずれでもありません。
SPTLAUDCLNT_E_DESTROYED	空間オーディオストリームに関連付けられた ISpatialAudioClient が破棄されています。
AUDCLNT_E_DEVICE_INVALIDATED	オーディオエンドポイントデバイスが取り外されたか、オーディオハードウェアまたは関連するハードウェアリソースが再構成、無効化、削除、その他の理由で使用できなくなっています。
SPTLAUDCLNT_E_INTERNAL	内部エラーが発生しました。
AUDCLNT_E_UNSUPPORTED_FORMAT	空間オーディオストリームに関連付けられたメディアが、サポートされていない形式を使用しています。

解説(Remarks)

動的な ISpatialAudioObjectForMetadataItems とは、ActivateSpatialAudioObjectForMetadataItems メソッドの type パラメーターを AudioObjectType_Dynamic に設定してアクティブ化されたものを指します。クライアントには、同時にアクティブ化できる動的空間オーディオオブジェクトの最大数に上限があります。上限に達した後にさらにオーディオオブジェクトをアクティブ化しようとすると、このメソッドは SPTLAUDCLNT_E_NO_MORE_OBJECTS エラーを返します。これを回避するには、各動的 ISpatialAudioObjectForMetadataItems が不要になった時点で Release を呼び出し、リソースを解放して再割り当てできるようにしてください。空間オーディオオブジェクトの有効期間の管理について詳しくは、ISpatialAudioObjectBase::IsActive および ISpatialAudioObjectBase::SetEndOfStream を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISpatialAudioObjectRenderStreamForMetadata "{BBC9C907-48D5-4A2E-A0C7-F7F0D67C1FB1}"
#usecom global ISpatialAudioObjectRenderStreamForMetadata IID_ISpatialAudioObjectRenderStreamForMetadata "{}"
#comfunc global ISpatialAudioObjectRenderStreamForMetadata_ActivateSpatialAudioObjectForMetadataCommands  10 int,sptr
#comfunc global ISpatialAudioObjectRenderStreamForMetadata_ActivateSpatialAudioObjectForMetadataItems     11 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。