Cloneable
public class SysexMessage extends MidiMessage
SysexMessage
object represents a MIDI system exclusive message. When a system exclusive message is read from a MIDI file, it always has a defined length. Data from a system exclusive message from a MIDI file should be stored in the data array of a SysexMessage
as follows: the system exclusive message status byte (0xF0 or 0xF7), all message data bytes, and finally the end-of-exclusive flag (0xF7). The length reported by the SysexMessage
object is therefore the length of the system exclusive data plus two: one byte for the status byte and one for the end-of-exclusive flag.
As dictated by the Standard MIDI Files specification, two status byte values are legal for a SysexMessage
read from a MIDI file:
SysexMessages
. In this case, the length of the system exclusive data is not known in advance; the end of the system exclusive data is marked by an end-of-exclusive flag (0xF7) in the MIDI wire byte stream. SysexMessage
object containing data for a particular system exclusive message should have the status value 0xF0. If this message contains all the system exclusive data for the message, it should end with the status byte 0xF7 (EOX). Otherwise, additional system exclusive data should be sent in one or more SysexMessages
with a status value of 0xF7. The SysexMessage
containing the last of the data for the system exclusive message should end with the value 0xF7 (EOX) to mark the end of the system exclusive message. If system exclusive data from SysexMessages
objects is being transmitted using MIDI wire protocol, only the initial 0xF0 status byte, the system exclusive data itself, and the final 0xF7 (EOX) byte should be propagated; any 0xF7 status bytes used to indicate that a SysexMessage
contains continuing system exclusive data should not be propagated via MIDI wire protocol.
Modifier and Type | Field | Description |
---|---|---|
static final int |
SPECIAL_SYSTEM_EXCLUSIVE |
Status byte for Special System Exclusive message (0xF7, or 247), which is used in MIDI files. |
static final int |
SYSTEM_EXCLUSIVE |
Status byte for System Exclusive message (0xF0, or 240). |
data, length
Modifier | Constructor | Description |
---|---|---|
Constructs a new SysexMessage . |
||
protected |
Constructs a new SysexMessage . |
|
Constructs a new SysexMessage and sets the data for the message. |
||
Constructs a new SysexMessage and sets the data for the message. |
Modifier and Type | Method | Description |
---|---|---|
Object |
clone() |
Creates a new object of the same class and with the same contents as this object. |
byte[] |
getData() |
Obtains a copy of the data for the system exclusive message. |
void |
setMessage |
Sets the data for the system exclusive message. |
void |
setMessage |
Sets the data for the system exclusive message. |
getLength, getMessage, getStatus
public static final int SYSTEM_EXCLUSIVE
public static final int SPECIAL_SYSTEM_EXCLUSIVE
public SysexMessage()
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.public SysexMessage(byte[] data, int length) throws InvalidMidiDataException
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.data
- the system exclusive message data including the status bytelength
- 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
InvalidMidiDataException
- if the parameter values do not specify a valid MIDI meta messagepublic SysexMessage(int status, byte[] data, int length) throws InvalidMidiDataException
SysexMessage
and sets the data for the message. The contents of the message can be changed by using one of the setMessage
methods.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
InvalidMidiDataException
- if the parameter values do not specify a valid MIDI system exclusive messageprotected SysexMessage(byte[] data)
SysexMessage
.data
- an array of bytes containing the complete message. The message data may be changed using the setMessage
method.public void setMessage(byte[] data, int length) throws InvalidMidiDataException
setMessage
in class MidiMessage
data
- the system exclusive message datalength
- the length of the valid message data in the array, including the status byteInvalidMidiDataException
- if the parameter values do not specify a valid MIDI system exclusive messagepublic void setMessage(int status, byte[] data, int length) throws InvalidMidiDataException
status
- the status byte for the message (0xF0 or 0xF7)data
- the system exclusive message datalength
- the length of the valid message data in the arrayInvalidMidiDataException
- if the status byte is invalid for a system exclusive messagepublic byte[] getData()
public Object clone()
clone
in class MidiMessage
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/sound/midi/SysexMessage.html