AudioDeviceModulesManager AudioDeviceModulesManager AudioDeviceModulesManager AudioDeviceModulesManager AudioDeviceModulesManager Class

Definition

Manages the collections of audio device modules for a audio device pin instance or for a particular audio endpoint.

public : sealed class AudioDeviceModulesManager : IAudioDeviceModulesManager
struct winrt::Windows::Media::Devices::AudioDeviceModulesManager : IAudioDeviceModulesManager
public sealed class AudioDeviceModulesManager : IAudioDeviceModulesManager
Public NotInheritable Class AudioDeviceModulesManager Implements IAudioDeviceModulesManager
var audioDeviceModulesManager = new audioDeviceModulesManager(deviceId);
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)
Capabilities
audioDeviceConfiguration

Constructors

AudioDeviceModulesManager(String) AudioDeviceModulesManager(String) AudioDeviceModulesManager(String) AudioDeviceModulesManager(String) AudioDeviceModulesManager(String)

Gets an instance of the AudioDeviceModulesManager class for the specified audio device ID.

public : AudioDeviceModulesManager(Platform::String deviceId)
AudioDeviceModulesManager(winrt::hstring deviceId) const;
public AudioDeviceModulesManager(String deviceId)
Public Sub New(deviceId As String)
var audioDeviceModulesManager = new audioDeviceModulesManager(deviceId);
Parameters
deviceId
String String String

The identifier of the audio device for which the AudioDeviceModulesManager is retrieved.

Methods

FindAll() FindAll() FindAll() FindAll() FindAll()

Retreives a list of all audio device modules associated with the audio device for which the AudioDeviceModulesManager was initialized.

public : IVectorView<AudioDeviceModule> FindAll()
IVectorView<AudioDeviceModule> FindAll() const;
public IReadOnlyList<AudioDeviceModule> FindAll()
Public Function FindAll() As IReadOnlyList<AudioDeviceModule>( Of AudioDeviceModule )
var iVectorView = audioDeviceModulesManager.findAll();
Returns
IReadOnlyList<AudioDeviceModule> IReadOnlyList<AudioDeviceModule> IReadOnlyList<AudioDeviceModule>

A list of all audio device modules.

FindAllById(String) FindAllById(String) FindAllById(String) FindAllById(String) FindAllById(String)

Retrieves a list of all audio device modules with the specified ID. Each audio device module in the list will have the same ID, but each will have a different value for the AudioDeviceModule.InstanceId property.

public : IVectorView<AudioDeviceModule> FindAllById(Platform::String moduleId)
IVectorView<AudioDeviceModule> FindAllById(winrt::hstring moduleId) const;
public IReadOnlyList<AudioDeviceModule> FindAllById(String moduleId)
Public Function FindAllById(moduleId As String) As IReadOnlyList<AudioDeviceModule>( Of AudioDeviceModule )
var iVectorView = audioDeviceModulesManager.findAllById(moduleId);
Parameters
moduleId
String String String

The identifier of the audio device modules to be retrieved.

Returns
IReadOnlyList<AudioDeviceModule> IReadOnlyList<AudioDeviceModule> IReadOnlyList<AudioDeviceModule>

A list of all audio device modules with the specified ID.

Events

ModuleNotificationReceived ModuleNotificationReceived ModuleNotificationReceived ModuleNotificationReceived ModuleNotificationReceived

Occurs when a change occurs in one of the audio device modules associated with the audio device for which the AudioDeviceModulesManager was initialized.

public : event TypedEventHandler ModuleNotificationReceived<AudioDeviceModulesManager, AudioDeviceModuleNotificationEventArgs>
// Register
event_token ModuleNotificationReceived(TypedEventHandler<AudioDeviceModulesManager, AudioDeviceModuleNotificationEventArgs> const& handler) const;

// Revoke with event_token
void ModuleNotificationReceived(event_token const& cookie) const;

// Revoke with event_revoker
ModuleNotificationReceived_revoker ModuleNotificationReceived(auto_revoker_t, TypedEventHandler<AudioDeviceModulesManager, AudioDeviceModuleNotificationEventArgs> const& handler) const;
public event TypedEventHandler ModuleNotificationReceived<AudioDeviceModulesManager, AudioDeviceModuleNotificationEventArgs>
Public Event TypedEventHandler ModuleNotificationReceived( Of ( Of AudioDeviceModulesManager ), ( Of AudioDeviceModuleNotificationEventArgs ))
function onModuleNotificationReceived(eventArgs){/* Your code */}


audioDeviceModulesManager.addEventListener("moduleNotificationReceived", onModuleNotificationReceived);
audioDeviceModulesManager.removeEventListener("moduleNotificationReceived", onModuleNotificationReceived);