mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-14 05:24:21 +00:00
add basic docs for MIDI modules
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: MIDI Input
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
import { Aside } from '@astrojs/starlight/components';
|
||||
|
||||
<Aside type="caution">
|
||||
This module is not currently included in the pre-compiled binaries for [showbridge](https://github.com/jwetzell/showbridge-go/releases/latest)
|
||||
</Aside>
|
||||
|
||||
The `midi.input` module connects to a midi device (or virtual device) and emits MIDI messages that come in on that port. This module does not output any message and so using it as an `output` of a [route](/concepts/routes) would be pointless.
|
||||
|
||||
- **type**: `midi.input`
|
||||
- **params**:
|
||||
- **port**: name of the MIDI port to connect to
|
||||
|
||||
### Example
|
||||
Open a MIDI connection to `Logic Pro Virtual Out`.
|
||||
```
|
||||
- id: midiInput
|
||||
type: midi.input
|
||||
params:
|
||||
port: "Logic Pro Virtual Out"
|
||||
```
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: MIDI Output
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
import { Aside } from '@astrojs/starlight/components';
|
||||
|
||||
<Aside type="caution">
|
||||
This module is not currently included in the pre-compiled binaries for [showbridge](https://github.com/jwetzell/showbridge-go/releases/latest)
|
||||
</Aside>
|
||||
|
||||
The `midi.output` module connects to a midi device (or virtual device) and allows sending MIDI messages out to that device. This module does not receive any message and so using it as an `input` to a [route](/concepts/routes) would be pointless.
|
||||
|
||||
- **type**: `midi.output`
|
||||
- **params**:
|
||||
- **port**: name of the MIDI port to connect to
|
||||
|
||||
### Example
|
||||
Open a MIDI connection to `Logic Pro Virtual In`.
|
||||
```
|
||||
- id: midiOutput
|
||||
type: midi.output
|
||||
params:
|
||||
port: "Logic Pro Virtual In"
|
||||
```
|
||||
Reference in New Issue
Block a user