ISpatialAudioObjectRenderStreamForMetadata::ActivateSpatialAudioObjectForMetadataItems メソッド (spatialaudiometadata.h)

  • [アーティクル]

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

構文

HRESULT ActivateSpatialAudioObjectForMetadataItems(
  [in]  AudioObjectType                     type,
  [out] ISpatialAudioObjectForMetadataItems **audioObject
);

パラメーター

[in] type

アクティブにするオーディオ オブジェクトの種類。 動的オーディオ オブジェクトの場合、この値は AudioObjectType_Dynamicする必要があります。 静的オーディオ オブジェクトの場合は、 列挙の静的オーディオ チャネル値のいずれかを指定します。 AudioObjectType_Noneを指定すると、空間化されていないオーディオ オブジェクトが生成されます。

[out] audioObject

アクティブ化されたインターフェイスへのポインターを受け取ります。

戻り値

メソッドが成功した場合は、S_OK を返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。

リターン コード 説明
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
 型パラメーターで指定された値は、AudioObjectType 列挙で定義されている値の 1 つではありません。
SPTLAUDCLNT_E_DESTROYED
 空間オーディオ ストリームに関連付けられている ISpatialAudioClient が破棄されました。
AUDCLNT_E_DEVICE_INVALIDATED
 オーディオ エンドポイント デバイスが取り外されているか、オーディオ ハードウェアまたは関連するハードウェア リソースが再構成、無効、削除、またはその他の方法で使用できなくなります。
SPTLAUDCLNT_E_INTERNAL
 内部エラーが発生しました。
AUDCLNT_E_UNSUPPORTED_FORMAT
 空間オーディオ ストリームに関連付けられているメディアでは、サポートされていない形式が使用されます。

注釈

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

要件

要件 値
対象プラットフォーム Windows
ヘッダー spatialaudiometadata.h

こちらもご覧ください

ISpatialAudioObjectForMetadataItems