Platform SDK: DirectX

IDirectSoundCaptureBuffer::GetFormat

IDirectSoundCaptureBuffer::GetFormat メソッドは、サウンド キャプチャ バッファの現在のフォーマットを取得する。

HRESULT GetFormat(
  LPWAVEFORMATEX lpwfxFormat,  
  DWORD dwSizeAllocated,   
  LPDWORD lpdwSizeWritten  
);

パラメータ

lpwfxFormat
WAVEFORMATEX 変数のアドレス。この変数は、キャプチャ バッファ内のサウンド データの記述を保持している。フォーマットの記述を保持するのに必要なバッファ サイズを取得するには NULL を指定する。この場合、lpdwSizeWritten パラメータが指す DWORD が、完全なフォーマット情報を受け取るのに必要な構造体のサイズを受け取る。
dwSizeAllocated
WAVEFORMATEX 構造体のサイズ。単位はバイト。DirectSoundCapture が構造体へ書き込むバイト数は、最大で dwSizeAllocated バイトである。構造体がそれより多くのメモリを必要とする場合、切り捨てが行われる。
lpdwSizeWritten
WAVEFORMATEX 構造体に書き込まれたバイト数を受け取る変数のアドレス。このパラメータは NULL にしてもよい。

戻り値

成功すれば DS_OK、失敗すれば DSERR_INVALIDPARAM を返す。

動作環境

  Windows NT/2000 : Windows 2000 が必要。
  Windows 95/98 : Windows 95 以降が必要。Windows 95 用に再配布可能な形で使用可能。
  ヘッダー : dsound.h で宣言。
  インポート ライブラリ : dsound.lib を使用。