| Namespace | Windows.Devices.Midi2.Transports.Network |
|---|---|
| Type Name | MidiNetworkClientEntryState |
| Type | WinRT Enumeration (a 32-bit unsigned or signed integer) |
| IDL | MidiNetworkClientEntryStateEnum.idl |
Reported by MidiNetworkConfiguredClient.EntryState.
| Value | Numeric Value | Description |
|---|---|---|
Pending |
0 |
Set up, and waiting for the service to connect it. An entry also comes back here when the host says it’s busy, and a direct connection waits here between tries |
Active |
1 |
The service has created the client. Use IsSessionActive to see whether MIDI is flowing |
Failed |
2 |
The configuration entry was rejected, or the remote host turned the connection down, so trying again can’t help |
Unavailable |
3 |
Not reported at present. A direct connection that stops answering goes back to Pending and is tried again |
MidiNetworkConfiguredClient.LastErrorCode says why an entry isn’t connected.
A discovered (mDNS) client goes back to Pending when it can’t connect, and it’s picked up again whenever the host advertises.
A direct connection, by host name or IP address, also goes back to Pending. Nothing announces that it’s back, so the service tries it again after DirectConnectionScanIntervalMilliseconds in MidiNetworkTransportSettings, and looks a host name up again each time. Call ConnectNetworkClientAsync again with the same ClientId to try right away.
Failed is also what you see when the remote host turns the connection down: its owner refused it, or it wants authentication, which isn’t built yet. Asking again won’t change either one, so the service doesn’t. Call ConnectNetworkClientAsync again with the same ClientId once something has changed.
A host that says it’s busy hasn’t turned the connection down. A Windows host also says this while it still holds this PC’s previous session, which it lets go after about 10 seconds without an answer. That happens when a connection drops, for example because either PC’s network address changed, and this PC reconnects first. So the entry goes back to Pending, and the service tries again after 10 to 30 seconds.
Windows MIDI Services is an open source project with all source available on GitHub. We have a great community on Discord as well. Between GitHub and Discord, you should find the information you are looking for.
