Module java.desktop

Class MidiFileFormat

  • 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:

    MIDI File Format Properties
    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(, Sequencer.setSequence( stream)
    • Constructor Detail

      • MidiFileFormat

        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 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
        See Also:
        UNKNOWN_LENGTH, Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30
    • Method Detail

      • getType

        public int getType()
        Obtains the MIDI file type.
        the file's type (0, 1, or 2)
      • getResolution

        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.
        the number of ticks per beat (PPQ) or per frame (SMPTE)
        See Also:
        getDivisionType(), Sequence.getResolution()
      • getByteLength

        public int getByteLength()
        Obtains the length of the MIDI file, expressed in 8-bit bytes.
        the number of bytes in the file, or UNKNOWN_LENGTH if not known
        See Also:
      • properties

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

        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 property
        the value of the property with the specified key, or null if the property does not exist
        See Also: