- java.lang.Object
-
- javax.sound.midi.MidiMessage
-
- javax.sound.midi.ShortMessage
-
- All Implemented Interfaces:
Cloneable
public class ShortMessage extends MidiMessage
AShortMessagecontains a MIDI message that has at most two data bytes following its status byte. The types of MIDI message that satisfy this criterion are channel voice, channel mode, system common, and system real-time--in other words, everything except system exclusive and meta-events. TheShortMessageclass provides methods for getting and setting the contents of the MIDI message.A number of
ShortMessagemethods have integer parameters by which you specify a MIDI status or data byte. If you know the numeric value, you can express it directly. For system common and system real-time messages, you can often use the corresponding fields ofShortMessage, such asSYSTEM_RESET. For channel messages, the upper four bits of the status byte are specified by a command value and the lower four bits are specified by a MIDI channel number. To convert incoming MIDI data bytes that are in the form of Java's signed bytes, you can use the conversion code given in theMidiMessageclass description.- See Also:
SysexMessage,MetaMessage
-
-
Field Summary
Fields Modifier and Type Field Description static intACTIVE_SENSINGStatus byte for Active Sensing message (0xFE, or 254).static intCHANNEL_PRESSURECommand value for Channel Pressure (Aftertouch) message (0xD0, or 208).static intCONTINUEStatus byte for Continue message (0xFB, or 251).static intCONTROL_CHANGECommand value for Control Change message (0xB0, or 176).static intEND_OF_EXCLUSIVEStatus byte for End of System Exclusive message (0xF7, or 247).static intMIDI_TIME_CODEStatus byte for MIDI Time Code Quarter Frame message (0xF1, or 241).static intNOTE_OFFCommand value for Note Off message (0x80, or 128).static intNOTE_ONCommand value for Note On message (0x90, or 144).static intPITCH_BENDCommand value for Pitch Bend message (0xE0, or 224).static intPOLY_PRESSURECommand value for Polyphonic Key Pressure (Aftertouch) message (0xA0, or 160).static intPROGRAM_CHANGECommand value for Program Change message (0xC0, or 192).static intSONG_POSITION_POINTERStatus byte for Song Position Pointer message (0xF2, or 242).static intSONG_SELECTStatus byte for MIDI Song Select message (0xF3, or 243).static intSTARTStatus byte for Start message (0xFA, or 250).static intSTOPStatus byte for Stop message (0xFC, or 252).static intSYSTEM_RESETStatus byte for System Reset message (0xFF, or 255).static intTIMING_CLOCKStatus byte for Timing Clock message (0xF8, or 248).static intTUNE_REQUESTStatus byte for Tune Request message (0xF6, or 246).-
Fields declared in class javax.sound.midi.MidiMessage
data, length
-
-
Constructor Summary
Constructors Modifier Constructor Description ShortMessage()Constructs a newShortMessage.protectedShortMessage(byte[] data)Constructs a newShortMessage.ShortMessage(int status)Constructs a newShortMessagewhich represents a MIDI message that takes no data bytes.ShortMessage(int status, int data1, int data2)Constructs a newShortMessagewhich represents a MIDI message that takes up to two data bytes.ShortMessage(int command, int channel, int data1, int data2)Constructs a newShortMessagewhich represents a channel MIDI message that takes up to two data bytes.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Creates a new object of the same class and with the same contents as this object.intgetChannel()Obtains the MIDI channel associated with this event.intgetCommand()Obtains the MIDI command associated with this event.intgetData1()Obtains the first data byte in the message.intgetData2()Obtains the second data byte in the message.protected intgetDataLength(int status)Retrieves the number of data bytes associated with a particular status byte value.voidsetMessage(int status)Sets the parameters for a MIDI message that takes no data bytes.voidsetMessage(int status, int data1, int data2)Sets the parameters for a MIDI message that takes one or two data bytes.voidsetMessage(int command, int channel, int data1, int data2)Sets the short message parameters for a channel message which takes up to two data bytes.-
Methods declared in class javax.sound.midi.MidiMessage
getLength, getMessage, getStatus, setMessage
-
-
-
-
Field Detail
-
MIDI_TIME_CODE
public static final int MIDI_TIME_CODE
Status byte for MIDI Time Code Quarter Frame message (0xF1, or 241).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
SONG_POSITION_POINTER
public static final int SONG_POSITION_POINTER
Status byte for Song Position Pointer message (0xF2, or 242).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
SONG_SELECT
public static final int SONG_SELECT
Status byte for MIDI Song Select message (0xF3, or 243).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
TUNE_REQUEST
public static final int TUNE_REQUEST
Status byte for Tune Request message (0xF6, or 246).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
END_OF_EXCLUSIVE
public static final int END_OF_EXCLUSIVE
Status byte for End of System Exclusive message (0xF7, or 247).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
TIMING_CLOCK
public static final int TIMING_CLOCK
Status byte for Timing Clock message (0xF8, or 248).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
START
public static final int START
Status byte for Start message (0xFA, or 250).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
CONTINUE
public static final int CONTINUE
Status byte for Continue message (0xFB, or 251).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
STOP
public static final int STOP
Status byte for Stop message (0xFC, or 252).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
ACTIVE_SENSING
public static final int ACTIVE_SENSING
Status byte for Active Sensing message (0xFE, or 254).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
SYSTEM_RESET
public static final int SYSTEM_RESET
Status byte for System Reset message (0xFF, or 255).- See Also:
MidiMessage.getStatus(), Constant Field Values
-
NOTE_OFF
public static final int NOTE_OFF
Command value for Note Off message (0x80, or 128).- See Also:
- Constant Field Values
-
NOTE_ON
public static final int NOTE_ON
Command value for Note On message (0x90, or 144).- See Also:
- Constant Field Values
-
POLY_PRESSURE
public static final int POLY_PRESSURE
Command value for Polyphonic Key Pressure (Aftertouch) message (0xA0, or 160).- See Also:
- Constant Field Values
-
CONTROL_CHANGE
public static final int CONTROL_CHANGE
Command value for Control Change message (0xB0, or 176).- See Also:
- Constant Field Values
-
PROGRAM_CHANGE
public static final int PROGRAM_CHANGE
Command value for Program Change message (0xC0, or 192).- See Also:
- Constant Field Values
-
CHANNEL_PRESSURE
public static final int CHANNEL_PRESSURE
Command value for Channel Pressure (Aftertouch) message (0xD0, or 208).- See Also:
- Constant Field Values
-
PITCH_BEND
public static final int PITCH_BEND
Command value for Pitch Bend message (0xE0, or 224).- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ShortMessage
public ShortMessage()
Constructs a newShortMessage. The contents of the new message are guaranteed to specify a valid MIDI message. Subsequently, you may set the contents of the message using one of thesetMessagemethods.- See Also:
setMessage(int)
-
ShortMessage
public ShortMessage(int status) throws InvalidMidiDataExceptionConstructs a newShortMessagewhich represents a MIDI message that takes no data bytes. The contents of the message can be changed by using one of thesetMessagemethods.- Parameters:
status- the MIDI status byte- Throws:
InvalidMidiDataException- ifstatusdoes not specify a valid MIDI status byte for a message that requires no data bytes- Since:
- 1.7
- See Also:
setMessage(int),setMessage(int, int, int),setMessage(int, int, int, int),MidiMessage.getStatus()
-
ShortMessage
public ShortMessage(int status, int data1, int data2) throws InvalidMidiDataExceptionConstructs a newShortMessagewhich represents a MIDI message that takes up to two data bytes. If the message only takes one data byte, the second data byte is ignored. If the message does not take any data bytes, both data bytes are ignored. The contents of the message can be changed by using one of thesetMessagemethods.- Parameters:
status- the MIDI status bytedata1- the first data bytedata2- the second data byte- Throws:
InvalidMidiDataException- if the status byte or all data bytes belonging to the message do not specify a valid MIDI message- Since:
- 1.7
- See Also:
setMessage(int),setMessage(int, int, int),setMessage(int, int, int, int),MidiMessage.getStatus(),getData1(),getData2()
-
ShortMessage
public ShortMessage(int command, int channel, int data1, int data2) throws InvalidMidiDataExceptionConstructs a newShortMessagewhich represents a channel MIDI message that takes up to two data bytes. If the message only takes one data byte, the second data byte is ignored. If the message does not take any data bytes, both data bytes are ignored. The contents of the message can be changed by using one of thesetMessagemethods.- Parameters:
command- the MIDI command represented by this messagechannel- the channel associated with the messagedata1- the first data bytedata2- the second data byte- Throws:
InvalidMidiDataException- if the command value, channel value or all data bytes belonging to the message do not specify a valid MIDI message- Since:
- 1.7
- See Also:
setMessage(int),setMessage(int, int, int),setMessage(int, int, int, int),getCommand(),getChannel(),getData1(),getData2()
-
ShortMessage
protected ShortMessage(byte[] data)
Constructs a newShortMessage.- Parameters:
data- an array of bytes containing the complete message. The message data may be changed using thesetMessagemethod.- See Also:
setMessage(int)
-
-
Method Detail
-
setMessage
public void setMessage(int status) throws InvalidMidiDataExceptionSets the parameters for a MIDI message that takes no data bytes.- Parameters:
status- the MIDI status byte- Throws:
InvalidMidiDataException- ifstatusdoes not specify a valid MIDI status byte for a message that requires no data bytes- See Also:
setMessage(int, int, int),setMessage(int, int, int, int)
-
setMessage
public void setMessage(int status, int data1, int data2) throws InvalidMidiDataExceptionSets the parameters for a MIDI message that takes one or two data bytes. If the message takes only one data byte, the second data byte is ignored; if the message does not take any data bytes, both data bytes are ignored.- Parameters:
status- the MIDI status bytedata1- the first data bytedata2- the second data byte- Throws:
InvalidMidiDataException- if the status byte, or all data bytes belonging to the message, do not specify a valid MIDI message- See Also:
setMessage(int, int, int, int),setMessage(int)
-
setMessage
public void setMessage(int command, int channel, int data1, int data2) throws InvalidMidiDataExceptionSets the short message parameters for a channel message which takes up to two data bytes. If the message only takes one data byte, the second data byte is ignored; if the message does not take any data bytes, both data bytes are ignored.- Parameters:
command- the MIDI command represented by this messagechannel- the channel associated with the messagedata1- the first data bytedata2- the second data byte- Throws:
InvalidMidiDataException- if the status byte or all data bytes belonging to the message, do not specify a valid MIDI message- See Also:
setMessage(int, int, int),setMessage(int),getCommand(),getChannel(),getData1(),getData2()
-
getChannel
public int getChannel()
Obtains the MIDI channel associated with this event. This method assumes that the event is a MIDI channel message; if not, the return value will not be meaningful.- Returns:
- MIDI channel associated with the message
- See Also:
setMessage(int, int, int, int)
-
getCommand
public int getCommand()
Obtains the MIDI command associated with this event. This method assumes that the event is a MIDI channel message; if not, the return value will not be meaningful.- Returns:
- the MIDI command associated with this event
- See Also:
setMessage(int, int, int, int)
-
getData1
public int getData1()
Obtains the first data byte in the message.- Returns:
- the value of the
data1field - See Also:
setMessage(int, int, int)
-
getData2
public int getData2()
Obtains the second data byte in the message.- Returns:
- the value of the
data2field - See Also:
setMessage(int, int, int)
-
clone
public Object clone()
Creates a new object of the same class and with the same contents as this object.- Specified by:
clonein classMidiMessage- Returns:
- a clone of this instance
- See Also:
Cloneable
-
getDataLength
protected final int getDataLength(int status) throws InvalidMidiDataExceptionRetrieves the number of data bytes associated with a particular status byte value.- Parameters:
status- status byte value, which must represent a short MIDI message- Returns:
- data length in bytes (0, 1, or 2)
- Throws:
InvalidMidiDataException- if thestatusargument does not represent the status byte for any short message
-
-