Microsoft DirectX 8.0

IAMAudioInputMixer インターフェイス

IAMAudioInputMixer インターフェイスは Audio Capture Filter の各入力ピンで実装され、フィルタにレベル、パン、およびイコライザを指定する。"Line in" や "Microphone" のような各ピンの名前は入力の種類を表す。

オーディオ キャプチャ フィルタの機能は、関連付けられている特定のハードウェア デバイスに対応するので、デバイスがサポートしないインターフェイス メソッドを、フィルタがサポートすることはできない。

アプリケーション開発者 : このインターフェイスを使用してサウンドカードのアナログ入力にアクセスし、特定の入力のミキシング、モノラルまたはステレオの使用、ミキシング レベル、パン レベル、ラウドネス、高音域、低音域の各種設定など、オーディオ キャプチャ フィルタにおけるオーディオ入力特性を調整できる。

フィルタ開発者 : オーディオ キャプチャ フィルタの各入力ピンでこのインターフェイスを実装する。オーディオ キャプチャ フィルタ自体にこのインターフェイスを実装し、オーディオ ミキシング後の全体の録音レベルとパンを制御することもできる。

vtable 順のメソッド

IUnknown メソッド説明
QueryInterface サポートされているインターフェイスへのポインタを取得する。
AddRef 参照カウントをインクリメントする。
Release 参照カウントをデクリメントする。
IAMAudioInputMixer メソッド説明
put_Enable ミキシングにおける入力を有効または無効にする
get_Enable 入力が有効かどうかを取得する。
put_Mono 入力のすべてのチャンネルを 1 つのモノラル信号にまとめる。
get_Mono 入力のすべてのチャンネルが 1 つのモノラル信号にまとめられているかどうかを取得する。
put_MixLevel 入力の録音レベルを設定する。
get_MixLevel 入力の録音レベルを取得する。
put_Pan 入力のパンを設定する。
get_Pan 入力のパンを取得する。
put_Loudness 入力のラウドネス コントロールをオンまたはオフにする。
get_Loudness 入力のラウドネス コントロールの設定を取得する。
put_Treble 入力の高音域のイコライジングを設定する。
get_Treble 入力の高音域のイコライジングを取得する。
get_TrebleRange 入力の高音域の範囲を取得する。
put_Bass 入力の低音域のイコライジングを設定する。
get_Bass 入力の低音域のイコライジングを取得する。
get_BassRange 入力の低音域の範囲を取得する。

IAMAudioInputMixer::get_Bass

IAMAudioInputMixer インターフェイス

この入力の低音域のイコライジングを取得する。

構文

HRESULT get_Bass(
  double *pBass
  );

パラメータ

pBass
[in] デシベル単位の低音域ゲイン (負の値は減衰を表す) を示す double タイプの変数へのポインタ。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

IAMAudioInputMixer::get_BassRange

IAMAudioInputMixer インターフェイス

この入力の低音域の範囲を取得する。

構文

HRESULT get_BassRange(
  double *pRange
  );

パラメータ

pRange
[out, retval] put_Bass で指定される低音域の範囲内の最大値を示す double タイプの変数へのポインタ。たとえば、6.0 は –6.0 から 6.0 の範囲の値が有効であることを表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

IAMAudioInputMixer::get_Enable

IAMAudioInputMixer インターフェイス

入力が有効かどうかを取得する。

構文

HRESULT get_Enable(
  BOOL *pfEnable
  );

パラメータ

pfEnable
[in] 入力のミキシングが有効かどうかを示す BOOL タイプの変数へのポインタ。TRUE は入力が有効であることを表し、FALSE は入力が無効であることを表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL情報を取得できない。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

IAMAudioInputMixer::get_Loudness

IAMAudioInputMixer インターフェイス

入力のラウドネス コントロールの設定を取得する。

構文

HRESULT get_Loudness(
  int *pfLoudness
  );

パラメータ

pfLoudness
[in] ラウドネス コントロールがオンまたはオフであることを示す int タイプの変数へのポインタ。TRUE はオンを表し、FALSE はオフを表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAILエラー。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
E_OUTOFMEMORYメモリ不足。
NOERROR成功。

IAMAudioInputMixer::get_MixLevel

IAMAudioInputMixer インターフェイス

この入力の録音レベルを取得する。

構文

HRESULT get_MixLevel(
  double *pLevel
  );

パラメータ

[out] pLevel
録音レベルを示す変数へのポインタ。値は 0 (オフ) から 1 (最大ボリューム) の範囲である。AMF_AUTOMATICGAIN (-0x0001) は、これがサポートされている場合、レベルの自動調整を表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL録音レベルの取得エラー。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

IAMAudioInputMixer::get_Mono

IAMAudioInputMixer インターフェイス

入力のすべてのチャンネルが 1 つのモノラル信号にまとめられているかどうかを取得する。

構文

HRESULT get_Mono(
  BOOL *pfMono
  );

パラメータ

pfMono
[in] モノラルが有効かどうかを示す BOOL タイプの変数へのポインタ。TRUE はモノラルが有効であることを表し、FALSE はモノラルが無効であることを表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAILモノラル コントロールの取得エラー。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

IAMAudioInputMixer::get_Pan

IAMAudioInputMixer インターフェイス

この入力のパン レベルを取得する。

構文

HRESULT get_Pan(
  double *pPan
  );

パラメータ

pPan
[in] パン レベルを示す double タイプの変数へのポインタ。有効なレベルは –1 から 1 の範囲である。値の意味は次のとおりである。
–1 左端
0 中央
1 右端

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAILパン レベルの取得エラー。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPL パンできない: ステレオでない。
NOERROR成功。

