public class ShortMessage extends MidiMessage
ShortMessage
contains 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. The ShortMessage
class provides methods for getting and
setting the contents of the MIDI message.
A number of ShortMessage
methods 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 of ShortMessage
, such as
SYSTEM_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 the
MidiMessage
class description.
SysexMessage
,
MetaMessage
Modifier and Type | Field and Description |
---|---|
static int |
ACTIVE_SENSING
Status byte for Active Sensing message (0xFE, or 254).
|
static int |
CHANNEL_PRESSURE
Command value for Channel Pressure (Aftertouch) message (0xD0, or 208).
|
static int |
CONTINUE
Status byte for Continue message (0xFB, or 251).
|
static int |
CONTROL_CHANGE
Command value for Control Change message (0xB0, or 176).
|
static int |
END_OF_EXCLUSIVE
Status byte for End of System Exclusive message (0xF7, or 247).
|
static int |
MIDI_TIME_CODE
Status byte for MIDI Time Code Quarter Frame message (0xF1, or 241).
|
static int |
NOTE_OFF
Command value for Note Off message (0x80, or 128).
|
static int |
NOTE_ON
Command value for Note On message (0x90, or 144).
|
static int |
PITCH_BEND
Command value for Pitch Bend message (0xE0, or 224).
|
static int |
POLY_PRESSURE
Command value for Polyphonic Key Pressure (Aftertouch) message (0xA0, or
160).
|
static int |
PROGRAM_CHANGE
Command value for Program Change message (0xC0, or 192).
|
static int |
SONG_POSITION_POINTER
Status byte for Song Position Pointer message (0xF2, or 242).
|
static int |
SONG_SELECT
Status byte for MIDI Song Select message (0xF3, or 243).
|
static int |
START
Status byte for Start message (0xFA, or 250).
|
static int |
STOP
Status byte for Stop message (0xFC, or 252).
|
static int |
SYSTEM_RESET
Status byte for System Reset message (0xFF, or 255).
|
static int |
TIMING_CLOCK
Status byte for Timing Clock message (0xF8, or 248).
|
static int |
TUNE_REQUEST
Status byte for Tune Request message (0xF6, or 246).
|
data, length
Modifier | Constructor and Description |
---|---|
|
ShortMessage()
Constructs a new
ShortMessage . |
protected |
ShortMessage(byte[] data)
Constructs a new
ShortMessage . |
|
ShortMessage(int status)
Constructs a new
ShortMessage which represents a MIDI message
that takes no data bytes. |
|
ShortMessage(int status,
int data1,
int data2)
Constructs a new
ShortMessage which represents a MIDI message
that takes up to two data bytes. |
|
ShortMessage(int command,
int channel,
int data1,
int data2)
Constructs a new
ShortMessage which represents a channel MIDI
message that takes up to two data bytes. |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates a new object of the same class and with the same contents as this
object.
|
int |
getChannel()
Obtains the MIDI channel associated with this event.
|
int |
getCommand()
Obtains the MIDI command associated with this event.
|
int |
getData1()
Obtains the first data byte in the message.
|
int |
getData2()
Obtains the second data byte in the message.
|
protected int |
getDataLength(int status)
Retrieves the number of data bytes associated with a particular status
byte value.
|
void |
setMessage(int status)
Sets the parameters for a MIDI message that takes no data bytes.
|
void |
setMessage(int status,
int data1,
int data2)
Sets the parameters for a MIDI message that takes one or two data bytes.
|
void |
setMessage(int command,
int channel,
int data1,
int data2)
Sets the short message parameters for a channel message which takes up to
two data bytes.
|
getLength, getMessage, getStatus, setMessage
public static final int MIDI_TIME_CODE
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int SONG_POSITION_POINTER
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int SONG_SELECT
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int TUNE_REQUEST
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int END_OF_EXCLUSIVE
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int TIMING_CLOCK
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int START
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int CONTINUE
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int STOP
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int ACTIVE_SENSING
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int SYSTEM_RESET
MidiMessage.getStatus()
,
Constant Field Valuespublic static final int NOTE_OFF
public static final int NOTE_ON
public static final int POLY_PRESSURE
public static final int CONTROL_CHANGE
public static final int PROGRAM_CHANGE
public static final int CHANNEL_PRESSURE
public static final int PITCH_BEND
public ShortMessage()
ShortMessage
. 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 the setMessage
methods.setMessage(int)
public ShortMessage(int status) throws InvalidMidiDataException
ShortMessage
which represents a MIDI message
that takes no data bytes. The contents of the message can be changed by
using one of the setMessage
methods.status
- the MIDI status byteInvalidMidiDataException
- if status
does not specify a
valid MIDI status byte for a message that requires no data bytessetMessage(int)
,
setMessage(int, int, int)
,
setMessage(int, int, int, int)
,
MidiMessage.getStatus()
public ShortMessage(int status, int data1, int data2) throws InvalidMidiDataException
ShortMessage
which 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 the setMessage
methods.status
- the MIDI status bytedata1
- the first data bytedata2
- the second data byteInvalidMidiDataException
- if the status byte or all data bytes
belonging to the message do not specify a valid MIDI messagesetMessage(int)
,
setMessage(int, int, int)
,
setMessage(int, int, int, int)
,
MidiMessage.getStatus()
,
getData1()
,
getData2()
public ShortMessage(int command, int channel, int data1, int data2) throws InvalidMidiDataException
ShortMessage
which 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 the setMessage
methods.command
- the MIDI command represented by this messagechannel
- the channel associated with the messagedata1
- the first data bytedata2
- the second data byteInvalidMidiDataException
- if the command value, channel value or
all data bytes belonging to the message do not specify a valid
MIDI messagesetMessage(int)
,
setMessage(int, int, int)
,
setMessage(int, int, int, int)
,
getCommand()
,
getChannel()
,
getData1()
,
getData2()
protected ShortMessage(byte[] data)
ShortMessage
.data
- an array of bytes containing the complete message. The
message data may be changed using the setMessage
method.setMessage(int)
public void setMessage(int status) throws InvalidMidiDataException
status
- the MIDI status byteInvalidMidiDataException
- if status
does not specify a
valid MIDI status byte for a message that requires no data bytessetMessage(int, int, int)
,
setMessage(int, int, int, int)
public void setMessage(int status, int data1, int data2) throws InvalidMidiDataException
status
- the MIDI status bytedata1
- the first data bytedata2
- the second data byteInvalidMidiDataException
- if the status byte, or all data
bytes belonging to the message, do not specify a valid MIDI
messagesetMessage(int, int, int, int)
,
setMessage(int)
public void setMessage(int command, int channel, int data1, int data2) throws InvalidMidiDataException
command
- the MIDI command represented by this messagechannel
- the channel associated with the messagedata1
- the first data bytedata2
- the second data byteInvalidMidiDataException
- if the status byte or all data bytes
belonging to the message, do not specify a valid MIDI messagesetMessage(int, int, int)
,
setMessage(int)
,
getCommand()
,
getChannel()
,
getData1()
,
getData2()
public int getChannel()
setMessage(int, int, int, int)
public int getCommand()
setMessage(int, int, int, int)
public int getData1()
data1
fieldsetMessage(int, int, int)
public int getData2()
data2
fieldsetMessage(int, int, int)
public Object clone()
clone
in class MidiMessage
Cloneable
protected final int getDataLength(int status) throws InvalidMidiDataException
status
- status byte value, which must represent a short MIDI
messageInvalidMidiDataException
- if the status
argument does not
represent the status byte for any short message Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2016, Oracle and/or its affiliates. All rights reserved.
DRAFT 9-internal+0-2016-01-26-133437.ivan.openjdk9onspinwait