IAudioCaptureClient::GetNextPacketSize method (audioclient.h)

The GetNextPacketSize method retrieves the number of frames in the next data packet in the capture endpoint buffer.

Syntax

HRESULT GetNextPacketSize(
  [out] UINT32 *pNumFramesInNextPacket
);

Parameters

[out] pNumFramesInNextPacket

Pointer to a UINT32 variable into which the method writes the frame count (the number of audio frames in the next capture packet).

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Remarks

Use this method only with shared-mode streams. It does not work with exclusive-mode streams.

Before calling the IAudioCaptureClient::GetBuffer method to retrieve the next data packet, the client can call GetNextPacketSize to retrieve the number of audio frames in the next packet. The count reported by GetNextPacketSize matches the count retrieved in the GetBuffer call (through the pNumFramesToRead output parameter) that follows the GetNextPacketSize call.

A packet always consists of an integral number of audio frames.

GetNextPacketSize must be called in the same thread as the GetBuffer and IAudioCaptureClient::ReleaseBuffer method calls that get and release the packets in the capture endpoint buffer.

For a code example that uses the GetNextPacketSize method, see Capturing a Stream.

Requirements

See also

IAudioCaptureClient Interface

IAudioCaptureClient::GetBuffer

IAudioCaptureClient::ReleaseBuffer

IAudioClient::GetCurrentPadding