| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class MidiFileFormat extends Object
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" | {@link java.lang.String String} | name of the author of this file |
"title" | {@link java.lang.String String} | title of this file |
"copyright" | {@link java.lang.String String} | copyright message |
"date" | {@link java.util.Date Date} | date of the recording or release |
"comment" | {@link java.lang.String 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 properties) Construct a MidiFileFormat with a set of properties.
|
Method Summary | |
---|---|
int |
Obtains the length of the MIDI file, expressed in 8-bit bytes. |
float |
Obtains the timing division type for the MIDI file. |
long |
Obtains the length of the MIDI file, expressed in microseconds. |
Object |
getProperty(String key) Obtain the property value specified by the key. |
int |
Obtains the timing resolution for the MIDI file. |
int |
getType() Obtains the MIDI file type. |
Map |
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 |
---|
protected int byteLength
protected float divisionType
protected long microsecondLength
protected int resolution
protected int type
public static final int UNKNOWN_LENGTH
Constructor Detail |
---|
public MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds)
MidiFileFormat
.
type
- the MIDI file type (0, 1, or 2)divisionType
- the timing division type (PPQ or one of the SMPTE types)resolution
- the timing resolutionbytes
- the length of the MIDI file in bytes, or UNKNOWN_LENGTH if not knownmicroseconds
- the duration of the file in microseconds, or UNKNOWN_LENGTH if not knownpublic MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds, Map properties)
MidiFileFormat
with a set of properties.
type
- the MIDI file type (0, 1, or 2)divisionType
- the timing division type
(PPQ or one of the SMPTE types)resolution
- the timing resolutionbytes
- the length of the MIDI file in bytes,
or UNKNOWN_LENGTH if not knownmicroseconds
- the duration of the file in microseconds,
or UNKNOWN_LENGTH if not knownproperties
- a Map<String,Object>
object
with propertiesMethod Detail |
---|
public int getByteLength()
public float getDivisionType()
public long getMicrosecondLength()
public Object getProperty(String key)
If the specified property is not defined for a
particular file format, this method returns
null
.
key
- the key of the desired propertynull
if the property does not exist.public int getResolution()
public int getType()
public Map properties()
Map<String,Object>
object containing
all properties. If no properties are recognized, an empty map is
returned.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |