Skip to content

Latest commit

 

History

History
100 lines (83 loc) · 3.23 KB

nf-mfcaptureengine-imfcaptureengine-startpreview.md

File metadata and controls

100 lines (83 loc) · 3.23 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.IMFCaptureEngine.StartPreview
IMFCaptureEngine::StartPreview (mfcaptureengine.h)
Starts preview.
IMFCaptureEngine interface [Media Foundation]
StartPreview method
IMFCaptureEngine.StartPreview
IMFCaptureEngine::StartPreview
StartPreview
StartPreview method [Media Foundation]
StartPreview method [Media Foundation]
IMFCaptureEngine interface
mf.imfcaptureengine_startpreview
mfcaptureengine/IMFCaptureEngine::StartPreview
mf\imfcaptureengine_startpreview.htm
mf
C5BCF990-E7F9-48E9-B082-79953F5ED27C
12/05/2018
IMFCaptureEngine interface [Media Foundation],StartPreview method, IMFCaptureEngine.StartPreview, IMFCaptureEngine::StartPreview, StartPreview, StartPreview method [Media Foundation], StartPreview method [Media Foundation],IMFCaptureEngine interface, mf.imfcaptureengine_startpreview, mfcaptureengine/IMFCaptureEngine::StartPreview
mfcaptureengine.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
Windows
19H1
IMFCaptureEngine::StartPreview
mfcaptureengine/IMFCaptureEngine::StartPreview
c++
APIRef
kbSyntax
COM
mfcaptureengine.h
IMFCaptureEngine.StartPreview

IMFCaptureEngine::StartPreview

-description

Starts preview.

-returns

This method can return one of these values.

Return code Description
S_OK
Success.
MF_E_INVALIDREQUEST
The preview sink was not initialized.

-remarks

Before calling this method, configure the preview sink by calling IMFCaptureSink::AddStream. To get a pointer to the preview sink, call IMFCaptureEngine::GetSink.

This method is asynchronous. If the method returns a success code, the caller will receive an MF_CAPTURE_ENGINE_PREVIEW_STARTED event through the IMFCaptureEngineOnEventCallback::OnEvent method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the OnEvent method.

After the preview sink is configured, you can stop and start preview by calling IMFCaptureEngine::StopPreview and IMFCaptureEngine::StartPreview.

-see-also

IMFCaptureEngine