IMemInputPin::Receive (Compact 2013)

  • Article

3/26/2014

This method receives the next block of data from the stream.

Syntax

HRESULT Receive(
  IMediaSample* pSample
);

Parameters

  • pSample
    [in] Pointer to a media sample.

Return Value

Returns an HRESULT value that depends on the implementation.

HRESULT can be one of the following standard constants, or other values not listed.

Value

Description

E_FAIL

Failure.

E_POINTER

Null pointer argument.

E_INVALIDARG

Invalid argument.

E_NOTIMPL

Method is not supported.

S_OK or NOERROR

Success.

Remarks

This is a blocking synchronous call.

Typically, no blocking occurs, but if a filter cannot process the sample immediately it may use the calling application's thread to wait until it can.

Use the IUnknown::AddRef method if you need to hold the returned data block beyond the completion of the IMemInputPin::Receive method.

If you use AddRef, be sure to use IUnknown::Release when done with it.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IMemInputPin Interface