| Namespace | Windows.Devices.Midi2.Transports.Network |
|---|---|
| Type Name | MidiNetworkTransportManager |
| Type | WinRT Runtime Class |
| IDL | MidiNetworkTransportManager.idl |
The entry point for all Network MIDI 2.0 management. All members are static.
| Static Property | Description |
|---|---|
IsTransportAvailable |
Returns true if the Network MIDI 2.0 transport is available in the service. |
TransportId |
Returns the GUID of this transport. |
MidiNetworkUdpDnsServiceType |
The DNS-SD service type used by Network MIDI 2.0, for use with your own discovery code. |
MidiNetworkUdpDnsDomain |
The DNS-SD domain used for discovery. |
MidiNetworkUdpDnsSdQueryName |
The full DNS-SD query name, _midi2._udp.local, as passed to DnsServiceBrowse. |
| Static Method | Description |
|---|---|
CreateNetworkHostAsync(creationConfig) |
Create a host which remote clients can connect to. Returns a MidiNetworkHostCreationResponse. Does not complete until the host has started. |
RemoveNetworkHostAsync(removalConfig) |
Remove a host and disconnect anything connected to it. Returns a MidiNetworkHostRemovalResponse. |
StartNetworkHostAsync(hostId) |
Start a host which is configured but stopped. Returns a MidiNetworkHostUpdateResponse. |
StopNetworkHostAsync(hostId) |
Stop a running host without removing its configuration. Returns a MidiNetworkHostUpdateResponse. |
ConnectNetworkClientAsync(connectConfig) |
Connect to a remote host, by discovery or by direct address. Returns a MidiNetworkClientConnectResponse. For a ClientId which already exists, this retries an entry which was previously marked unavailable. |
DisconnectNetworkClientAsync(disconnectConfig) |
Disconnect a client connection. Returns a MidiNetworkClientDisconnectResponse. A client disconnected this way is not reconnected automatically. |
ApproveOrDenyRemoteClientConnectRequestAsync(approvalConfig) |
Approve or deny a remote client which is waiting on a host that requires approval. Returns a MidiNetworkRemoteClientApprovalResponse. |
DisconnectRemoteClientAsync(disconnectConfig) |
Ends one remote client’s active session with one of this PC’s hosts. Returns a MidiNetworkRemoteClientDisconnectResponse. This does not record an allow/deny decision for future reconnects. |
GetConfiguredHosts() |
Returns a collection of MidiNetworkConfiguredHost for every host configured in this service instance. |
GetConfiguredClients() |
Returns a collection of MidiNetworkConfiguredClient for every configured client, connected or not. |
GetPendingRemoteClients() |
Returns a collection of MidiNetworkPendingRemoteClient waiting for a user decision. Poll this to drive an approval UI. |
GetAdvertisedHosts() |
Returns a one-shot snapshot of MidiNetworkAdvertisedHost currently visible on the network. For ongoing updates use MidiNetworkAdvertisedHostWatcher. |
GetTransportSettings() |
Returns a MidiNetworkTransportSettings holding the settings the transport is running with right now. These are not necessarily what the configuration file says, because a value out of range or of the wrong type is corrected when it is read. |
GenerateAvailableHostPort() |
Returns a free UDP port for a host to keep, or zero if nothing suitable was found. Deliberately below the Windows dynamic range, so the operating system will not hand it to another process while the service is not running. |
IsHostPortAvailable(port) |
Returns true if the port can be used for a host. Intended for validating a port a user typed in, before trying to create the host with it. |
All the Async methods are genuinely asynchronous and marked noexcept in the ABI. They report failure through the Success and ErrorCode properties on the returned response object rather than by throwing.
GetConfiguredClients() is driven by configuration rather than by live connections, so an entry which has never connected, or which is currently unreachable, still appears in the results with its EntryState set accordingly.
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.
