Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetBufferSizeLimits
Collapse the table of content
Expand the table of content

IAudioClient2::GetBufferSizeLimits method

The GetBufferSizeLimits method returns the buffer size limits of the hardware audio engine in 100-nanosecond units.

Syntax


HRESULT GetBufferSizeLimits(
  [in]  const WAVEFORMATEX   *pFormat,
  [in]        BOOL           bEventDriven,
  [out]       REFERENCE_TIME *phnsMinBufferDuration,
  [out]       REFERENCE_TIME *phnsMaxBufferDuration
);

Parameters

pFormat [in]

A pointer to the target format that is being queried for the buffer size limit.

bEventDriven [in]

Boolean value to indicate whether or not the stream can be event-driven.

phnsMinBufferDuration [out]

Returns a pointer to the minimum buffer size (in 100-nanosecond units) that is required for the underlying hardware audio engine to operate at the format specified in the pFormat parameter, without frequent audio glitching.

phnsMaxBufferDuration [out]

Returns a pointer to the maximum buffer size (in 100-nanosecond units) that the underlying hardware audio engine can support for the format specified in the pFormat parameter.

Return value

The GetBufferSizeLimits method returns S_OK to indicate that it has completed successfully. Otherwise it returns an appropriate error code. For example, it can return AUDCLNT_E_DEVICEINVALIDATED, if the device was removed and the method is called.

Remarks

The GetBufferSizeLimits method is a device-facing method and does not require prior audio stream initialization.

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Audioclient.h

See also

IAudioClient2

 

 

Community Additions

ADD
Show:
© 2015 Microsoft