java.lang.Object javax.sound.midi.MidiFileFormat
A MidiFileFormat object encapsulates a MIDI file's type, as well as its length and timing information.
A MidiFileFormat object can include a set of properties. A property is a pair of key and value: the key is of type String, the associated property value is an arbitrary object. Properties specify additional informational meta data (like a author, or copyright). Properties are optional information, and file reader and file writer implementations are not required to provide or recognize properties.
The following table lists some common properties that should be used in implementations:
Property key | Value type | Description |
---|---|---|
"author" | String | name of the author of this file |
"title" | String | title of this file |
"copyright" | String | copyright message |
"date" | Date | date of the recording or release |
"comment" | String | an arbitrary text |
Field Summary | |
---|---|
protected int |
byteLength
The length of the MIDI file in bytes. |
protected float |
divisionType
The division type of the MIDI file. |
protected long |
microsecondLength
The duration of the MIDI file in microseconds. |
protected int |
resolution
The timing resolution of the MIDI file. |
protected int |
type
The type of MIDI file. |
static int |
UNKNOWN_LENGTH
Represents unknown length. |
Constructor Summary | |
---|---|
MidiFileFormat
(int type, float divisionType, int resolution, int bytes, long microseconds) Constructs a MidiFileFormat. |
|
MidiFileFormat
(int type, float divisionType, int resolution, int bytes, long microseconds,
Map
<
String
,
Object
Construct a MidiFileFormat with a set of properties. |
Method Summary | |
---|---|
int |
getByteLength
() Obtains the length of the MIDI file, expressed in 8-bit bytes. |
float |
getDivisionType
() Obtains the timing division type for the MIDI file. |
long |
getMicrosecondLength
() Obtains the length of the MIDI file, expressed in microseconds. |
Object |
getProperty
(
String
Obtain the property value specified by the key. |
int |
getResolution
() Obtains the timing resolution for the MIDI file. |
int |
getType
() Obtains the MIDI file type. |
Map < String , Object |
properties
()
Obtain an unmodifiable map of properties. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Field Detail |
---|
public static final int UNKNOWN_LENGTH
protected int type
protected float divisionType
protected int resolution
protected int byteLength
protected long microsecondLength
Constructor Detail |
---|
public MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds)
public MidiFileFormat (int type, float divisionType, int resolution, int bytes, long microseconds, Map< String, Object> properties)
Method Detail |
---|
public int getType()
public float getDivisionType()
public int getResolution()
public int getByteLength()
public long getMicrosecondLength()
public Map< String, Object> properties ()
public ObjectgetProperty ( String key)
If the specified property is not defined for a particular file format, this method returns null.