ISpatialAudioObjectRenderStreamForMetadata::ActivateSpatialAudioObjectForMetadataCommands メソッド (spatialaudiometadata.h)
レンダリングのために ISpatialAudioObjectForMetadataCommands をアクティブ化します。
構文
HRESULT ActivateSpatialAudioObjectForMetadataCommands(
[in] AudioObjectType type,
[out] ISpatialAudioObjectForMetadataCommands **audioObject
);
パラメーター
[in] type
アクティブにするオーディオ オブジェクトの種類。 動的オーディオ オブジェクトの場合、この値は AudioObjectType_Dynamicする必要があります。 静的オーディオ オブジェクトの場合は、 列挙の静的オーディオ チャネル値のいずれかを指定します。 AudioObjectType_Noneを指定すると、空間化されていないオーディオ オブジェクトが生成されます。
[out] audioObject
アクティブ化されたインターフェイスへのポインターを受け取ります。
戻り値
メソッドが成功した場合は、S_OK を返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。
リターン コード | 説明 |
---|---|
|
同時空間オーディオ オブジェクトの最大数を超えました。 追加のオブジェクトをアクティブ化する前に、未使用のオーディオ オブジェクトに対して Release を呼び出します。 |
|
type パラメーターで指定された静的チャネルは、ISpatialAudioClient::ActivateSpatialAudioStream に渡される SpatialAudioObjectRenderStreamForMetadataActivationParams の StaticObjectTypeMask フィールドに含まれていませんでした。 |
|
空間オーディオ オブジェクトは、 type パラメーターで指定された静的チャネルに対して既にアクティブ化されています。 |
|
指定されたポインターが無効です。 |
|
型パラメーターで指定された値は、AudioObjectType 列挙で定義されている値の 1 つではありません。 |
|
空間オーディオ ストリームに関連付けられている ISpatialAudioClient が破棄されました。 |
|
オーディオ エンドポイント デバイスが取り外されているか、オーディオ ハードウェアまたは関連するハードウェア リソースが再構成、無効、削除、またはその他の方法で使用できなくなります。 |
|
内部エラーが発生しました。 |
|
空間オーディオ ストリームに関連付けられているメディアでは、サポートされていない形式が使用されます。 |
注釈
動的 ISpatialAudioObjectForMetadataCommands は、 type パラメーターを ActivateSpatialAudioObjectForMetadataCommands メソッドに 設定してAudioObjectType_Dynamicすることによってアクティブ化された値です。 クライアントには、一度にアクティブ化できる動的空間オーディオ オブジェクトの最大数の制限があります。 制限に達すると、追加のオーディオ オブジェクトをアクティブ化しようとすると、このメソッドから SPTLAUDCLNT_E_NO_MORE_OBJECTS エラーが返されます。 これを回避するには、リソースの解放に使用されなくなった後、各動的 ISpatialAudioObjectForMetadataCommands で Release を呼び出して、リソースを再割り当てできるようにします。 空間オーディオ オブジェクトの有効期間の管理の詳細については、「 ISpatialAudioObjectBase::IsActive 」および「 ISpatialAudioObjectBase::SetEndOfStream 」を参照してください。
要件
要件 | 値 |
---|---|
対象プラットフォーム | Windows |
ヘッダー | spatialaudiometadata.h |