audio.modules.midi
Class MIDIInterface

java.lang.Object
  audio.modules.midi.MIDIInterface

All Implemented Interfaces:

AudioInput, MIDIInput, java.io.Serializable, VDMModule

public class MIDIInterface
extends java.lang.Object
implements AudioInput, VDMModule, MIDIInput

Represents a given MIDI interface on the audio host computer.

See Also:

Serialized Form

Constructor Summary

MIDIInterface(javax.sound.midi.MidiDevice midiInterface, AudioInterfaceDriver audioInterfaceDriver, Logger logger)

Method Summary

void	close() Shuts the interface down and frees any resources associated with it.
java.lang.String	getDescription() Returns a description of the interface.
java.lang.String	getFriendlyName() Returns a user defined interface name or null if the user has not changed it.
java.lang.String	getName() Returns the name of the module.
java.lang.String	getPathToIcon() Returns the path an image suitable for use as an icon.
java.lang.String	getType() Returns the type of the interface - useful for writing specific display algorithms for specific instrument types
java.lang.String	getVendor() Returns the interface vendor,
java.lang.String	getVersion() Returns the version of the module.
boolean	isOpen() Should return whether the interface is in a state where it can start transmitting data.
void	open() Turns on the interface - it should then be in a state where it can start transmitting data.
void	receiveMessage(javax.sound.midi.ShortMessage message) This is called by the midi receiver and is used to process MIDI events for sending as OSC messages.
void	sendMessage() Send locally stored messages when called.
void	setFriendlyName(java.lang.String newName) Used when the user changes the name of the interface in the audio processor GUI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MIDIInterface

public MIDIInterface(javax.sound.midi.MidiDevice midiInterface,
                     AudioInterfaceDriver audioInterfaceDriver,
                     Logger logger)

Parameters:

midiInterface -

audioInterfaceDriver -

logger -

Method Detail

open

public void open()

Description copied from interface: AudioInput

Turns on the interface - it should then be in a state where it can start transmitting data.

Specified by:

open in interface AudioInput

isOpen

public boolean isOpen()

Description copied from interface: AudioInput

Should return whether the interface is in a state where it can start transmitting data.

Specified by:

isOpen in interface AudioInput

Returns:

True if it is accepting data, false otherwise.

close

public void close()

Description copied from interface: AudioInput

Shuts the interface down and frees any resources associated with it.

Specified by:

close in interface AudioInput

getDescription

public java.lang.String getDescription()

Description copied from interface: AudioInput

Returns a description of the interface.

Specified by:

getDescription in interface AudioInput

Returns:

"On hardware USB bus" or something

getName

public java.lang.String getName()

Description copied from interface: VDMModule

Returns the name of the module.

Specified by:

getName in interface VDMModule

Returns:

"MIDI input 1" or similar

getVendor

public java.lang.String getVendor()

Description copied from interface: AudioInput

Returns the interface vendor,

Specified by:

getVendor in interface AudioInput

Returns:

"ACME MIDI" or something like that

getVersion

public java.lang.String getVersion()

Description copied from interface: VDMModule

Returns the version of the module.

Specified by:

getVersion in interface VDMModule

Returns:

Some sort of versioning information.

getPathToIcon

public java.lang.String getPathToIcon()

Description copied from interface: AudioInput

Returns the path an image suitable for use as an icon.

Specified by:

getPathToIcon in interface AudioInput

Returns:

The image path or null.

sendMessage

public void sendMessage()

Description copied from interface: AudioInput

Send locally stored messages when called.

Specified by:

sendMessage in interface AudioInput

receiveMessage

public void receiveMessage(javax.sound.midi.ShortMessage message)

This is called by the midi receiver and is used to process MIDI events for sending as OSC messages.

Specified by:

receiveMessage in interface MIDIInput

Parameters:

message - A MIDI message

setFriendlyName

public void setFriendlyName(java.lang.String newName)

Description copied from interface: AudioInput

Used when the user changes the name of the interface in the audio processor GUI.

Specified by:

setFriendlyName in interface AudioInput

getFriendlyName

public java.lang.String getFriendlyName()

Description copied from interface: AudioInput

Returns a user defined interface name or null if the user has not changed it.

Specified by:

getFriendlyName in interface AudioInput

Returns:

The user defined name or null.

getType

public java.lang.String getType()

Description copied from interface: AudioInput

Returns the type of the interface - useful for writing specific display algorithms for specific instrument types

Specified by:

getType in interface AudioInput

Returns:

"midi" or similar