Skip to main content
MediaCapture.AddEffectAsync | addEffectAsync method

Adds an audio or video effect.

Syntax


mediaCapture.addEffectAsync(mediaStreamType, effectActivationID, effectSettings).done( /* Your success and error handlers */ );

public IAsyncAction AddEffectAsync(
  MediaStreamType mediaStreamType, 
  string effectActivationID, 
  IPropertySet effectSettings
)

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

public:
IAsyncAction^ AddEffectAsync(
  MediaStreamType mediaStreamType, 
  String^ effectActivationID, 
  IPropertySet^ effectSettings
)

Parameters

mediaStreamType

Type: MediaStreamType

Specifies the streams to which the effect will be applied.

effectActivationID

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

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

effectSettings

Type: IPropertySet

Configuration parameters for the effect.

Return value

Type: IAsyncAction

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

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.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Media.Capture
Windows::Media::Capture [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Capabilities

webcam
microphone

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Media.Capture
Windows::Media::Capture [C++]

Metadata

Windows.winmd

Capabilities

webcam
microphone

Attributes

[ Deprecated()]

See also

MediaCapture