MediaCapture.AddEffectAsync(MediaStreamType, String, IPropertySet) MediaCapture.AddEffectAsync(MediaStreamType, String, IPropertySet) MediaCapture.AddEffectAsync(MediaStreamType, String, IPropertySet) MediaCapture.AddEffectAsync(MediaStreamType, String, IPropertySet) MediaCapture.AddEffectAsync(MediaStreamType, String, IPropertySet) Method

Definition

Adds an audio or video effect.

public : IAsyncAction AddEffectAsync(MediaStreamType mediaStreamType, Platform::String effectActivationID, IPropertySet effectSettings)
IAsyncAction AddEffectAsync(MediaStreamType mediaStreamType, winrt::hstring effectActivationID, IPropertySet effectSettings) const;
public IAsyncAction AddEffectAsync(MediaStreamType mediaStreamType, String effectActivationID, IPropertySet effectSettings)
Public Function AddEffectAsync(mediaStreamType As MediaStreamType, effectActivationID As String, effectSettings As IPropertySet) As IAsyncAction
Windows.Media.Capture.MediaCapture.addEffectAsync(mediaStreamType, effectActivationID, effectSettings).done( /* Your success and error handlers */ );

Parameters

mediaStreamType
MediaStreamType MediaStreamType MediaStreamType

Specifies the streams to which the effect will be applied.

effectActivationID
String String String

The class identifier of the activatable runtime class that implements the effect. The runtime class must implement the IMediaExtension interface.

effectSettings
IPropertySet IPropertySet IPropertySet

Configuration parameters for the effect.

Returns

Returns an IAsyncAction object that is used to control the asynchronous operation.

Additional features and requirements

Capabilities
webcam backgroundMediaRecording microphone

Remarks

As of Windows 10, this method is deprecated. Use AddAudioEffectAsync or AddVideoEffectAsync instead. For how-to guidance on adding effects to the camera capture and preview streams, see Effects for video capture.