This class is the legacy equivalent of MidiEndpointDeviceWatcher, but for MIDI 1.0 ports created by Windows MIDI Services.
Static Methods
| Static Method |
Description |
Create() |
Create a watcher for all MIDI 1.0 ports |
CreateForFlow(flow) |
Create a watcher for MIDI 1.0 ports in the specified Midi1PortFlow direction |
Methods
| Method |
Description |
Start() |
Begin enumeration. Wire up event handlers before calling this. |
Stop() |
Stop enumeration. |
GetEnumeratedPortsForFlow(flow) |
The enumerated ports in one direction. |
GetEnumeratedPortForNumber(portNumber, flow) |
The enumerated port with a given WinMM port number and direction, or null. |
GetEnumeratedPortsForParent(parentDeviceInstanceId) |
The enumerated ports belonging to one parent device. An overload also takes a flow. |
GetEnumeratedPortsForAssociatedEndpoint(endpointDeviceId) |
The enumerated ports belonging to one UMP endpoint. An overload also takes a flow. |
GetEnumeratedPortsForAssociatedEndpointAndGroup(endpointDeviceId, group) |
The enumerated ports for one group of one UMP endpoint. An overload also takes a flow. |
GetEnumeratedPortsForName(portName) |
The enumerated ports with a given name. Names are not unique, so this returns a collection. An overload also takes a flow. |
GetEnumeratedPortsForDriverDeviceInterfaceId(driverDeviceInterfaceId) |
The enumerated ports behind one driver device interface. An overload also takes a flow. |
These all work against the ports already enumerated and are a snapshot in time. None of them re-queries the system, so a port which has appeared since the last event will not be in the result.
Properties
| Property |
Description |
Status |
The current DeviceWatcherStatus |
EnumeratedPorts |
Map of all currently enumerated MIDI 1.0 ports, keyed by port device id |
CountSourcePorts |
How many source, or input, ports are currently enumerated |
CountDestinationPorts |
How many destination, or output, ports are currently enumerated |
Events
Watcher events are raised synchronously from the underlying Device Watcher, and so follow the same rules and guidance as the WinRT Windows.Devices.Enumeration.DeviceWatcher type. In addition, we recommend the following:
- Do not perform any long-running work inside an event handler.
- Do not create or destroy any virtual devices, loopbacks, or network connections from within a handler, and do not update properties in any way which would cause additional PnP events to be raised.
- When in doubt, hand the data off to a worker thread and return from the handler quickly.
| Event |
Description |
Added(source, args) |
A new MIDI 1.0 port has been added |
Removed(source, args) |
A MIDI 1.0 port has been removed |
Updated(source, args) |
A MIDI 1.0 port has been updated |
EnumerationCompleted(source) |
Initial enumeration has completed |
Stopped(source) |
The watcher has been stopped |
