Spec-Zone.ru › OpenJDK 17

Класс 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 произвольный текст
См. также:
  • 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 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
Представляет неизвестную длину.
См. также:
  • 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> со свойствами
Since:
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, разрешение указано в тиках на удар. Для тайминга SMTPE разрешение указано в тиках на кадр.
Возвращает:
количество тиков на удар (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> , содержащий все свойства. Если свойства не распознаны, возвращается пустая карта.
Since:
1.5
См. также:
  • getProperty(String)

getProperty

public Object getProperty(String key)
Получает значение свойства, заданного ключом. Концепция свойств более подробно описана в class description.

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

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

© 1993, 2021, 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/17/docs/api/java.desktop/javax/sound/midi/MidiFileFormat.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API