MediaPlayer.AddAudioEffect(String, Boolean, IPropertySet) Method

Reference

Definition

Namespace:: Windows.Media.Playback

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

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

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

void AddAudioEffect(winrt::hstring const& activatableClassId, bool const& effectOptional, IPropertySet const& configuration);

public void AddAudioEffect(string activatableClassId, bool effectOptional, IPropertySet configuration);

function addAudioEffect(activatableClassId, effectOptional, configuration)

Public Sub AddAudioEffect (activatableClassId As String, effectOptional As Boolean, configuration As IPropertySet)

Parameters

activatableClassId: String
Platform::String

winrt::hstring

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

effectOptional: Boolean
bool

A value indicating whether the effect is optional.

configuration: IPropertySet

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

Windows requirements

Device family	Windows 10 (introduced in 10.0.10586.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v2.0)

Remarks

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

Applies to