uk.org.toot.midi.message
Class ShortMsg

java.lang.Object
  extended by uk.org.toot.midi.message.MidiMsg
      extended by uk.org.toot.midi.message.ShortMsg
Direct Known Subclasses:
ChannelMsg, CommonMsg, RealTimeMsg

public class ShortMsg
extends MidiMsg

The base class for creating accessing and mutating 1, 2 and 3 byte MidiMessages without knowledge of the implementation class. This class is not normally used directly, rather the specialised classes NoteMsg, ChannelMsg, CommonMsg and RealTimeMsg should probably be used. Accessors and mutators are provided for the Data1 and Data2 bytes and the combined Data1and2 integer.


Constructor Summary
ShortMsg()
           
 
Method Summary
static javax.sound.midi.MidiMessage createShort(int status)
          Create a 1 byte MidiMessage with the specified Status byte.
static javax.sound.midi.MidiMessage createShort(int status, int data1)
          Create a 2 byte MidiMessage with the specified Status byte and Data1 byte.
static javax.sound.midi.MidiMessage createShort(int status, int data1, int data2)
          Create a 3 byte MidiMessage with the specified Status byte and Data1 and Data2 bytes.
static int getData1(javax.sound.midi.MidiMessage msg)
          Get the first data byte of the specified MidiMessage.
static int getData1and2(int data1, int data2)
           
static int getData1and2(javax.sound.midi.MidiMessage msg)
          Get the combined value of the first and second data bytes.
static int getData2(javax.sound.midi.MidiMessage msg)
          Get the second data byte of the specified MidiMessage.
static boolean isShort(int status)
           
static boolean isShort(javax.sound.midi.MidiMessage msg)
          Determine whether the MidiMessage can be handled by this class.
static javax.sound.midi.MidiMessage setData1(javax.sound.midi.MidiMessage msg, int data1)
          Set the first data byte of a 2 or 3 byte MidiMessage.
static javax.sound.midi.MidiMessage setData2(javax.sound.midi.MidiMessage msg, int data2)
          Set the second data byte of a 3 byte MidiMessage.
static javax.sound.midi.MidiMessage setMessage(javax.sound.midi.MidiMessage msg, int status)
          Set the Status byte of a 1 byte MidiMessage.
static javax.sound.midi.MidiMessage setMessage(javax.sound.midi.MidiMessage msg, int status, int data1, int data2)
          Set the Status byte and Data1 and Data2 bytes of a 2 byte MidiMessage.
 
Methods inherited from class uk.org.toot.midi.message.MidiMsg
getLength, getMessage, getStatus
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShortMsg

public ShortMsg()
Method Detail

isShort

public static boolean isShort(javax.sound.midi.MidiMessage msg)
Determine whether the MidiMessage can be handled by this class.


isShort

public static boolean isShort(int status)

createShort

public static javax.sound.midi.MidiMessage createShort(int status)
                                                throws javax.sound.midi.InvalidMidiDataException
Create a 1 byte MidiMessage with the specified Status byte.

Throws:
javax.sound.midi.InvalidMidiDataException

createShort

public static javax.sound.midi.MidiMessage createShort(int status,
                                                       int data1)
                                                throws javax.sound.midi.InvalidMidiDataException
Create a 2 byte MidiMessage with the specified Status byte and Data1 byte.

Throws:
javax.sound.midi.InvalidMidiDataException

createShort

public static javax.sound.midi.MidiMessage createShort(int status,
                                                       int data1,
                                                       int data2)
                                                throws javax.sound.midi.InvalidMidiDataException
Create a 3 byte MidiMessage with the specified Status byte and Data1 and Data2 bytes.

Throws:
javax.sound.midi.InvalidMidiDataException

setMessage

public static javax.sound.midi.MidiMessage setMessage(javax.sound.midi.MidiMessage msg,
                                                      int status)
                                               throws javax.sound.midi.InvalidMidiDataException
Set the Status byte of a 1 byte MidiMessage.

Throws:
javax.sound.midi.InvalidMidiDataException

setMessage

public static javax.sound.midi.MidiMessage setMessage(javax.sound.midi.MidiMessage msg,
                                                      int status,
                                                      int data1,
                                                      int data2)
                                               throws javax.sound.midi.InvalidMidiDataException
Set the Status byte and Data1 and Data2 bytes of a 2 byte MidiMessage.

Throws:
javax.sound.midi.InvalidMidiDataException

getData1

public static int getData1(javax.sound.midi.MidiMessage msg)
Get the first data byte of the specified MidiMessage.


setData1

public static javax.sound.midi.MidiMessage setData1(javax.sound.midi.MidiMessage msg,
                                                    int data1)
                                             throws javax.sound.midi.InvalidMidiDataException
Set the first data byte of a 2 or 3 byte MidiMessage.

Throws:
javax.sound.midi.InvalidMidiDataException

getData2

public static int getData2(javax.sound.midi.MidiMessage msg)
Get the second data byte of the specified MidiMessage.


setData2

public static javax.sound.midi.MidiMessage setData2(javax.sound.midi.MidiMessage msg,
                                                    int data2)
                                             throws javax.sound.midi.InvalidMidiDataException
Set the second data byte of a 3 byte MidiMessage.

Throws:
javax.sound.midi.InvalidMidiDataException

getData1and2

public static int getData1and2(javax.sound.midi.MidiMessage msg)
Get the combined value of the first and second data bytes. The first data byte is the least significant byte.


getData1and2

public static int getData1and2(int data1,
                               int data2)


Copyright © 2004, 2005, 2006, 2007 Steve Taylor. All Rights Reserved.