IMFSinkWriter::WriteSample Method

Delivers a sample to the sink writer.

Syntax

public:
HRESULT WriteSample(
         DWORD dwStreamIndex,
         IMFSample *pSample
)

Parameters

dwStreamIndex
Type: DWORD

[in] The zero-based index of the stream for this sample.

pSample
Type: IMFSample *

[in] A pointer to the IMFSample interface of the sample.

Return value

Type: HRESULT

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

Return codes

Return code	Description
S_OK	The method succeeded.
MF_E_INVALIDREQUEST	The request is invalid.

Refer to Media Foundation return codes.

Remarks

You must call IMFSinkWriter::BeginWriting before calling this method. Otherwise, the method returns MF_E_INVALIDREQUEST.

By default, the sink writer limits the rate of incoming data by blocking the calling thread inside the WriteSample method. This prevents the application from delivering samples too quickly. To disable this behavior, set the MF_SINK_WRITER_DISABLE_THROTTLING attribute when you create the sink writer.

This interface is available on Windows Vista if Platform Update Supplement for Windows Vista is installed.

Requirements

Header: Declared in mfreadwrite.h.