de.humatic.nmj

Class NMJConfig

java.lang.Object

de.humatic.nmj.NMJConfig

public class NMJConfig
extends java.lang.Object

This is the main configuration interface for nmj network midi channels. Configurations are stored in java preferences (SharedPreferences on Android) and will be recalled on subsequent library loadings without requiring further interaction.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADB
static int	ADB_QUERY Global flag values
static int	BLUETOOTH
static int	BT_DISCOVERABLE Global flag values
static int	CH_CLOSED Event types
static int	CH_OPENED Event types
static int	CH_REMOVED Event types
static int	CONNECTIVITY_ADB
static int	CONNECTIVITY_BLUETOOTH
static int	CONNECTIVITY_LAN
static int	CONNECTIVITY_USB
static int	CONNECTIVITY_USB_HOST
static int	CONNECTIVITY_WIFI
static int	DEL Global flag values
static int	DEL_15 Global flag values
static int	DEL_30 Global flag values
static int	DLG_HIDDEN Dialog flags
static int	DNS Global flag values
static int	DNS_ANNOUNCE Global flag values
static int	DNS_QUERY Global flag values
static int	DSMI
static int	E_ADB Errors
static int	E_BIND Errors
static int	E_BLUETOOTH Errors
static int	E_DEVICE_OPEN Errors
static int	E_LINUX_64 Errors
static int	E_NETWORK Errors
static int	E_SECONDARY Errors
static int	E_USB Errors
static int	E_WIFI Errors
static int	IN
static int	IO
static int	LOOPBACK Global flag values
static int	OUT
static int	RAW
static int	RTPA
static int	RTPA_AUTOCONNECT Channel flag values
static int	RTPA_CH_CLIENT_CONNECT RTP states
static int	RTPA_CH_CONNECTED RTP states
static int	RTPA_CH_DISCONNECTED RTP states
static int	RTPA_CH_DISCOVERED RTP states
static int	RTPA_CH_GONE RTP states
static int	RTPA_CH_LOST RTP states
static int	RTPA_CH_PRESENT RTP states
static int	RTPA_CH_WAITING RTP states
static int	RTPA_EVENT Event types
static int	RTPA_NO_RESPONSE RTP states
static int	SHIFT_PORTS Global flag values
static int	USB Channel flag values
static int	USB_ATTACHMENT_LISTEN Global flag values

Constructor Summary

Constructors

