| Namespace | Windows.Devices.Midi2 |
|---|---|
| Type Name | MidiSession |
| Type | WinRT Runtime Class |
| Implements | IClosable IStringable |
| IDL | MidiSession.idl |
| Library |
Before you can connect to an endpoint, you must start a new MIDI session.
An application may have any number of sessions open. For example, the application may open one session per open project, or one session per tab in the case of a browser. The lifetime of endpoint connections opened through a session are controlled through the session.
| Property | Description |
|---|---|
SessionId |
Generated Id for the session |
Name |
Name for this session. To change the name after creating the session, use the UpdateName() function. This will update the service |
IsOpen |
True if this session is open and ready to use |
Connections |
Map of all endpoint connections created through this session. Disconnecting an endpoint using DisconnectEndpointConnection will remove the connection from this map. The map key is the generated connection GUID that identifies an instance of an endpoint connection |
The two static functions are factory-pattern methods for creating a new session.
Create(sessionName) |
Create and return a new session with the specified name |
| Method | Description |
|---|---|
CreateEndpointConnection(endpointDeviceId) |
Create a new connection to the specified endpoint device Id |
CreateEndpointConnection(endpointDeviceId, settings) |
Create a new connection to the specified endpoint device Id, with the provided MidiEndpointConnectionSettings |
DisconnectEndpointConnection(endpointConnectionId) |
Cleanly disconnect an endpoint connection and remove it from the connection map |
UpdateName(newName) |
Update the name of this session locally and in the MIDI Service |
Note
If you manually close a MidiEndpointConnection using
IClosable(orIDisposable), it will not be removed from the MidiSession’s collection of endpoints. Instead, use theDisconnectEndpointConnectionmethod of the session to keep both in sync. For that reason, we do not recommend that you wrap theCreateEndpointConnectioncalls in a using statement.
C#
using (var session = MidiSession.CreateSession("API Sample Session"))
{
...
}
C++
// remember to initialize the WinRT apartment and also initialize the SDK
// runtime first. See samples for example code
auto session = MidiSession::CreateSession("API Sample Session");
...
session.Close();
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.
