IMFSample::GetBufferByIndex method

Gets a buffer from the sample, by index.

Note  In most cases, it is safer to use the IMFSample::ConvertToContiguousBuffer method. If the sample contains more than one buffer, the ConvertToContiguousBuffer method replaces them with a single buffer, copies the original data into that buffer, and returns the new buffer to the caller. The copy operation occurs at most once. On subsequent calls, no data is copied.
 

Syntax

HRESULT GetBufferByIndex(
  DWORD          dwIndex,
  IMFMediaBuffer **ppBuffer
);

Parameters

dwIndex

Index of the buffer. To find the number of buffers in the sample, call IMFSample::GetBufferCount. Buffers are indexed from zero.

ppBuffer

Receives a pointer to the IMFMediaBuffer interface. The caller must release the interface.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
E_INVALIDARG
NULL pointer argument, or the index is out of range.

Remarks

A sample might contain more than one buffer. Use the GetBufferByIndex method to enumerate the individual buffers.

This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:

  • Windows XP with Service Pack 2 (SP2) and later.
  • Windows XP Media Center Edition 2005 with KB900325 (Windows XP Media Center Edition 2005) and KB925766 (October 2006 Update Rollup for Windows XP Media Center Edition) installed.

Requirements

   
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header mfobjects.h (include Mfidl.h)
Library Mfuuid.lib

See Also

IMFSample

IMFSample::ConvertToContiguousBuffer

Media Samples