IMFCaptureEngine::StopPreview method (mfcaptureengine.h)

Stops preview.

Syntax

HRESULT StopPreview();

Return value

This method can return one of these values.

Return code Description
S_OK
Success.
MF_E_INVALIDREQUEST
The capture engine is not currently previewing.

Remarks

This method is asynchronous. If the method returns a success code, the caller will receive an MF_CAPTURE_ENGINE_PREVIEW_STOPPED 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.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header mfcaptureengine.h

See also

IMFCaptureEngine