MediaCapture.AddEffectAsync(MediaStreamType, String, IPropertySet) Method

Definition

Namespace:

Windows.Media.Capture

Adds an audio or video effect.

public:
 virtual IAsyncAction ^ AddEffectAsync(MediaStreamType mediaStreamType, Platform::String ^ effectActivationID, IPropertySet ^ effectSettings) = AddEffectAsync;

/// [Windows.Foundation.Metadata.Deprecated("AddEffectAsync might not be available in future versions of Windows. Starting with Windows Threshold, use AddAudioEffectAsync and AddVideoEffectAsync instead", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Foundation.UniversalApiContract")]
IAsyncAction AddEffectAsync(MediaStreamType const& mediaStreamType, winrt::hstring const& effectActivationID, IPropertySet const& effectSettings);

[Windows.Foundation.Metadata.Deprecated("AddEffectAsync might not be available in future versions of Windows. Starting with Windows Threshold, use AddAudioEffectAsync and AddVideoEffectAsync instead", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Foundation.UniversalApiContract")]
public IAsyncAction AddEffectAsync(MediaStreamType mediaStreamType, string effectActivationID, IPropertySet effectSettings);

function addEffectAsync(mediaStreamType, effectActivationID, effectSettings)

Public Function AddEffectAsync (mediaStreamType As MediaStreamType, effectActivationID As String, effectSettings As IPropertySet) As IAsyncAction

Parameters

mediaStreamType

MediaStreamType

Specifies the streams to which the effect will be applied.

effectActivationID

String

Platform::String

winrt::hstring

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

effectSettings

IPropertySet

Configuration parameters for the effect.

Returns

IAsyncAction

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

Attributes

DeprecatedAttribute

Windows requirements

App capabilities

backgroundMediaRecording microphone webcam

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.