Skip to content

Latest commit

 

History

History
100 lines (83 loc) · 3.27 KB

nf-mfcaptureengine-imfcapturesink-prepare.md

File metadata and controls

100 lines (83 loc) · 3.27 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mfcaptureengine.IMFCaptureSink.Prepare
IMFCaptureSink::Prepare (mfcaptureengine.h)
Prepares the capture sink by loading any required pipeline components, such as encoders, video processors, and media sinks.
IMFCaptureSink interface [Media Foundation]
Prepare method
IMFCaptureSink.Prepare
IMFCaptureSink::Prepare
Prepare
Prepare method [Media Foundation]
Prepare method [Media Foundation]
IMFCaptureSink interface
mf.imfcapturesink_prepare
mfcaptureengine/IMFCaptureSink::Prepare
mf\imfcapturesink_prepare.htm
mf
244FD291-AD1D-4A51-87C3-C98B33978AA1
12/05/2018
IMFCaptureSink interface [Media Foundation],Prepare method, IMFCaptureSink.Prepare, IMFCaptureSink::Prepare, Prepare, Prepare method [Media Foundation], Prepare method [Media Foundation],IMFCaptureSink interface, mf.imfcapturesink_prepare, mfcaptureengine/IMFCaptureSink::Prepare
mfcaptureengine.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
Windows
19H1
IMFCaptureSink::Prepare
mfcaptureengine/IMFCaptureSink::Prepare
c++
APIRef
kbSyntax
COM
mfcaptureengine.h
IMFCaptureSink.Prepare

IMFCaptureSink::Prepare

-description

Prepares the capture sink by loading any required pipeline components, such as encoders, video processors, and media sinks.

-returns

This method can return one of these values.

Return code Description
S_OK
Success.
MF_E_INVALIDREQUEST
Invalid request.

-remarks

Calling this method is optional. This method gives the application an opportunity to configure the pipeline components before they are used. The method is asynchronous. If the method returns a success code, the caller will receive an MF_CAPTURE_SINK_PREPARED event through the IMFCaptureEngineOnEventCallback::OnEvent method. After this event is received, call IMFCaptureSink::GetService to configure individual components.

Before calling this method, configure the capture sink by adding at least one stream. To add a stream, call IMFCaptureSink::AddStream.

The Prepare method fails if the capture sink is currently in use. For example, calling Prepare on the preview sink fails if the capture engine is currently previewing.

-see-also

IMFCaptureSink