COutputQueue.ReceiveMultiple method

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The ReceiveMultiple method delivers a batch of media samples to the input pin.

Syntax

HRESULT ReceiveMultiple(
   IMediaSample **ppSamples,
   long         nSamples,
   long         *nSamplesProcessed
);

Parameters

ppSamples

Address of a pointer to an array of samples.

nSamples

Number of samples in the array.

nSamplesProcessed

Pointer to a variable that receives the number of samples delivered successfully.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return code Description
S_FALSE
 End-of-stream notification received before processing this sample.
S_OK
 Success.

Remarks

If the object is using a thread, this method queues all of the samples passed in the array. Otherwise, the method calls the IMemInputPin::ReceiveMultiple method on the input pin.

Requirements

Requirement Value
Header
Outputq.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

COutputQueue Class