AudioRenderEffectsManager AudioRenderEffectsManager AudioRenderEffectsManager AudioRenderEffectsManager Class

Definition

Represent an audio render effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode.

public : sealed class AudioRenderEffectsManager : IAudioRenderEffectsManager, IAudioRenderEffectsManager2
public sealed class AudioRenderEffectsManager : IAudioRenderEffectsManager, IAudioRenderEffectsManager2
Public NotInheritable Class AudioRenderEffectsManager Implements IAudioRenderEffectsManager, IAudioRenderEffectsManager2
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

To create an instance of AudioRenderEffectsManager, call AudioEffectsManager.CreateAudioRenderEffectsManager.

See the Audio effects discovery sample for an example of how to query and monitor audio effects on render and capture audio devices.

Properties

EffectsProviderSettingsLabel EffectsProviderSettingsLabel EffectsProviderSettingsLabel EffectsProviderSettingsLabel

Gets the label that is associated with this audio effects provider setting.

public : Platform::String EffectsProviderSettingsLabel { get; }
public string EffectsProviderSettingsLabel { get; }
Public ReadOnly Property EffectsProviderSettingsLabel As string
var string = audioRenderEffectsManager.effectsProviderSettingsLabel;
Value
Platform::String string string string

The string to use as the label for the audio effects provider setting.

EffectsProviderThumbnail EffectsProviderThumbnail EffectsProviderThumbnail EffectsProviderThumbnail

Gets the thumbnail image that is associated with this audio effects provider.

public : IRandomAccessStreamWithContentType EffectsProviderThumbnail { get; }
public IRandomAccessStreamWithContentType EffectsProviderThumbnail { get; }
Public ReadOnly Property EffectsProviderThumbnail As IRandomAccessStreamWithContentType
var iRandomAccessStreamWithContentType = audioRenderEffectsManager.effectsProviderThumbnail;

Methods

GetAudioRenderEffects() GetAudioRenderEffects() GetAudioRenderEffects() GetAudioRenderEffects()

Gets the list of audio effects on the device.

public : IVectorView<AudioEffect> GetAudioRenderEffects()
public IReadOnlyList<AudioEffect> GetAudioRenderEffects()
Public Function GetAudioRenderEffects() As IReadOnlyList<AudioEffect>( Of AudioEffect )
var iVectorView = audioRenderEffectsManager.getAudioRenderEffects();
Returns
IVectorView<AudioEffect> IReadOnlyList<AudioEffect> IReadOnlyList<AudioEffect> IReadOnlyList<AudioEffect>

The list of audio effects.

ShowSettingsUI() ShowSettingsUI() ShowSettingsUI() ShowSettingsUI()

Displays the audio effect settings page.

public : void ShowSettingsUI()
public void ShowSettingsUI()
Public Function ShowSettingsUI() As void
audioRenderEffectsManager.showSettingsUI();

Events

AudioRenderEffectsChanged AudioRenderEffectsChanged AudioRenderEffectsChanged AudioRenderEffectsChanged

Occurs when audio process chain changes.

public : event TypedEventHandler AudioRenderEffectsChanged<AudioRenderEffectsManager, object>
public event TypedEventHandler AudioRenderEffectsChanged<AudioRenderEffectsManager, object>
Public Event TypedEventHandler AudioRenderEffectsChanged( Of ( Of AudioRenderEffectsManager ), ( Of object ))
function onAudioRenderEffectsChanged(eventArgs){/* Your code */}


audioRenderEffectsManager.addEventListener("audioRenderEffectsChanged", onAudioRenderEffectsChanged);
audioRenderEffectsManager.removeEventListener("audioRenderEffectsChanged", onAudioRenderEffectsChanged);

See Also