Class SysexMessage

Field Detail

• SYSTEM_EXCLUSIVE

  public static final int SYSTEM_EXCLUSIVE

  Status byte for System Exclusive message (0xF0, or 240).

  See Also:

  MidiMessage.getStatus(), Constant Field Values

• SPECIAL_SYSTEM_EXCLUSIVE

  public static final int SPECIAL_SYSTEM_EXCLUSIVE

  Status byte for Special System Exclusive message (0xF7, or 247), which is used in MIDI files. It has the same value as END_OF_EXCLUSIVE, which is used in the real-time "MIDI wire" protocol.

  See Also:

  MidiMessage.getStatus(), Constant Field Values

Constructor Detail

• SysexMessage

  public SysexMessage()

  Constructs a new SysexMessage. 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.

  See Also:

  setMessage(byte[], int)

• SysexMessage

  public SysexMessage(byte[] data,
              int length)
               throws InvalidMidiDataException

  Constructs a new SysexMessage and sets the data for the message. The first byte of the data array must be a valid system exclusive status byte (0xF0 or 0xF7). The contents of the message can be changed by using one of the setMessage methods.

  Parameters:

  data - the system exclusive message data including the status byte

  length - the length of the valid message data in the array, including the status byte; it should be non-negative and less than or equal to data.length

  Throws:

  InvalidMidiDataException - if the parameter values do not specify a valid MIDI meta message.

  Since:

  1.7

  See Also:

  setMessage(byte[], int), setMessage(int, byte[], int), getData()

• SysexMessage

  public SysexMessage(int status,
              byte[] data,
              int length)
               throws InvalidMidiDataException

  Constructs a new SysexMessage and sets the data for the message. The contents of the message can be changed by using one of the setMessage methods.

  Parameters:

  status - the status byte for the message; it must be a valid system exclusive status byte (0xF0 or 0xF7)

  data - the system exclusive message data (without the status byte)

  length - the length of the valid message data in the array; it should be non-negative and less than or equal to data.length

  Throws:

  InvalidMidiDataException - if the parameter values do not specify a valid MIDI meta message.

  Since:

  1.7

  See Also:

  setMessage(byte[], int), setMessage(int, byte[], int), getData()

• SysexMessage

  protected SysexMessage(byte[] data)

  Constructs a new SysexMessage.

  Parameters:

  data - an array of bytes containing the complete message. The message data may be changed using the setMessage method.

  See Also:

  setMessage(byte[], int)

Method Detail

• setMessage

  public void setMessage(byte[] data,
                int length)
                  throws InvalidMidiDataException

  Sets the data for the system exclusive message. The first byte of the data array must be a valid system exclusive status byte (0xF0 or 0xF7).

  Overrides:

  setMessage in class MidiMessage

  Parameters:

  data - the system exclusive message data

  length - the length of the valid message data in the array, including the status byte.

  Throws:

  InvalidMidiDataException

• setMessage

  public void setMessage(int status,
                byte[] data,
                int length)
                  throws InvalidMidiDataException

  Sets the data for the system exclusive message.

  Parameters:

  status - the status byte for the message (0xF0 or 0xF7)

  data - the system exclusive message data

  length - the length of the valid message data in the array

  Throws:

  InvalidMidiDataException

• getData

  public byte[] getData()

  Obtains a copy of the data for the system exclusive message. The returned array of bytes does not include the status byte.

  Returns:

  array containing the system exclusive message data.

• clone

  public Object clone()

  Creates a new object of the same class and with the same contents as this object.

  Specified by:

  clone in class MidiMessage

  Returns:

  a clone of this instance

  See Also:

  Cloneable