| Namespace | Windows.Devices.Midi2.Transports.Rtp |
|---|---|
| Type Name | MidiRtpConfiguredHost |
| Type | WinRT Runtime Class |
| IDL | MidiRtpConfiguredHost.idl |
Returned by MidiRtpTransportManager.GetConfiguredHosts().
| Property | Description |
|---|---|
HostId |
The GUID that identifies this host entry |
Name |
What remote devices show for this PC. When the host was created with an empty name, this is this PC’s name |
ServiceInstanceName |
The name the host is set up to advertise. When it was created without one, this is Name |
ActualServiceInstanceName |
The name really in use on the network. When another device already advertises a name, Windows gives this host a different one instead of refusing it, so this isn’t always the name that was set up. Empty when the host isn’t advertised |
ServiceInstanceNameWasChanged |
True when that happened. The host works, but other devices see a different name than the one set up, so it’s worth showing people |
IsEnabled |
False while the host is stopped with StopRtpHostAsync |
HasStarted |
True when the host is running and can take connections |
Advertise |
True if the host is advertised on the local network |
ConfiguredPort |
The port the host was set up to use, or auto. Compare it with ActualPort to see whether the host got the port that was asked for |
ActualPort |
The UDP port the host is using. RTP-MIDI also uses the port after it. Zero until the host has started |
AllowPortFallback |
True when the host was allowed to start on another port if the one it was set up with was in use |
UsedPortFallback |
True when the host couldn’t have the port it wanted, so it started on another one. For a host set to auto, that means port 5004 was already in use, often by other RTP-MIDI software on the same PC. The host works, but not on the port that was asked for, so it’s worth showing people |
SendRecoveryJournal |
True if the host sends a recovery journal with each packet |
SendSpeedLimit |
How fast the host is set up to send to each connected device. See MidiRtpSendSpeedLimit |
CurrentSendSpeedLimit |
How fast the running host is sending. It’s only different from SendSpeedLimit for a moment after a change |
SkipInBetweenValuesToCatchUp |
True when a connection skips some in-between values to catch up when messages pile up behind SendSpeedLimit. Added in version 2 of MidiTransportsRtpApiContract |
NetworkAdapterId |
The network adapter the host is limited to, or an empty GUID for every adapter |
NetworkAdapterName |
That adapter’s name, from when it was chosen |
AllowNetworkAdapterFallback |
True when the host runs on every adapter while its own adapter is missing |
IsNetworkAdapterMissing |
True when the host’s adapter is missing. If HasStarted is also true, the host is running on every adapter until the adapter is back. If not, the host is waiting, and starts by itself when the adapter is back |
UsedNetworkAdapterFallback |
True when the host is running on every adapter because its own adapter is missing |
RemoteClientPolicy |
What the host does when a remote device it hasn’t been told about asks to connect. See MidiRtpRemoteClientPolicy |
KnownRemoteClients |
The remote devices this host has been told to allow or deny for good, as MidiRtpKnownRemoteClient entries |
RemoteClientSettings |
The remote devices this host sends to at a speed of their own instead of the host’s, as MidiRtpRemoteClientSettings entries. This is the list the running service holds, whether or not the devices are connected |
LastErrorCode |
The HRESULT from the last try to start or advertise the host, or 0 |
Connections |
The remote devices connected to this host right now, as MidiRtpConnection entries |
KnownRemoteClients has every decision the service holds for this host that isn’t limited to a single request, including ones made with ApproveOrDenyRemoteClientConnectRequestAsync since the service started. The service doesn’t save them. To keep them after a restart, put this list in a MidiRtpHostKnownClientsConfig, change it if you need to, and save it.
To change a remote device’s own speed, start from RemoteClientSettings, change it, and send a MidiRtpHostRemoteClientSettingsConfig holding the whole list.
A remote device waiting for approval isn’t connected, so it isn’t in Connections. Use GetPendingRemoteClients() to find those.
This is a copy taken when you called GetConfiguredHosts(), not an object that updates itself. Call it again to refresh.
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.
