SpatialAudioDeviceConfiguration SpatialAudioDeviceConfiguration SpatialAudioDeviceConfiguration SpatialAudioDeviceConfiguration SpatialAudioDeviceConfiguration Class

Definition

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

public : sealed class SpatialAudioDeviceConfiguration
struct winrt::Windows::Media::Audio::SpatialAudioDeviceConfiguration
public sealed class SpatialAudioDeviceConfiguration
Public NotInheritable Class SpatialAudioDeviceConfiguration
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10, version 1809 (introduced v10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v7)

Properties

ActiveSpatialAudioFormat ActiveSpatialAudioFormat ActiveSpatialAudioFormat ActiveSpatialAudioFormat 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 DefaultSpatialAudioFormat DefaultSpatialAudioFormat DefaultSpatialAudioFormat DefaultSpatialAudioFormat

Provides the default spatial audio format for this device. This is the format the user has selected.

DeviceId DeviceId DeviceId DeviceId DeviceId

The ID of the device this object represents.

IsSpatialAudioSupported IsSpatialAudioSupported IsSpatialAudioSupported IsSpatialAudioSupported IsSpatialAudioSupported

Specifies whether this device can support any form of spatial audio.

Methods

GetForDeviceId(String) GetForDeviceId(String) GetForDeviceId(String) GetForDeviceId(String) GetForDeviceId(String)

Creates a SpatialAudioDeviceConfiguration for the given device ID.

IsSpatialAudioFormatSupported(String) IsSpatialAudioFormatSupported(String) IsSpatialAudioFormatSupported(String) IsSpatialAudioFormatSupported(String) IsSpatialAudioFormatSupported(String)

Specifies whether this device can support the given spatial audio format.

SetDefaultSpatialAudioFormatAsync(String) SetDefaultSpatialAudioFormatAsync(String) SetDefaultSpatialAudioFormatAsync(String) SetDefaultSpatialAudioFormatAsync(String) 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 ConfigurationChanged ConfigurationChanged ConfigurationChanged ConfigurationChanged

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