IAMAudioInputMixer::get_Treble

IAMAudioInputMixer インターフェイス

この入力の高音域のイコライジングを取得する。

構文

HRESULT get_Treble(
  double *pTreble
  );

パラメータ

pTreble
[in] デシベル単位の高音域ゲイン (負の値は減衰を表す) を示す double タイプの変数へのポインタ。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

IAMAudioInputMixer::get_TrebleRange

IAMAudioInputMixer インターフェイス

この入力の高音域の範囲を取得する。

構文

HRESULT get_TrebleRange(
  double *pRange
  );

パラメータ

pRange
[out, retval] put_Treble で指定される高音域の範囲内の最大値を示す double タイプの変数へのポインタ。たとえば、6.0 は –6.0 から 6.0 の範囲の値が有効であることを表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

IAMAudioInputMixer::put_Bass

IAMAudioInputMixer インターフェイス

この入力の低音域のイコライジングを設定する。

構文

HRESULT put_Bass(
  double Bass
  );

パラメータ

Bass
[in] デシベル単位のゲイン (負の値は減衰を表す) を示す double タイプの変数。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG引数が無効。 get_BassRange で指定される範囲になければならない。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

注意

録音前に Bass で指定されるデシベル数だけ信号の低音域の増幅または減衰が行われる。

IAMAudioInputMixer::put_Enable

IAMAudioInputMixer インターフェイス

ミキシングにおける入力を有効または無効にする。

構文

HRESULT put_Enable(
  BOOL fEnable
  );

パラメータ

fEnable
[in] 入力を有効または無効にするかを示す BOOL タイプの変数。TRUE は入力を有効にし、FALSE は入力を無効にする。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL入力の有効化または無効化が失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR 入力の有効化または無効化が成功。

注意

無効の場合、この入力が録音信号の一部としてミキシングされることはない。

IAMAudioInputMixer::put_Loudness

IAMAudioInputMixer インターフェイス

この入力のラウンドネス コントロールをオンまたはオフにする。

構文

HRESULT put_Loudness(
  BOOL fLoudness
  );

パラメータ

fLoudness
[in] ラウドネス コントロールがオンかどうかを示す BOOL タイプの変数。TRUE はラウドネス コントロールをオンに設定し、FALSE はラウドネス コントロールをオフに設定する。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAILラウドネス コントロールの設定が失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

注意

IAMAudioInputMixer::put_Loudness によって、録音前に低音域量信号の低音域が増幅され、小さな音の低音域サウンドやその他のサウンドが聞こえないという状態が補正される。

IAMAudioInputMixer::put_MixLevel

IAMAudioInputMixer インターフェイス

この入力の録音レベルを設定する。

構文

HRESULT put_MixLevel(
  double Level
  );

パラメータ

Level
録音レベルを示す double タイプの変数。値は 0 (オフ) から 1 (最大ボリューム) の範囲である。AMF_AUTOMATICGAIN (-0x0001) は、これがサポートされている場合、レベルの自動調整を表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAILボリュームの設定エラー。
E_POINTERNull ポインタ引数。
E_INVALIDARG 録音レベルは 0 から 1 の範囲でなければならない。
E_NOTIMPL 自動ゲインは現在実装されていない。
NOERROR成功。

IAMAudioInputMixer::put_Mono

IAMAudioInputMixer インターフェイス

入力のすべてのチャンネルを 1 つのモノラル信号にまとめる。

構文

HRESULT put_Mono(
  BOOL fMono
  );

パラメータ

fMono
[in] モノラル信号またはマルチチャンネル信号を示す BOOL タイプの変数。TRUE はモノラルを表し、FALSE はマルチチャンネルを表す。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAILモノラル コントロールの設定エラー。
E_POINTERNull ポインタ引数。
E_INVALIDARG無効な引数。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

注意

モノラル モードに設定されている場合、この入力をステレオ録音すると、両方のチャンネルに同じデータが格納される。左信号と右信号を合わせたものが得られる。

IAMAudioInputMixer::put_Pan

IAMAudioInputMixer インターフェイス

この入力のパンを設定する。

構文

HRESULT put_Pan(
  double Pan
  );

パラメータ

Pan
[in] パン レベルを示す double タイプの変数。Pan の有効値は、-1 から 1 の範囲である。値の意味は次のとおりである。
-1 左端
0 中央
1 右端

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAILボリュームの設定エラー。
E_POINTERNull ポインタ引数。
E_INVALIDARG パン レベルは -1 から 1 の範囲でなければならない。
E_NOTIMPL パンできない: ステレオでない。
NOERROR成功。

注意

入力のパンを左端に設定すると、入力の信号がステレオ録音の左チャンネルにのみ設定される。モノラル録音ではパンの効果はない。

IAMAudioInputMixer::put_Treble

IAMAudioInputMixer インターフェイス

この入力の高音域のイコライジングを設定する。

構文

HRESULT put_Treble(
  [in] double Treble
  );

パラメータ

Treble
[in] デシベル単位のゲイン (負の値は減衰を表す) を示す double タイプの変数。

戻り値

インターフェイスの実装に応じた HRESULT 値を返す。HRESULT は、次の標準的な定数の 1 つか、または一覧に示されていないその他の値となる。
E_FAIL失敗。
E_POINTERNull ポインタ引数。
E_INVALIDARG引数が無効。 get_TrebleRange で指定される範囲になければならない。
E_NOTIMPLメソッドがサポートされていない。
NOERROR成功。

注意

このメソッドによって、録音前に指定のデシベル数だけ信号の高音域の増幅または減衰が行われる。