Edit

IMFSinkWriter::Flush method (mfreadwrite.h)

  • Article

Flushes one or more streams.

Syntax

HRESULT Flush(
  [in] DWORD dwStreamIndex
);

Parameters

[in] dwStreamIndex

The zero-based index of the stream to flush, or MF_SINK_WRITER_ALL_STREAMS to flush all of the streams.

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.
MF_E_INVALIDREQUEST
 The request is invalid.

Remarks

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

For each stream that is flushed, the sink writer drops all pending samples, flushes the encoder, and sends an MFSTREAMSINK_MARKER_ENDOFSEGMENT marker to the media sink.

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

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista and Platform Update Supplement for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header mfreadwrite.h

See also

IMFSinkWriter

Sink Writer