Constructor and Description
NMJConfig()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addSystemListener(NMJSystemListener l) Adds a listener to be informed of state changes and errors in the system.
static void	breakBluetoothQuery()
static void	connectLocalSession(int ch, int remoteCh) Connects a remote session (which once discovered or added manually will have its own channel representation) to a "local session".
static void	deleteChannel(int ch)
static void	disconnectLocalSession(int ch, int idx) Disconnects a local session's remote client.
static java.lang.String	getBluetoothStackAdapter()
static java.lang.String	getClientIP(int ch, int id) Returns the ip address of a client that connected to a local session
static java.lang.String	getClientName(int ch, int id) Returns the Bonjour name of a client that connected to a local session
static int	getClientPort(int ch, int id) Returns the port number on a client machine that connected to a local session
static int	getConnectivity(java.lang.Object android_content_Context) Android only. This method does nothing in J2SE context and is only in the source to avoid the necessity for two separate javadoc editions.
static int	getFlags(int ch) Returns global (if ch == -1) or a specific channel's control flags.
static int	getIO(int ch) Returns 0 if the given channel is set as an input, 1 for output and -1 for bidirectional channels.
static java.lang.String	getIP(int ch) Returns a channel's remote IP address.
static int	getLocalPort(int ch) Returns a channel's local port (unicast and RTP mode only).
static int	getMode(int ch) Returns the channel's general operation mode (RAW, RTPA, ADB etc.).
static java.lang.String	getName(int ch)
static int	getNetworkAdapter(int ch) Returns the index of the channel's explicitely set or default network interface.
static int	getNumChannels() Returns the total number of channels that the SPI is configured to provide.
static int	getPort(int ch) Returns a channel's remote port.
static java.lang.String	getProperty(java.lang.String key, java.lang.String def)
static java.lang.String	getVersionInfo()
static short	getVersionNumber(int mm)
static void	removeBluetoothSystemListener(NMJBluetoothSystemListener btl)
static void	removeSystemListener(NMJSystemListener l)
static void	resetAll() Deletes all settings and reverts to the default state of two multicast channels plus one local RTP session
static void	runBluetoothQuery(NMJBluetoothSystemListener btl)
static void	setApplicationNode(java.lang.String fullyQualifiedPackageName) Redirects storage to an application specific preferences node.
static void	setBasePort(int mode, int p) Sets the portnumber that local ports for RTP channels will be based on (first channel will use p and p+1, channel n will use p+n*2 and p+n*2+1).
static void	setBluetoothStackAdapter(java.lang.String fullyQualifiedClassName) Sets the Bluetooth adapter implementation to use.
static void	setBluetoothSystemListener(NMJBluetoothSystemListener btl)
static void	setDebugLevel(int level)
static void	setFlags(int ch, int flags) Controls additional aspects, like autoconnection settings, service discovery etc.
static void	setIO(int ch, int io) Sets the given (multicast) channel to input (0) or output (1).
static void	setIP(int ch, java.lang.String ip) Sets the remote IP address for the given channel (null for a local RTP session).
static void	setLocalPort(int ch, int port) Sets the local port number for the given channel (unicast and RTP mode only).
static void	setLogFile(java.io.File logFile, boolean append)
static void	setMode(int ch, int mode) Sets a channel's operation mode.
static void	setName(int ch, java.lang.String userName)
static void	setNetworkAdapter(int ch, int index) Sets the network interface to bind sockets to by index into the enumeration returned from java.net.NetworkInterface.getNetworkInterfaces().
static void	setNumChannels(int nr) Sets the total number of channels that the SPI will provide.
static void	setNumChannels(int nr, boolean clear) Sets the total number of channels that the SPI will provide.
static void	setPort(int ch, int port) Sets the remote port number for the given channel.
static void	setProperty(java.lang.String key, java.lang.String value)
static javax.swing.JDialog	showConfigDialog(java.awt.Frame parent, java.lang.String dialogTitle) Deprecated. Deprecated method, use showConfigDialog(java.awt.Frame, String, int) instead.
static javax.swing.JDialog	showConfigDialog(java.awt.Frame parent, java.lang.String dialogTitle, int flags) Brings up nmj's control panel as a child of the given frame (whose icon it will take) and with the given title.

Methods inherited from class java.lang.Object

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

Field Detail

RAW

public static final int RAW

See Also:

Constant Field Values

RTPA

public static final int RTPA

See Also:

Constant Field Values

BLUETOOTH

public static final int BLUETOOTH

See Also:

Constant Field Values

DSMI

public static final int DSMI

See Also:

Constant Field Values

ADB

public static final int ADB

See Also:

Constant Field Values

IO

public static final int IO

See Also:

Constant Field Values

IN

public static final int IN

See Also:

Constant Field Values

OUT

public static final int OUT

See Also:

Constant Field Values

CH_REMOVED

public static final int CH_REMOVED

Event types

See Also:

Constant Field Values

CH_OPENED

public static final int CH_OPENED

Event types

See Also:

Constant Field Values

CH_CLOSED

public static final int CH_CLOSED

Event types

See Also:

Constant Field Values

RTPA_EVENT

public static final int RTPA_EVENT

Event types

See Also:

Constant Field Values

RTPA_NO_RESPONSE

public static final int RTPA_NO_RESPONSE

RTP states

See Also:

Constant Field Values

RTPA_CH_WAITING

public static final int RTPA_CH_WAITING

RTP states

See Also:

Constant Field Values

RTPA_CH_DISCOVERED

public static final int RTPA_CH_DISCOVERED

RTP states

See Also:

Constant Field Values

RTPA_CH_PRESENT

public static final int RTPA_CH_PRESENT

RTP states

See Also:

Constant Field Values

RTPA_CH_CONNECTED

public static final int RTPA_CH_CONNECTED

RTP states

See Also:

Constant Field Values

RTPA_CH_CLIENT_CONNECT

public static final int RTPA_CH_CLIENT_CONNECT

