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" | 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 |
MidiSystem.getMidiFileFormat(java.io.File)
, Sequencer.setSequence(java.io.InputStream stream)
public static final int UNKNOWN_LENGTH
Represents unknown length.
getByteLength()
, getMicrosecondLength()
, Constant Field Valuesprotected int type
The type of MIDI file.
protected float divisionType
The division type of the MIDI file.
Sequence.PPQ
, Sequence.SMPTE_24
, Sequence.SMPTE_25
, Sequence.SMPTE_30DROP
, Sequence.SMPTE_30
protected int resolution
The timing resolution of the MIDI file.
protected int byteLength
The length of the MIDI file in bytes.
protected long microsecondLength
The duration of the MIDI file in microseconds.
public MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds)
Constructs a 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 knownUNKNOWN_LENGTH
, Sequence.PPQ
, Sequence.SMPTE_24
, Sequence.SMPTE_25
, Sequence.SMPTE_30DROP
, Sequence.SMPTE_30
public MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds, Map<String,Object> properties)
Construct a 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 propertiesUNKNOWN_LENGTH
, Sequence.PPQ
, Sequence.SMPTE_24
, Sequence.SMPTE_25
, Sequence.SMPTE_30DROP
, Sequence.SMPTE_30
public int getType()
Obtains the MIDI file type.
public float getDivisionType()
Obtains the timing division type for the MIDI file.
Sequence.Sequence(float, int)
, Sequence.PPQ
, Sequence.SMPTE_24
, Sequence.SMPTE_25
, Sequence.SMPTE_30DROP
, Sequence.SMPTE_30
, Sequence.getDivisionType()
public int getResolution()
Obtains the timing resolution for the MIDI file. If the division type is PPQ, the resolution is specified in ticks per beat. For SMTPE timing, the resolution is specified in ticks per frame.
getDivisionType()
, Sequence.getResolution()
public int getByteLength()
Obtains the length of the MIDI file, expressed in 8-bit bytes.
UNKNOWN_LENGTH
public long getMicrosecondLength()
Obtains the length of the MIDI file, expressed in microseconds.
Sequence.getMicrosecondLength()
, getByteLength()
, UNKNOWN_LENGTH
public Map<String,Object> properties()
Obtain an unmodifiable map of properties. The concept of properties is further explained in the class description
.
Map<String,Object>
object containing all properties. If no properties are recognized, an empty map is returned.getProperty(String)
public Object getProperty(String key)
Obtain the property value specified by the key. The concept of properties is further explained in the class description
.
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.properties()
© 1993–2017, 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.