Jazz-Soft.net

We make it sound!

MIDI-In

Opening MIDI-In port

engine.openMidiIn(arg) - try to open MIDI-In port.

• If arg is an integer, tries to open the port from the list of available ports by this index.
• If arg is a string, tries to open the port by name.
• If arg is an array with integer or strings, returns the first port successfully opened by the above rules.
• If arg is a function, returning integer, string, or an array, uses the function output as described above.
• If arg is a RegExp, returns the first successfully opened port with the matching name.
• If arg is empty, returns the first successfully opened port from the whole list.

Example

port = JZZ().openMidiIn(0);
port = JZZ().openMidiIn('Roland RD');
port = JZZ().openMidiIn(function(){ return [2, 1, 0]; });
port = JZZ().openMidiIn(/Yamaha/);
port = JZZ().openMidiIn();

info()

port.info() - get an info object with the following keys:

• name : name
• manufacturer : manufacturer
• version : version
• engine : implementation
• sysex : sysex support

name()

port.name() - a shortcut for the port.info().name.

connect()

port.connect(out) - add MIDI event handler or connect to MIDI-Out port.

out is either a MIDI-Out port object, or a function that will execute in the context of the current MIDI-In port object and receive a JZZ.MIDI object as an argument.

Both MIDI-In and MIDI-Out ports can have multiple connections.

disconnect()

port.disconnect(out) - remove MIDI event handler or disconnect MIDI-Out port.

out - a handler function to remove or a MIDI-Out port to disconnect.

If called without arguments, removes all handlers and disconnects all MIDI-Out ports. This is the only way to remuve anonymous handlers.

close()

port.close() - close the port.

No other calls except the common calls can be chained to the closed port.

This call is optional in HTML, but in Node.js all open MIDI-In ports must be closed before the application can exit.

Example

JZZ().or('Cannot start MIDI engine!')
     .openMidiIn().or('MIDI-In: Cannot open!')
     .and(function(){ console.log('MIDI-In:', this.name()); })
     .connect(JZZ().openMidiOut())                            // redirect to the default MIDI-Out port
     .connect(function(msg){ console.log(msg.toString()); })  // and log to the console
     .wait(10000).close().and('Thank you!');

Other calls

port.or(), port.and(), port.wait()

See also

• JZZ.MIDI
• MIDI-Out
• MIDI-Thru
• Reference
• Examples