RTP states

See Also:

Constant Field Values

RTPA_CH_DISCONNECTED

public static final int RTPA_CH_DISCONNECTED

RTP states

See Also:

Constant Field Values

RTPA_CH_GONE

public static final int RTPA_CH_GONE

RTP states

See Also:

Constant Field Values

RTPA_CH_LOST

public static final int RTPA_CH_LOST

RTP states

See Also:

Constant Field Values

DNS_QUERY

public static final int DNS_QUERY

Global flag values

See Also:

Constant Field Values

DNS_ANNOUNCE

public static final int DNS_ANNOUNCE

Global flag values

See Also:

Constant Field Values

DNS

public static final int DNS

Global flag values

See Also:

Constant Field Values

BT_DISCOVERABLE

public static final int BT_DISCOVERABLE

Global flag values

See Also:

Constant Field Values

LOOPBACK

public static final int LOOPBACK

Global flag values

See Also:

Constant Field Values

ADB_QUERY

public static final int ADB_QUERY

Global flag values

See Also:

Constant Field Values

USB_ATTACHMENT_LISTEN

public static final int USB_ATTACHMENT_LISTEN

Global flag values

See Also:

Constant Field Values

DEL_15

public static final int DEL_15

Global flag values

See Also:

Constant Field Values

DEL_30

public static final int DEL_30

Global flag values

See Also:

Constant Field Values

DEL

public static final int DEL

Global flag values

See Also:

Constant Field Values

SHIFT_PORTS

public static final int SHIFT_PORTS

Global flag values

See Also:

Constant Field Values

RTPA_AUTOCONNECT

public static final int RTPA_AUTOCONNECT

Channel flag values

See Also:

Constant Field Values

USB

public static final int USB

Channel flag values

See Also:

Constant Field Values

E_DEVICE_OPEN

public static final int E_DEVICE_OPEN

Errors

See Also:

Constant Field Values

E_BIND

public static final int E_BIND

Errors

See Also:

Constant Field Values

E_NETWORK

public static final int E_NETWORK

Errors

See Also:

Constant Field Values

E_WIFI

public static final int E_WIFI

Errors

See Also:

Constant Field Values

E_BLUETOOTH

public static final int E_BLUETOOTH

Errors

See Also:

Constant Field Values

E_USB

public static final int E_USB

Errors

See Also:

Constant Field Values

E_SECONDARY

public static final int E_SECONDARY

Errors

See Also:

Constant Field Values

E_ADB

public static final int E_ADB

Errors

See Also:

Constant Field Values

E_LINUX_64

public static final int E_LINUX_64

Errors

See Also:

Constant Field Values

DLG_HIDDEN

public static final int DLG_HIDDEN

Dialog flags

See Also:

Constant Field Values

CONNECTIVITY_WIFI

public static final int CONNECTIVITY_WIFI

See Also:

Constant Field Values

CONNECTIVITY_USB

public static final int CONNECTIVITY_USB

See Also:

Constant Field Values

CONNECTIVITY_LAN

public static final int CONNECTIVITY_LAN

See Also:

Constant Field Values

CONNECTIVITY_BLUETOOTH

public static final int CONNECTIVITY_BLUETOOTH

See Also:

Constant Field Values

CONNECTIVITY_ADB

public static final int CONNECTIVITY_ADB

See Also:

Constant Field Values

CONNECTIVITY_USB_HOST

public static final int CONNECTIVITY_USB_HOST

See Also:

Constant Field Values

Constructor Detail

NMJConfig

public NMJConfig()

Method Detail

setApplicationNode

public static void setApplicationNode(java.lang.String fullyQualifiedPackageName)

Redirects storage to an application specific preferences node. Should be called early and on every run of an application as the value holding the path (not the values stored under that path) might be overwritten by other applications.
This method does nothing on Android, where application specific SharedPreferences are used anyway.

setNumChannels

public static void setNumChannels(int nr)

Sets the total number of channels that the SPI will provide. If the new number is smaller than the currently set number of channels, configuration data for those channels no longer needed is deleted.

setNumChannels

public static void setNumChannels(int nr,
                  boolean clear)

