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

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

effectOptional: Boolean

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

Product	Versions
WinRT	Build 10586, Build 14383, Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100

Share via