Expand Minimize

MediaCapture.AddEffectAsync | addEffectAsync method

Applies to Windows and Windows Phone

Adds an audio or video effect.

Syntax


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

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

AddEffectAsync must complete before another effect can be added to the MediaCapture object.

See How to add video stabilization for an example of adding Windows.Media.VideoEffects.VideoStabilization effect.

Adding an in-place editing Media Foundation Transform effect into the capture preview will have no effect on the stream.

Requirements

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

See also

MediaCapture

 

 

Show:
© 2014 Microsoft