Share via


capGetAudioFormat

The capGetAudioFormat macro obtains the audio format. You can use this macro or explicitly call the WM_CAP_GET_AUDIOFORMAT message.

DWORD capGetAudioFormat(
  hwnd,           
  psAudioFormat,  
  wSize           
);

Parameters

hwnd

Handle to a capture window.

psAudioFormat

Pointer to a WAVEFORMATEX structure, or NULL. If the value is NULL, the size, in bytes, required to hold the WAVEFORMATEX structure is returned.

wSize

Size, in bytes, of the structure referenced by s.

Return Values

Returns the size, in bytes, of the audio format.

Remarks

Because compressed audio formats vary in size requirements applications must first retrieve the size, then allocate memory, and finally request the audio format data.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Vfw.h.

See Also

Video Capture, Video Capture Macros, WAVEFORMATEX, WM_CAP_GET_AUDIOFORMAT