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

Definition

Adds an audio effect to the playback stream of the MediaPlayer.

public : void AddAudioEffect(Platform::String activatableClassId, bool effectOptional, IPropertySet configuration)
void AddAudioEffect(winrt::hstring activatableClassId, bool effectOptional, IPropertySet configuration) const;
public void AddAudioEffect(String activatableClassId, Boolean effectOptional, IPropertySet configuration)
Public Sub AddAudioEffect(activatableClassId As String, effectOptional As Boolean, configuration As IPropertySet)
mediaPlayer.addAudioEffect(activatableClassId, effectOptional, configuration);

Parameters

activatableClassId
String String String

The activatable class ID of the audio effect to add to the playback stream.

effectOptional
Boolean Boolean Boolean

A value indicating whether the effect is optional.

configuration
IPropertySet IPropertySet IPropertySet

A property set containing configuration settings for the specified audio effect.

Additional features and requirements

Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

To remove audio effects from the playback stream, call RemoveAllEffects.