Yaml

Format

KeySwitches:
- Id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  Author: Author
  Description: Description
  Created: 2021-06-22T15:55:59.8150000Z
  LastUpdated: 2021-06-22T15:55:59.8540000Z
  DeveloperName: Developer Name
  ProductName: Product name
  InstrumentName: Instrument name
  Articulations:
  - Name: name
    MidiMessage:
      NoteOn:
      - Channel: 0
        Note: C-2
        Velocity: 100
      ControlChange:
      - Channel: 0
        ControlNumber: 1
        Data: 100
      ProgramChange:
      - Channel: 0
        ProgramNumber: 23
    ExtraData:
      extra1 key: extra1 value
      extra2 key: extra2 value
  ExtraData:
    extra1 key: extra1 value
    extra2 key: extra2 value

KeySwitches 

Keyswitch Definition List

Type:: list
Required:: yes

Id 

A unique ID by which the database identifies the keyswitch.

Type:: GUID
Required:: no

Usually not edited because the program outputs it. (new, export, search)

Example

Id: d1efb793-600d-4f40-85dc-2253e1b05aa6

Author 

Keyswitch author information

Type:: string
Required:: no

Example

Author: R-koubou

Description 

Keyswitch Description

Type:: string
Required:: no

Example

Description: My KeySwitch definition

Created 

Creation date (UTC)

Usually not edited because the program outputs it. (export, search)

Type:: DateTime
Required:: yes

Example

Created: 2021-06-22T12:00:00.0000000Z

Created: 2021-06-22T12:00:00Z

LastUpdated 

Update date (UTC)

Usually not edited because the program outputs it. (export, search)

Type:: DateTime
Required:: no

Example

LastUpdated: 2021-06-22T12:00:00.0000000Z

LastUpdated: 2021-06-22T12:00:00Z

DeveloperName 

Developer’s Information

Type:: string
Required:: yes

Example

DeveloperName: Fujiya Instruments

ProductName 

Product Name Information

Type:: string
Required:: yes

Example

ProductName: Vintage Humbucker Guitar

InstrumentName 

Instrument name information

Type:: string
Required:: yes

Example

InstrumentName: VHG Mono

Articulations 

Definition of articulation

Type:: list
Required:: yes
Allow Empty:: yes

Name 

articulation name

Type:: string
Required:: yes

Example

Articulations:
- Name: PowerChord

MidiMessage 

Specifying a MIDI message

NoteOn 

MIDI Note On

Type:: list
Required:: no

Example

Articulations:
- Name: PowerChord
  MidiMessage:
    NoteOn:
      - Channel: 0
        Note: C-2
        Velocity: 100

# Multiple notes supported
Articulations:
- Name: PowerChord
  MidiMessage:
    NoteOn:
      - Channel: 0
        Note: C-2
        Velocity: 100
      - Channel: 0
        Note: E-2
        Velocity: 100

Channel 

MIDI Channel

Note

0 to 15

Type:: int
Required:: yes

Example

Channel: 0

Note 

Type:: int or string
Required:: yes

Note

MIDI note numbers or scale names can be used.

Number:: 0 to 127
Note name:: C-2〜G8 (Yamaha form)

Note: C-2

Velocity 

velocity

Note

0 to 127

Type:: int
Required:: yes

Example

Velocity: 100

ControlChange 

MIDI Control change

Type:: list
Required:: no

Example

Articulations:
- Name: PowerChord
  MidiMessage:
    ControlChange:
      - Channel: 0
        ControlNumber: 0
        Data: 100

# Multiple CC supported
Articulations:
- Name: PowerChord
  MidiMessage:
    ControlChange:
      - Channel: 0
        ControlNumber: 0
        Data: 100
      - Channel: 0
        ControlNumber: 1
        Data: 110

Channel 

MIDI Channel

Note

0 to 15

Type:: int
Required:: yes

Example

Channel: 0

ControlNumber 

MIDI Control change number

Type:: int
Required:: yes

Note

0 to 127

ControlNumber: 0

Data 

MIDI Control change data value

Type:: int
Required:: yes

Note

0 to 127

Data: 0

ProgramChange 

MIDI program change

Type:: list
Required:: no

Example

Articulations:
- Name: PowerChord
  MidiMessage:
    ProgramChange:
      - Channel: 0
        ProgramNumber: 0

# Multiple PC supported
Articulations:
- Name: PowerChord
  MidiMessage:
    ProgramChange:
      - Channel: 0
        ProgramNumber: 0
      - Channel: 1
        ProgramNumber: 1

Channel 

MIDI Channel

Note

0 to 15

Type:: int
Required:: yes

Example

Channel: 0

ProgramNumber 

MIDI Program Number

Type:: int
Required:: yes

Note

0 to 127

Example

ProgramNumber: 0

ExtraData 

Reserved

Required:: no

see: ExtraData format

Example

Articulations:
- Name: PowerChord
  ExtraData:
    Key: Value

ExtraData 

Reserved

Required:: no

see: ExtraData format

Example

KeySwitches:
- Id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  :
  :
  ExtraData:
    Key: Value

ExtraData format 

Type:: dictionary<string, string>
Allow Empty:: yes

ExtraData:
    key: value

# Empty
ExtraData:[]