Edit

IMFCaptureSource::RemoveEffect method (mfcaptureengine.h)

  • Article

Removes an effect from a capture stream.

Syntax

HRESULT RemoveEffect(
  [in] DWORD    dwSourceStreamIndex,
  [in] IUnknown *pUnknown
);

Parameters

[in] dwSourceStreamIndex

The capture stream. The value can be any of the following.

Value Meaning
0–0xFFFFFFFB
 The zero-based index of a stream. To get the number of streams, call IMFCaptureSource::GetDeviceStreamCount.
MF_CAPTURE_ENGINE_FIRST_SOURCE_PHOTO_STREAM
0xFFFFFFFB
 The first image stream.
MF_CAPTURE_ENGINE_FIRST_SOURCE_VIDEO_STREAM
0xFFFFFFFC
 The first video stream.
MF_CAPTURE_ENGINE_FIRST_SOURCE_AUDIO_STREAM
0xFFFFFFFD
 The first audio stream.

[in] pUnknown

A pointer to the IUnknown interface of the effect object.

Return value

This method can return one of these values.

Return code Description
S_OK
 Success.
MF_E_INVALIDREQUEST
 Invalid request. Possibly the specified effect could not be found.
MF_E_INVALIDSTREAMNUMBER
 The dwSourceStreamIndex parameter is invalid.

Remarks

This method removes an effect that was previously added using the IMFCaptureSource::AddEffect 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

IMFCaptureSource