MediaElement.AddAudioEffect(String, Boolean, IPropertySet) MediaElement.AddAudioEffect(String, Boolean, IPropertySet) MediaElement.AddAudioEffect(String, Boolean, IPropertySet) MediaElement.AddAudioEffect(String, Boolean, IPropertySet) Method

Definition

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

public : void AddAudioEffect(Platform::String effectID, bool effectOptional, IPropertySet effectConfiguration)
void AddAudioEffect(winrt::hstring effectID, bool effectOptional, IPropertySet effectConfiguration) const;
public void AddAudioEffect(String effectID, Boolean effectOptional, IPropertySet effectConfiguration)
Public Sub AddAudioEffect(effectID As String, effectOptional As Boolean, effectConfiguration As IPropertySet)
Parameters
effectID
String String

The identifier for the desired effect.

effectOptional
Boolean Boolean

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
IPropertySet 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.