javax.sound.midi
Class ShortMessage

java.lang.Object
  javax.sound.midi.MidiMessage
      javax.sound.midi.ShortMessage

All Implemented Interfaces:

Cloneable

public class ShortMessage
extends MidiMessage

A short MIDI message that is no longer than 3 bytes long.

Since:

1.3

Field Summary

static int	ACTIVE_SENSING Status byte for Active Sensing message.
static int	CHANNEL_PRESSURE Statue nibble for Channel Pressure message.
static int	CONTINUE Status byte for Continue message.
static int	CONTROL_CHANGE Status nibble for Control Change message.
static int	END_OF_EXCLUSIVE Status byte for End Of Exclusive message.
static int	MIDI_TIME_CODE Status byte for Time Code message.
static int	NOTE_OFF Status nibble for Note Off message.
static int	NOTE_ON Status nibble for Note On message.
static int	PITCH_BEND Status nibble for Pitch Bend message.
static int	POLY_PRESSURE Status nibble for Poly Pressure message.
static int	PROGRAM_CHANGE Status nibble for Program Change message.
static int	SONG_POSITION_POINTER Status byte for Song Position Pointer message.
static int	SONG_SELECT Status byte for Song Select message.
static int	START Status byte for Start message.
static int	STOP Status byte for Stop message.
static int	SYSTEM_RESET Status byte for System Reset message.
static int	TIMING_CLOCK Status byte for Timing Clock message.
static int	TUNE_REQUEST Status byte for Tune Request message.

Fields inherited from class javax.sound.midi.MidiMessage

data, length

Constructor Summary

	ShortMessage() Create a short MIDI message.
protected	ShortMessage(byte[] data) Create a short MIDI message.

Method Summary

Object	clone() clone creates a shallow clone of this.
int	getChannel() Get the channel information from this MIDI message, assuming it is a MIDI channel message.
int	getCommand() Get the command nibble from this MIDI message, assuming it is a MIDI channel message.
int	getData1() Get the first data byte from this message, assuming it exists, and zero otherwise.
int	getData2() Get the second data byte from this message, assuming it exists, and zero otherwise.
protected int	getDataLength(int status) Return the number of data bytes needed for a given MIDI status byte.
void	setMessage(int status) Set the MIDI message to one that requires no data bytes.
void	setMessage(int status, int data1, int data2) Set the MIDI message.
void	setMessage(int command, int channel, int data1, int data2)

Methods inherited from class javax.sound.midi.MidiMessage

getLength, getMessage, getStatus, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

MIDI_TIME_CODE

public static final int MIDI_TIME_CODE

Status byte for Time Code message.

See Also:

Constant Field Values

SONG_POSITION_POINTER

public static final int SONG_POSITION_POINTER

Status byte for Song Position Pointer message.

See Also:

Constant Field Values

SONG_SELECT

public static final int SONG_SELECT

Status byte for Song Select message.

See Also:

Constant Field Values

TUNE_REQUEST

public static final int TUNE_REQUEST

Status byte for Tune Request message.

See Also:

Constant Field Values

END_OF_EXCLUSIVE

public static final int END_OF_EXCLUSIVE

Status byte for End Of Exclusive message.

See Also:

Constant Field Values

TIMING_CLOCK

public static final int TIMING_CLOCK

Status byte for Timing Clock message.

See Also:

Constant Field Values

START

public static final int START

Status byte for Start message.

See Also:

Constant Field Values

CONTINUE

public static final int CONTINUE

Status byte for Continue message.

See Also:

Constant Field Values

STOP

public static final int STOP

Status byte for Stop message.

See Also:

Constant Field Values

ACTIVE_SENSING

public static final int ACTIVE_SENSING

Status byte for Active Sensing message.

See Also:

Constant Field Values

SYSTEM_RESET

public static final int SYSTEM_RESET

Status byte for System Reset message.

See Also:

Constant Field Values

NOTE_OFF

public static final int NOTE_OFF

Status nibble for Note Off message.

See Also:

Constant Field Values

NOTE_ON

public static final int NOTE_ON

Status nibble for Note On message.

See Also:

Constant Field Values

POLY_PRESSURE

public static final int POLY_PRESSURE

Status nibble for Poly Pressure message.

See Also:

Constant Field Values

CONTROL_CHANGE

public static final int CONTROL_CHANGE

Status nibble for Control Change message.

See Also:

Constant Field Values

PROGRAM_CHANGE

public static final int PROGRAM_CHANGE

Status nibble for Program Change message.

See Also:

Constant Field Values

CHANNEL_PRESSURE

public static final int CHANNEL_PRESSURE

Statue nibble for Channel Pressure message.

See Also:

Constant Field Values

PITCH_BEND

public static final int PITCH_BEND

Status nibble for Pitch Bend message.

See Also:

Constant Field Values

Constructor Detail

ShortMessage

public ShortMessage()

Create a short MIDI message. The spec requires that this represent a valid MIDI message, but doesn't specify what it should be. We've chosen the STOP message for our implementation.

ShortMessage

protected ShortMessage(byte[] data)

Create a short MIDI message. The data argument should be a valid MIDI message. Unfortunately the spec does not allow us to throw an InvalidMidiDataException if data is invalid.

Parameters:

data - the message data

Method Detail

setMessage

public void setMessage(int status,
                       int data1,
                       int data2)
                throws InvalidMidiDataException

Set the MIDI message.

Parameters:

status - the status byte for this message

data1 - the first data byte for this message

data2 - the second data byte for this message

Throws:

InvalidMidiDataException - if status is bad, or data is out of range

setMessage

public void setMessage(int command,
                       int channel,
                       int data1,
                       int data2)
                throws InvalidMidiDataException

Throws:

InvalidMidiDataException

setMessage

public void setMessage(int status)
                throws InvalidMidiDataException

Set the MIDI message to one that requires no data bytes.

Parameters:

status - the status byte for this message

Throws:

InvalidMidiDataException - if status is bad, or requires data

getDataLength

protected final int getDataLength(int status)
                           throws InvalidMidiDataException

Return the number of data bytes needed for a given MIDI status byte.

Parameters:

status - the status byte for a short MIDI message

Returns:

the number of data bytes needed for this status byte

Throws:

InvalidMidiDataException - if status is an invalid status byte

getChannel

public int getChannel()

Get the channel information from this MIDI message, assuming it is a MIDI channel message.

Returns:

the MIDI channel for this message

getCommand

public int getCommand()

Get the command nibble from this MIDI message, assuming it is a MIDI channel message.

Returns:

the MIDI command for this message

getData1

public int getData1()

Get the first data byte from this message, assuming it exists, and zero otherwise.

Returns:

the first data byte or zero if none exists.

getData2

public int getData2()

Get the second data byte from this message, assuming it exists, and zero otherwise.

Returns:

the second date byte or zero if none exists.

clone

public Object clone()

Description copied from class: Object

clone creates a shallow clone of this.

Specified by:

clone in class MidiMessage

Returns:

a clone of this object.