Expand Minimize

MediaElement.AddAudioEffect method

Applies to Windows and Windows Phone

Applies an audio effect to playback. Takes effect for the next source that is set on this MediaElement.

Syntax


Public Sub AddAudioEffect(
  effectID As String,  
  effectOptional As Boolean,  
  effectConfiguration As IPropertySet 
)

Parameters

effectID

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

The identifier for the desired effect.

effectOptional

Type: System.Boolean [.NET] | Platform::Boolean [C++]

true if the effect shouldn't block playback when the effect can't be used at run time. false if the effect should block playback when the effect can't be used at run time.

effectConfiguration

Type: IPropertySet

A property set that transmits property values to specific effects as selected by effectID.

Remarks

The audio effects needs to be added before loading the source. Otherwise, it will be applied for the next source that is set on this MediaElement.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.winmd

See also

MediaElement

 

 

Show:
© 2014 Microsoft