Sets the total number of channels that the SPI will provide. If the new number is smaller than the currently set number of channels, configuration data for those channels no longer needed is optionally deleted and channels newly created after this will be initialized with default settings.

getNumChannels

public static int getNumChannels()

Returns the total number of channels that the SPI is configured to provide.

setIP

public static void setIP(int ch,
         java.lang.String ip)

Sets the remote IP address for the given channel (null for a local RTP session).

getIP

public static java.lang.String getIP(int ch)

Returns a channel's remote IP address.

setPort

public static void setPort(int ch,
           int port)

Sets the remote port number for the given channel.

getPort

public static int getPort(int ch)

Returns a channel's remote port.

setLocalPort

public static void setLocalPort(int ch,
                int port)

Sets the local port number for the given channel (unicast and RTP mode only).

getLocalPort

public static int getLocalPort(int ch)

Returns a channel's local port (unicast and RTP mode only).

setBasePort

public static void setBasePort(int mode,
               int p)

Sets the portnumber that local ports for RTP channels will be based on (first channel will use p and p+1, channel n will use p+n*2 and p+n*2+1). Default is 6500 and there should be no need to change this unless you want to run two programs making use of nmj in parallel on one machine / device. In that case call this once in the very beginning.

setMode

public static void setMode(int ch,
           int mode)

Sets a channel's operation mode. Currently there are five modes defined:
RAW - this runs raw midi bytes over ethernet, can run both uni- and multicast and is compatible with ipMidi and Midi2Net.
RTPA - uses RTP for transport and Apple's proprietary Network MIDI protocol for session establishment and maintenance. When setting a channel to RTPA mode it will initially be configured as a session that the local machine makes available to others (getIP() will return null for it). Sessions from other machines will usually be created upon service discovery, but can also be configured manually by setting a channel to RTPA mode and specifying non null IP addresses and remote port numbers.
BLUETOOTH - runs MIDI over Bluetooth between the desktop and Android versions of nmj.
DSMI - sends MIDI via the DSMidiWifi server.
ADB - for communicating with nmj running on a USB connected Android device via the Android Debug Bridge (Requires the Android SDK tools to be available on the desktop machine and the Android device to have USB debugging enabled).
Android only:
USB_HOST - runs MIDI over class compliant Usb MIDI interfaces connected to Android tablets supporting Usb host mode (requires Android 3.1 or greater).

getMode

public static int getMode(int ch)

Returns the channel's general operation mode (RAW, RTPA, ADB etc.).

setNetworkAdapter

public static void setNetworkAdapter(int ch,
                     int index)

Sets the network interface to bind sockets to by index into the enumeration returned from java.net.NetworkInterface.getNetworkInterfaces(). This is usually not required as the library will attempt to figure out what the default adapter is, but on multi-homed systems it may be necessary or desired to specify the network adapter for multicast channels.

getNetworkAdapter

public static int getNetworkAdapter(int ch)

Returns the index of the channel's explicitely set or default network interface.

setIO

public static void setIO(int ch,
         int io)

Sets the given (multicast) channel to input (0) or output (1). Does nothing for unicast channels.

getIO

public static int getIO(int ch)

Returns 0 if the given channel is set as an input, 1 for output and -1 for bidirectional channels. javax.sound.midi.MidiDevice.getMaxTransmitters() and getMaxReceivers() will accordingly return -1 or 0.

setFlags

public static void setFlags(int ch,
            int flags)

Controls additional aspects, like autoconnection settings, service discovery etc. For global flags use -1 for the channel parameter. This method may also initialize or abort actions and should therefore be called with a value for %flags that is a combinaton of all desired bits.
Valid gloabal flags are:
DNS_QUERY - listen for other machines session announcements,
DNS_ANNOUNCE - announce own sessions,
DNS - combination of both.
Long as none of the DNS related flags has been explicitly set or cleared, DNS will run in full.
LOOPBACK - without this services originating from the local machine will be ignored in DNS.
DEL_15 - delete previously seen sessions after 15 minutes should they not have been (re)announced.
DEL_30 - delete previously seen sessions after 30 minutes
SHIFT_PORTS - allow the library to pick other then the given local ports should those be in use and unavailable
. Channel specific flags:
RTPA_AUTOCONNECT - connect an RTP Session when the corresponding MIDI channel is opened. Active by default.Toggling this also instructs newly created local sessions to start listening for invitations.

