Класс MidiFileFormat

java.lang.Object
- javax.sound.midi.MidiFileFormat

public class MidiFileFormat
extends Object

Объект типа MidiFileFormat инкапсулирует тип MIDI-файла, а также информацию о его длине и временной шкале.

Объект MidiFileFormat может содержать набор свойств. Свойство представляет собой пару ключ-значение: ключ имеет тип String, а связанное значение свойства — произвольный объект. Свойства определяют дополнительную метаинформацию (например, автора или авторские права). Свойства — это необязательная информация, и реализации читателей и писателей файлов не обязаны предоставлять или распознавать свойства.

В следующей таблице перечислены некоторые общие свойства, которые должны использоваться в реализациях:

Ключ свойства	Тип значения	Описание
"author"	`String`	имя автора этого файла
"title"	`String`	название этого файла
"copyright"	`String`	сообщение об авторских правах
"date"	`Date`	дата записи или выпуска
"comment"	`String`	произвольный текст

См. также:: MidiSystem.getMidiFileFormat(java.io.File), Sequencer.setSequence(java.io.InputStream stream)

Поля

Модификатор и тип	Поле и описание
`protected int`	`byteLength` Длина MIDI-файла в байтах.
`protected float`	`divisionType` Тип деления MIDI-файла.
`protected long`	`microsecondLength` Продолжительность MIDI-файла в микросекундах.
`protected int`	`resolution` Разрешение временной шкалы MIDI-файла.
`protected int`	`type` Тип MIDI-файла.
`static int`	`UNKNOWN_LENGTH` Представляет неизвестную длину.

Конструкторы

Конструктор и описание
`MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds)` Создает объект типа `MidiFileFormat`.
`MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds, Map<String,Object> properties)` Создаёт объект `MidiFileFormat` с набором свойств.

Методы

Модификатор и тип	Метод и описание
`int`	`getByteLength()` Возвращает длину MIDI-файла в байтах.
`float`	`getDivisionType()` Возвращает тип деления временной шкалы MIDI-файла.
`long`	`getMicrosecondLength()` Возвращает длину MIDI-файла в микросекундах.
`Object`	`getProperty(String key)` Возвращает значение свойства, заданного ключом.
`int`	`getResolution()` Возвращает разрешение временной шкалы MIDI-файла.
`int`	`getType()` Возвращает тип MIDI-файла.
`Map<String,Object>`	`properties()` Возвращает неизменяемую карту свойств.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

UNKNOWN_LENGTH

public static final int UNKNOWN_LENGTH

Представляет неизвестную длину.

См. также:: getByteLength(), getMicrosecondLength(), Постоянные значения полей

type

protected int type

Тип MIDI-файла.

divisionType

protected float divisionType

Тип деления MIDI-файла.

См. также:: Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30

resolution

protected int resolution

Разрешение временной шкалы MIDI-файла.

byteLength

protected int byteLength

Длина MIDI-файла в байтах.

microsecondLength

protected long microsecondLength

Продолжительность MIDI-файла в микросекундах.

Подробное описание конструкторов

MidiFileFormat

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

Создаёт объект типа MidiFileFormat.

Параметры:: type - тип MIDI-файла (0, 1 или 2); divisionType - тип деления временной шкалы (PPQ или один из типов SMPTE); resolution - разрешение временной шкалы; bytes - длина MIDI-файла в байтах или UNKNOWN_LENGTH, если она неизвестна; microseconds - продолжительность файла в микросекундах или UNKNOWN_LENGTH, если она неизвестна
См. также:: UNKNOWN_LENGTH, Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30

MidiFileFormat

public MidiFileFormat(int type,
                      float divisionType,
                      int resolution,
                      int bytes,
                      long microseconds,
                      Map<String,Object> properties)

Создаёт объект MidiFileFormat с набором свойств.

Параметры:: type - тип MIDI-файла (0, 1 или 2); divisionType - тип деления временной шкалы (PPQ или один из типов SMPTE); resolution - разрешение временной шкалы; bytes - длина MIDI-файла в байтах или UNKNOWN_LENGTH, если она неизвестна; microseconds - продолжительность файла в микросекундах или UNKNOWN_LENGTH, если она неизвестна; properties - объект Map<String,Object> со свойствами
С тех пор:: 1.5
См. также:: UNKNOWN_LENGTH, Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30

Подробное описание методов

getType

public int getType()

Возвращает тип MIDI-файла.

Возвращает:: тип файла (0, 1 или 2)

getDivisionType

public float getDivisionType()

Возвращает тип деления временной шкалы MIDI-файла.

Возвращает:: тип деления (PPQ или один из типов SMPTE)
См. также:: Sequence(float, int), Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30, Sequence.getDivisionType()

getResolution

public int getResolution()

Возвращает разрешение временной шкалы MIDI-файла. Если тип деления — PPQ, разрешение задаётся в тиках за такт. Для временной шкалы SMPTE разрешение задаётся в тиках за кадр.

Возвращает:: количество тиков за такт (PPQ) или за кадр (SMPTE)
См. также:: getDivisionType(), Sequence.getResolution()

getByteLength

public int getByteLength()

Возвращает длину MIDI-файла в байтах.

Возвращает:: количество байтов в файле или UNKNOWN_LENGTH, если длина неизвестна
См. также:: UNKNOWN_LENGTH

getMicrosecondLength

public long getMicrosecondLength()

Возвращает длину MIDI-файла в микросекундах.

Возвращает:: длительность файла в микросекундах или UNKNOWN_LENGTH, если длина неизвестна
См. также:: Sequence.getMicrosecondLength(), getByteLength(), UNKNOWN_LENGTH

properties

public Map<String,Object> properties()

Возвращает неизменяемую карту свойств. Подробнее о свойствах см. в class description.

Возвращает:: объект Map<String,Object>, содержащий все свойства. Если свойства не распознаны, возвращается пустая карта.
С тех пор:: 1.5
См. также:: getProperty(String)

getProperty

public Object getProperty(String key)

Возвращает значение свойства, заданного ключом. Подробнее о свойствах см. в class description.

Если указанное свойство не определено для конкретного формата файла, этот метод возвращает null.

Параметры:: key - ключ искомого свойства
Возвращает:: значение свойства с указанным ключом или null если свойство не существует.
С тех пор:: 1.5
См. также:: properties()

© 1993, 2020, 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.