ホーム › Media.Audio.Apo › IApoAuxiliaryInputConfiguration

IApoAuxiliaryInputConfiguration

COM

IID4ceb0aab-fa19-48ed-a857-87771ae1b768継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

オーディオエンジンが補助入力ストリームを追加および削除できるように、APO が実装できるメソッドを提供します。

メソッド 3

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

vtbl 3 HRESULT AddAuxiliaryInput(DWORD dwInputId, DWORD cbDataSize, BYTE* pbyData, APO_CONNECTION_DESCRIPTOR* pInputConnection)

APO に補助入力を追加し、初期化パラメーターを提供します。

dwInputId	DWORD	in	入力の識別子。これはシステムによって生成される一意の識別子です。APO はこの識別子を使用して複数の補助入力を区別できます。
cbDataSize	DWORD	in	初期化データのサイズ (バイト単位)。
pbyData	BYTE*	in	この APO 固有の初期化データ。
pInputConnection	APO_CONNECTION_DESCRIPTOR*	in	この補助入力接続の接続記述子。

戻り値

HRESULT

HRESULT	説明
APOERR_NUM_CONNECTIONS_INVALID	APO は補助入力を想定していません。

解説(Remarks)

初期化データは可変長で、次の形式を取ります。初期化データの使用方法については、IAudioProcessingObject::Initialize を参照してください。

struct MyAPOInitializationData
{
    APOInitBaseStruct    APOInit;
    // add additional fields here...
};

このメソッドは、APO が処理のためにロックされていない場合にのみ呼び出されます。このメソッドがリアルタイム処理スレッドから呼び出されることはありません。

vtbl 4 HRESULT RemoveAuxiliaryInput(DWORD dwInputId)

APO から補助入力を削除します。

dwInputId

DWORD

入力の識別子。これはシステムによって生成される一意の識別子です。APO はこの識別子を使用して複数の補助入力を区別できます。

戻り値

HRESULT

解説(Remarks)

vtbl 5 HRESULT IsInputFormatSupported(IAudioMediaType* pRequestedInputFormat, IAudioMediaType** ppSupportedInputFormat)

特定の補助入力フォーマットが APO によってサポートされているかどうかを検証します。

pRequestedInputFormat	IAudioMediaType*	in	検証する入力フォーマット。
ppSupportedInputFormat	IAudioMediaType**	out	APO は、このメソッドに渡されたフォーマットに最も近い、サポートされている入力フォーマットをこのパラメーターに設定します。

戻り値

HRESULT

HRESULT	説明
S_OK	正常に完了しました。APO は pRequestedInputFormat への参照を追加し、それを ppSupportedInputFormat で返す必要があります。
S_FALSE	フォーマットがサポートされていません。APO は、サポートされている推奨フォーマットを ppSupportedInputFormat で返す必要があります。
APOERR_FORMAT_NOT_SUPPORTED	フォーマットがサポートされていません。APO は ppSupportedInputFormat を変更してはなりません。
E_POINTER	この関数に無効なポインターが渡されました。
その他の値	別のコンポーネントが失敗を引き起こしています。これらの失敗はシステムによって追跡されます。

解説(Remarks)

APO が要求されたフォーマットを受け入れられる場合は、要求されたフォーマットへの参照を追加し、これをサポートされる出力フォーマットとして返し、S_OK を返す必要があります。

APO が要求されたフォーマットを受け入れられない場合は、代替の要求フォーマットを提案できます。この場合、提案するフォーマットを作成して返し、S_FALSE を返す必要があります。

返されるサポート対象フォーマットは、要求されたフォーマットに最も『近い』ものである必要があります。つまり、フォーマットは次のプロパティについて (優先順に) 同じ値を持つ必要があります。

サンプルフォーマット
ビット深度
チャネル数
サンプルレート

提案フォーマットが要求フォーマットと異なる可能性があるのは、S_FALSE が返される場合のみです。何らかの失敗を返す場合は、提案フォーマットを変更しないでおく必要があります。

この API はいつでも呼び出される可能性があります。返される結果は APO の内部状態に依存し、これは外部のユーザーインターフェイスによって操作される場合があります。ただし、APO がいったん処理のためにロックされると、このフォーマットは変更できず、変更されることもありません。

このメソッドがリアルタイム処理スレッドから呼び出されることはありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IApoAuxiliaryInputConfiguration "{4CEB0AAB-FA19-48ED-A857-87771AE1B768}"
#usecom global IApoAuxiliaryInputConfiguration IID_IApoAuxiliaryInputConfiguration "{}"
#comfunc global IApoAuxiliaryInputConfiguration_AddAuxiliaryInput       3 int,int,var,var
#comfunc global IApoAuxiliaryInputConfiguration_RemoveAuxiliaryInput    4 int
#comfunc global IApoAuxiliaryInputConfiguration_IsInputFormatSupported  5 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IApoAuxiliaryInputConfiguration "{4CEB0AAB-FA19-48ED-A857-87771AE1B768}"
#usecom global IApoAuxiliaryInputConfiguration IID_IApoAuxiliaryInputConfiguration "{}"
#comfunc global IApoAuxiliaryInputConfiguration_AddAuxiliaryInput       3 int,int,sptr,sptr
#comfunc global IApoAuxiliaryInputConfiguration_RemoveAuxiliaryInput    4 int
#comfunc global IApoAuxiliaryInputConfiguration_IsInputFormatSupported  5 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。