Класс 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-файла в байтах (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

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

См. также:
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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/sound/midi/MidiFileFormat.html

Spec-Zone .ru
спецификации, руководства, описания, API