getFlags

public static int getFlags(int ch)

Returns global (if ch == -1) or a specific channel's control flags.

setName

public static void setName(int ch,
           java.lang.String userName)

getName

public static java.lang.String getName(int ch)

getClientIP

public static java.lang.String getClientIP(int ch,
                           int id)

Returns the ip address of a client that connected to a local session

getClientPort

public static int getClientPort(int ch,
                int id)

Returns the port number on a client machine that connected to a local session

getClientName

public static java.lang.String getClientName(int ch,
                             int id)

Returns the Bonjour name of a client that connected to a local session

addSystemListener

public static void addSystemListener(NMJSystemListener l)

Adds a listener to be informed of state changes and errors in the system.

removeSystemListener

public static void removeSystemListener(NMJSystemListener l)

setProperty

public static void setProperty(java.lang.String key,
               java.lang.String value)

getProperty

public static java.lang.String getProperty(java.lang.String key,
                           java.lang.String def)

getConnectivity

public static int getConnectivity(java.lang.Object android_content_Context)

Android only.
This method does nothing in J2SE context and is only in the source to avoid the necessity for two separate javadoc editions. On Android the Object argument needs to be an instance of android.content.Context. The correct documentation should therefore read: public static int getConnectivity(android.content.Context ctx)
Returns a bitmask of CONNECTIVITY_... flags indicating what connection method will be available.

setBluetoothStackAdapter

public static void setBluetoothStackAdapter(java.lang.String fullyQualifiedClassName)

Sets the Bluetooth adapter implementation to use. The given class must extend BluetoothStackAdapter and will be loaded via Class.foName(..) when channels set to BLUETOOTH mode are opened. See the BluetoothStackAdapter class for more details.

getBluetoothStackAdapter

public static java.lang.String getBluetoothStackAdapter()

setBluetoothSystemListener

public static void setBluetoothSystemListener(NMJBluetoothSystemListener btl)

removeBluetoothSystemListener

public static void removeBluetoothSystemListener(NMJBluetoothSystemListener btl)

breakBluetoothQuery

public static void breakBluetoothQuery()

runBluetoothQuery

public static void runBluetoothQuery(NMJBluetoothSystemListener btl)
                              throws java.lang.Exception

Throws:

java.lang.Exception

deleteChannel

public static void deleteChannel(int ch)

connectLocalSession

public static void connectLocalSession(int ch,
                       int remoteCh)
                                throws java.lang.Exception

Connects a remote session (which once discovered or added manually will have its own channel representation) to a "local session". See the pdf readme file for details.

Throws:

java.lang.Exception

disconnectLocalSession

public static void disconnectLocalSession(int ch,
                          int idx)
                                   throws java.lang.Exception

Disconnects a local session's remote client. The index parameter is not yet used, but future versions may support multiple clients..

Throws:

java.lang.Exception

resetAll

public static void resetAll()

Deletes all settings and reverts to the default state of two multicast channels plus one local RTP session

getVersionInfo

public static java.lang.String getVersionInfo()

getVersionNumber

public static short getVersionNumber(int mm)

setDebugLevel

public static void setDebugLevel(int level)

setLogFile

public static void setLogFile(java.io.File logFile,
              boolean append)

showConfigDialog

public static javax.swing.JDialog showConfigDialog(java.awt.Frame parent,
                                   java.lang.String dialogTitle)

Deprecated. Deprecated method, use showConfigDialog(java.awt.Frame, String, int) instead.

showConfigDialog

public static javax.swing.JDialog showConfigDialog(java.awt.Frame parent,
                                   java.lang.String dialogTitle,
                                   int flags)

Brings up nmj's control panel as a child of the given frame (whose icon it will take) and with the given title. Both Frame and String arguments can be null. The flags parameter controls additional properties of the dialog. Currently only DLG_HIDDEN is defined. With that bit set, the dialog will not automatically show, so user code can reposition or customize the returned JDialog before making it visible.
This method is not available on Android where the control panel is launched as a separate activity (see the sample project for details).