Класс 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()`	Возвращает неизменяемое отображение свойств.

Методы, объявленные в классе 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, 2025, 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/25/docs/api/java.desktop/javax/sound/midi/MidiFileFormat.html