SpatialAudioDeviceConfiguration Class

Definition

Namespace:

Windows.Media.Audio

Represents a audio device, providing information and control for its current spatial audio setup.

public ref class SpatialAudioDeviceConfiguration sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SpatialAudioDeviceConfiguration final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SpatialAudioDeviceConfiguration

Public NotInheritable Class SpatialAudioDeviceConfiguration

Inheritance

Object Platform::Object IInspectable SpatialAudioDeviceConfiguration

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v7.0)

Properties

ActiveSpatialAudioFormat	Provides the currently active spatial audio format for this device. This could have been changed by the system and therefore may not be the same as the default.
DefaultSpatialAudioFormat	Provides the default spatial audio format for this device. This is the format the user has selected.
DeviceId	The ID of the device this object represents.
IsSpatialAudioSupported	Specifies whether this device can support any form of spatial audio.

Methods

GetForDeviceId(String)	Creates a SpatialAudioDeviceConfiguration for the given device ID.
IsSpatialAudioFormatSupported(String)	Specifies whether this device can support the given spatial audio format.
SetDefaultSpatialAudioFormatAsync(String)	Tries to set the specified spatial audio format for this device. The caller must be the app that owns this spatial audio format.

Events

ConfigurationChanged

Occurs when the spatial audio state of the device has changed.