MidiFileFormat JDK 1.6)

Description

public class 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

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

See also: MidiSystem.getMidiFileFormat(java.io.File) Sequencer.setSequence(java.io.InputStream stream)

Constructors

public MidiFileFormat (int type, float divisionType, int resolution, int bytes, long microseconds)

Constructs a MidiFileFormat.

Constructs a MidiFileFormat.
Parameters:
- type - the MIDI file type (0, 1, or 2)
- divisionType - the timing division type (PPQ or one of the SMPTE types)
- resolution - the timing resolution
- bytes - the length of the MIDI file in bytes, or UNKNOWN_LENGTH if not known
- microseconds - the duration of the file in microseconds, or UNKNOWN_LENGTH if not known
See Also: MidiFileFormat.UNKNOWN_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.

Construct a MidiFileFormat with a set of properties.
Parameters:
- type - the MIDI file type (0, 1, or 2)
- divisionType - the timing division type (PPQ or one of the SMPTE types)
- resolution - the timing resolution
- bytes - the length of the MIDI file in bytes, or UNKNOWN_LENGTH if not known
- microseconds - the duration of the file in microseconds, or UNKNOWN_LENGTH if not known
- properties - a Map<String,Object> object with properties
Since: 1.5
See Also: MidiFileFormat.UNKNOWN_LENGTH, Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30,

Methods

Hide/Show inherited methods

public int getByteLength ()

Obtains the length of the MIDI file, expressed in 8-bit bytes.

public float getDivisionType ()

Obtains the timing division type for the MIDI file.

public long getMicrosecondLength ()

Obtains the length of the MIDI file, expressed in microseconds.

public Object getProperty (String key)

Obtain the property value specified by the key.

public int getResolution ()

Obtains the timing resolution for the MIDI file.

public int getType ()

Obtains the MIDI file type.

public Map<String, Object> properties ()

Obtain an unmodifiable map of properties.

Obtain an unmodifiable map of properties.
The concept of properties is further explained in
the class description.
Returns: a Map<String,Object> object containing all properties. If no properties are recognized, an empty map is returned.
Since: 1.5
See Also: MidiFileFormat.getProperty(String),

Fields

Hide/Show inherited fields

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.

publicfinalstatic int UNKNOWN_LENGTH = "-1"

Represents unknown length.