Skip to content

Commit 3b9b6d5

Browse files
Merge pull request #340 from microsoft/pete-dev
Update KS section of docs
2 parents 6f14042 + b12f992 commit 3b9b6d5

File tree

3 files changed

+49
-20
lines changed

3 files changed

+49
-20
lines changed

docs/config-json.md docs/endpoints/config-json.md

+4-14
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
layout: page
3-
title: Config JSON
3+
title: Config JSON for Transports
4+
parent: Transport Types
5+
grandparent: Windows MIDI Services
46
---
57

68
# JSON Config File
@@ -105,16 +107,4 @@ Valid properties you can set across all supported endpoints
105107

106108
## Plugin-specific settings
107109

108-
This is not an exhaustive list, because the transport and processing plugins may be created by anyone.
109-
110-
### Loopback MIDI
111-
112-
TODO: Provide examples for this
113-
114-
For the persistent configuration file, typically "add" is all that is specified, as it doesn't make sense to update or remove endpoints or routing on service start.
115-
116-
> NOTE: This document is not yet complete. We'll add more details as the schemas are finalized
117-
118-
### KS (USB etc) MIDI
119-
120-
TODO: Show how to update endpoint names and provide other properties here
110+
Appropriate configuration information may be found in the individual transport pages.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: page
3+
title: Kernel Streaming Aggregate
4+
parent: Transport Types
5+
grandparent: Windows MIDI Services
6+
has_children: false
7+
---
8+
9+
# Kernel Streaming
10+
11+
| Property | Value |
12+
| -------- | ----- |
13+
| Abstraction Id | `TBA` |
14+
| Mnemonic | `KSA` |
15+
16+
## Overview
17+
18+
The Kernel Streaming Aggregator transport creates UMP endpoints for MIDI 1.0 devices using MIDI 1.0 byte format devices, like third-party MIDI 1.0 drivers.
19+
20+
## Suggested Uses
21+
22+
Although this transport is primarily recommended for USB devices, it may be used for access to most other existing MIDI 1.0 devices on Windows.
23+
24+
## Configuration
25+
26+
Endpoints for this transport are not created through the configuration file, but certain properties, such as the name and description, are updatable through it.
27+
28+
```json
29+
"endpointTransportPluginSettings":
30+
{
31+
"{26FA740D-469C-4D33-BEB1-3885DE7D6DF1}":
32+
{
33+
"_comment": "KSA MIDI (USB etc.)",
34+
"SWD: \\\\?\\SWD#MIDISRV#MIDIU_KSA_BIDI_6799286025327820155#{e7cce071-3c03-423f-88d3-f1045d02552b}":
35+
{
36+
37+
}
38+
}
39+
}
40+
```
41+
42+
## Implementation
43+

docs/endpoints/kernel-streaming.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,9 @@ has_children: false
1515

1616
## Overview
1717

18-
Kernel Streaming is the mechanism through which most USB and other MIDI 1.0 drivers are used in Windows MIDI Services. In addition to USB MIDI 1.0, this provides access to many third-party drivers including BLE MIDI 1.0 and more.
18+
Kernel Streaming is the mechanism through which MIDI 1.0 and MIDI 2.0 devices using the new UMP-based class driver are enumerated and communicated with.
1919

20-
In addition to MIDI 1.0 drivers, the Kernel Streaming transport is also the interface to the MIDI 2.0 class driver.
21-
22-
## Suggested Uses
23-
24-
Although this transport is primarily recommended for USB devices, it may be used for access to most other existing MIDI 1.0 devices on Windows.
20+
In addition, any third-party UMP drivers will also route through this service.
2521

2622
## Configuration
2723

0 commit comments

Comments
 (0)