Interface IMidiOut

IMidiOut defines an interface for any MIDI object which other shimi objects can send data to, for that data to be converted to valid MIDI messages and sent out.

Hierarchy

  • IMidiOut

Implemented by

Accessors

notes

Methods

addNote sendMessage sendRawData stopNotes

Accessors

notes

  • get notes(): Note[]

  • This defines the collection of note objects which are in the process of being sent by the MIDI out.

    Returns Note[]

Methods

addNote

  • The addNote method adds a new note to begin being sent by the MIDI out.

    Parameters

    Returns Note

sendMessage

  • The sendMessage method allows sending individual messages. This is not recommended to be used for note messages, though still supported. Its primary use is for control changes, bend messages, etc.

    Parameters

    Returns void

sendRawData

  • Parameters

    Returns void

stopNotes

  • The stopNotes method allows for stopping any number of notes currently being sent by the MIDI out.

    Parameters

    • Optional filter: ((note: Note) => boolean)

      The filter parameter is a function that runs against each note on the MIDI out. Notes for which the function returns true are stopped. If no filter provided, then all notes are stopped.

        • (note: Note): boolean

        • Parameters

          Returns boolean

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc