de.humatic.nmj.service

Class NMJDeviceService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

android.media.midi.MidiDeviceService

de.humatic.nmj.service.NMJDeviceService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, NetworkMidiClient

public class NMJDeviceService
extends android.media.midi.MidiDeviceService
implements NetworkMidiClient

MidiDeviceService implementation. This implements nmj as an xml configureable private service that will make n android.media.midi input and output ports available to an application that subclasses and binds to it. MIDIwise the app will only see and work with android.media.midi ports. When opened, those ports are patched to application definable and (if you so wish) user configureable nmj NetworkMidiInputs and -outputs so that an Android 6 MIDI app can exchange data via RTP or multicast. This should provide a relatively simple way to integrate nmj functionality with Android's new MIDI api.

Usage:

1. Subclass this class. This only requires creating a new class that extends NMJDeviceService and overriding the constructor. See nmjService.java in the sample code.
   
2. Create an xml service definition in your project's res/xml folder (see 'nss_device_info.xml' in the sample project and android.media.midi.MidiDeviceService documentation for details)
   
3. Create another xml document in res/xml and name it 'nmj.xml'. This will be used to define the network connections available through your service. A commented example is in the sample project. The xml based setup basically hides all configuration in a black box, but you can still use NMJConfig methods to change configurations and parameters at runtime if you call NMJConfig.edit(yourContext, false) before.
   
4. Announce the service in your app's AndroidManifest file
   
5. Implement the binding and message exchange code in your application if you want to monitor connection states and give users the possibility to reconfigure things. Refer to MainActivity.java and PortControls.java in the sample project.

This implementation only supports IP based modes (RTP, Multicast, WebSockets) and adb.
It does not support message scheduling (future timestamps in MidiInputPort.send(...) are ignored and data will always be sent 'now').
Except from the createMessage(...) utility all public methods in this class are inherited from the superclass, are implemented in this class and should not be called from application code.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AMM_INPUT Message type definitions
static int	AMM_STATE Message type definitions
static int	CHANNELS Message type definitions
static int	CONNECT Message type definitions
static int	ERROR_LOG Message type definitions
static int	LINK Message type definitions
static int	NMJ_ERROR Message type definitions
static int	NMJ_EVENT Message type definitions
static int	NMJ_INPUT Message type definitions
static int	NMJ_STATE Message type definitions
static int	PORTS Message type definitions
static int	SET_LINK Message type definitions

Fields inherited from class android.media.midi.MidiDeviceService

SERVICE_INTERFACE

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
NMJDeviceService()

Method Summary

Methods

Modifier and Type	Method and Description
static android.os.Message	createMessage(int portID, int msgType, java.lang.Object value) Utility to create a Message with bundled data.
android.os.IBinder	onBind(android.content.Intent intent) Called when the service is first loaded and bound to. This is a public interface method and not to be called by application code.
void	onCreate()
void	onDestroy()
void	onDeviceStatusChanged(android.media.midi.MidiDeviceStatus status) Called from the android.media.midi system when the status of one of this service's ports changes. This is a public interface method and not to be called or overridden by application code.
android.media.midi.MidiReceiver[]	onGetInputPortReceivers() Called from the android.media.midi system when another app opens this service as a destination. This is a public interface method and not to be called or overridden by application code.

Methods inherited from class android.media.midi.MidiDeviceService

getDeviceInfo, getOutputPortReceivers, onClose

Methods inherited from class android.app.Service

getApplication, onConfigurationChanged, onLowMemory, onRebind, onStart, onStartCommand, onTaskRemoved, onTrimMemory, onUnbind, startForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isRestricted, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

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

Field Detail

CONNECT

public static final int CONNECT

Message type definitions

See Also:

Constant Field Values

PORTS

public static final int PORTS

Message type definitions

See Also:

Constant Field Values

CHANNELS

public static final int CHANNELS

Message type definitions

See Also:

Constant Field Values

LINK

public static final int LINK

Message type definitions

See Also:

Constant Field Values

SET_LINK

public static final int SET_LINK

Message type definitions

See Also:

Constant Field Values

NMJ_STATE

public static final int NMJ_STATE

Message type definitions

See Also:

Constant Field Values

AMM_STATE

public static final int AMM_STATE

Message type definitions

See Also:

Constant Field Values

ERROR_LOG

public static final int ERROR_LOG

Message type definitions

See Also:

Constant Field Values

NMJ_EVENT

public static final int NMJ_EVENT

Message type definitions

See Also:

Constant Field Values

NMJ_ERROR

public static final int NMJ_ERROR

Message type definitions

See Also:

Constant Field Values

NMJ_INPUT

public static final int NMJ_INPUT

Message type definitions

See Also:

Constant Field Values

AMM_INPUT

public static final int AMM_INPUT

Message type definitions

See Also:

Constant Field Values

Constructor Detail

NMJDeviceService

public NMJDeviceService()

Method Detail

onCreate

public void onCreate()

Overrides:

onCreate in class android.media.midi.MidiDeviceService

onDestroy

public void onDestroy()

Overrides:

onDestroy in class android.app.Service

onGetInputPortReceivers

public android.media.midi.MidiReceiver[] onGetInputPortReceivers()

Called from the android.media.midi system when another app opens this service as a destination.
This is a public interface method and not to be called or overridden by application code.

Specified by:

onGetInputPortReceivers in class android.media.midi.MidiDeviceService

onDeviceStatusChanged

public void onDeviceStatusChanged(android.media.midi.MidiDeviceStatus status)

Called from the android.media.midi system when the status of one of this service's ports changes.
This is a public interface method and not to be called or overridden by application code.

Overrides:

onDeviceStatusChanged in class android.media.midi.MidiDeviceService

onBind

public android.os.IBinder onBind(android.content.Intent intent)

Called when the service is first loaded and bound to.
This is a public interface method and not to be called by application code.

Overrides:

onBind in class android.media.midi.MidiDeviceService

createMessage

public static android.os.Message createMessage(int portID,
                               int msgType,
                               java.lang.Object value)

Utility to create a Message with bundled data.

Parameters:

portID - - ID of the port that the request to make is related to

msgType - - the message's type or 'what' parameter

value - - what will go into the bundled data's "value" field. Can be null, an Integer, an int[], a String, a Bundle or a Bundle[]

Returns:

a Message with correctly formated data block.