MediaElement.AddAudioEffect(String, Boolean, IPropertySet) Method

Reference

Definition

Namespace:: Windows.UI.Xaml.Controls

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

public:
 virtual void AddAudioEffect(Platform::String ^ effectID, bool effectOptional, IPropertySet ^ effectConfiguration) = AddAudioEffect;

void AddAudioEffect(winrt::hstring const& effectID, bool const& effectOptional, IPropertySet const& effectConfiguration);

public void AddAudioEffect(string effectID, bool effectOptional, IPropertySet effectConfiguration);

function addAudioEffect(effectID, effectOptional, effectConfiguration)

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

Parameters

effectID: String
Platform::String

winrt::hstring

The identifier for the desired effect.

effectOptional: Boolean
bool

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

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.

Applies to