AudioDeviceModule AudioDeviceModule AudioDeviceModule AudioDeviceModule Class

Definition

Represents a single audio device module, which may be a hardware effect processing unit or any other audio configuration module defined by an audio driver.

public : sealed class AudioDeviceModule : IAudioDeviceModulepublic sealed class AudioDeviceModule : IAudioDeviceModulePublic NotInheritable Class AudioDeviceModule Implements IAudioDeviceModule// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

Get an instance of this class by calling AudioDeviceModulesManager.FindAll or AudioDeviceModulesManager.FindAllById.

Properties

ClassId ClassId ClassId ClassId

Gets the GUID identifier of the module, which is defined by the audio device module owner.

public : PlatForm::String ClassId { get; }public string ClassId { get; }Public ReadOnly Property ClassId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The GUID identifier of the module

DisplayName DisplayName DisplayName DisplayName

Gets the friendly name of the audio device module for display in UI.

public : PlatForm::String DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The friendly name of the audio device module.

InstanceId InstanceId InstanceId InstanceId

Gets an identifier, defined by the driver developer, that disambiguates between multiple instances of the same module class in the driver topology.

public : unsigned int InstanceId { get; }public uint InstanceId { get; }Public ReadOnly Property InstanceId As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

An identifier that disambiguates between multiple instances of the same module class in the driver topology.

MajorVersion MajorVersion MajorVersion MajorVersion

Gets the major version of the audio device module.

public : unsigned int MajorVersion { get; }public uint MajorVersion { get; }Public ReadOnly Property MajorVersion As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The major version of the audio device module.

MinorVersion MinorVersion MinorVersion MinorVersion

Gets the minor version of the audio device module.

public : unsigned int MinorVersion { get; }public uint MinorVersion { get; }Public ReadOnly Property MinorVersion As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The minor version of the audio device module.

Methods

SendCommandAsync(IBuffer) SendCommandAsync(IBuffer) SendCommandAsync(IBuffer) SendCommandAsync(IBuffer)

Asynchronously sends data to the audio device module and receives the result.

public : IAsyncOperation<ModuleCommandResult> SendCommandAsync(IBuffer Command)public IAsyncOperation<ModuleCommandResult> SendCommandAsync(IBuffer Command)Public Function SendCommandAsync(Command As IBuffer) As IAsyncOperation( Of ModuleCommandResult )// You can use this method in JavaScript.
Parameters
Command
IBuffer IBuffer IBuffer IBuffer

A buffer containing the command data to send to the audio device module.

Returns