Share via

AudioEffectsPackConfiguration Class

Definition

Namespace:
Windows.Media.Audio
Edit

Represents a single effects pack on a single audio endpoint.

public ref class AudioEffectsPackConfiguration sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 1048576)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AudioEffectsPackConfiguration final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 1048576)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AudioEffectsPackConfiguration
Public NotInheritable Class AudioEffectsPackConfiguration
Inheritance
Object Platform::Object IInspectable AudioEffectsPackConfiguration
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Requirements Description
Device family
Windows 11, version 24H2 (introduced in 10.0.26100.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v19.0)

Remarks

This class can be used by OEM Hardware Support Application (HSA) applications to query for their effects pack’s status on a given audio endpoint. Using this class, OEM's can only query for the status of their own effects packs, specified with an OEM-defined ID. The API does not allow for the setting of effects packs.

Get an instance of this class by calling AudioEffectsPackConfiguration.GetForEffectsPackOnDeviceId.

A given AudioEffectsPackConfiguration object represents a single effects pack on a single endpoint. Applications must create an AudioEffectsPackConfiguration instance for each effects pack, audio endpoint pair they want to query.

Properties

Name Description
DeviceId

Gets the audio endpoint ID of the audio effects pack associated with the AudioEffectsPackConfiguration object.
EffectsPackId

Gets the OEM-specified ID of the audio effects pack associated with the AudioEffectsPackConfiguration object.
Status

Gets a value from the AudioEffectsPackStatus enumeration specifying whether the associated audio effects pack is supported and whether it is currently enabled.

Methods

Name Description
GetForDeviceId(String, String)

Gets an instance of the AudioEffectsPackConfiguration class for the specified audio effects pack and audio endpoint.
IsDeviceIdSupported(String, String)

Gets a boolean value indicating if the supplied audio effects pack ID is applicable to audio endpoint with the specified device ID.

Events

Name Description
StatusChanged

Raised when the status of the audio effects pack associated with the AudioEffectsPackConfiguration object changes.

Applies to