Класс MidiFileFormat

java.lang.Object

javax.sound.midi.MidiFileFormat

public class MidiFileFormat extends Object

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

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

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

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

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected int`	`byteLength`	Длина MIDI-файла в байтах.
`protected float`	`divisionType`	Тип раздела времени MIDI-файла.
`protected long`	`microsecondLength`	Длительность MIDI-файла в микросекундах.
`protected int`	`resolution`	Разрешение временной шкалы MIDI-файла.
`protected int`	`type`	Тип MIDI-файла.
`static final 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-файла, выраженную в 8-битных байтах.
`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

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

См. также:

type

protected int type

Тип файла MIDI.

divisionType

protected float divisionType

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

См. также:

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, если неизвестна

См. также:

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

См. также:

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

getType

public int getType()

Получает тип MIDI-файла.

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

getDivisionType

public float getDivisionType()

Получает тип деления временной шкалы для MIDI-файла.

Возвращает:

тип деления (PPQ или один из типов SMPTE)

См. также:

getResolution

public int getResolution()

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

Возвращает:

количество отметков за такт (PPQ) или за кадр (SMPTE)

См. также:

getByteLength

public int getByteLength()

Получает длину MIDI-файла, выраженную в 8-битных байтах.

Возвращает:

количество байт в файле, или UNKNOWN_LENGTH если неизвестно

См. также:

getMicrosecondLength

public long getMicrosecondLength()

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

Возвращает:

длительность файла в микросекундах, или UNKNOWN_LENGTH если неизвестно

См. также:

properties

public Map<String,Object> properties()

Получить неизменяемую карту свойств. Понятие свойств подробно описано в class description.

Возвращает:

объект Map<String,Object> содержащий все свойства. Если свойства не распознаны, возвращается пустая карта.

С:

1.5

См. также:

getProperty

public Object getProperty(String key)

Получить значение свойства, заданное ключом. Понятие свойств подробно описано в class description.

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

Параметры:

key - ключ желаемого свойства

Возвращает:

значение свойства с указанным ключом, или null если свойство не существует

С:

1.5

См. также:

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/sound/midi/MidiFileFormat.html