Класс MidiSystem

public class MidiSystem
extends Object

Класс MidiSystem предоставляет доступ к ресурсам установленной MIDI-системы, включая устройства, такие как синтезаторы, секвенсоры и порты MIDI-ввода и -вывода. Типичное простое MIDI-приложение может начать работу, вызвав один или несколько методов MidiSystem, чтобы узнать, какие устройства установлены и получить необходимые в этом приложении.

Класс также имеет методы для чтения файлов, потоков и URL-адресов, содержащих стандартные данные MIDI-файлов или звуковые банки. Вы можете запросить формат указанного MIDI-файла у MidiSystem.

Вы не можете создать экземпляр MidiSystem; все методы являются статическими.

Свойства могут быть использованы для задания значений по умолчанию для MIDI-устройств. Рассматриваются как системные свойства, так и файл свойств. Файл свойств sound.properties считывается из места, специфичного для реализации (как правило, это каталог lib в каталоге установки Java). Если свойство существует как системное свойство, так и в файле свойств, то системное свойство имеет приоритет. Если ни одно из них не указано, выбирается подходящее значение по умолчанию среди доступных устройств. Синтаксис файла свойств указан в Properties.load. В следующей таблице перечислены доступные ключи свойств и методы, которые их учитывают:

Ключ свойства	Интерфейс	Затронутый метод
javax.sound.midi.Receiver	Receiver	getReceiver()
javax.sound.midi.Sequencer	Sequencer	getSequencer()
javax.sound.midi.Synthesizer	Synthesizer	getSynthesizer()
javax.sound.midi.Transmitter	Transmitter	getTransmitter()

Значение свойства состоит из имени класса поставщика и имени устройства, разделенных знаком решетки ("#"). Имя класса поставщика — это полное имя конкретного класса MIDI device provider. Имя устройства сопоставляется с именем устройства, возвращаемым методом getName объекта MidiDevice.Info. Можно опустить либо имя класса, либо имя устройства. Если указано только имя класса, то конечный знак решетки является необязательным.

Если указан класс поставщика и он может быть успешно извлечен из установленных поставщиков, список объектов MidiDevice.Info извлекается из поставщика. В противном случае, или когда эти устройства не обеспечивают последующего соответствия, список извлекается из getMidiDeviceInfo() для включения всех доступных объектов MidiDevice.Info.

Если указано имя устройства, то полученный список объектов MidiDevice.Info просматривается: возвращается первый объект с соответствующим именем, чей MidiDevice реализует соответствующий интерфейс. Если подходящий объект MidiDevice.Info не найден или имя устройства не указано, возвращается первое подходящее устройство из полученного списка. Для секвенсора и синтезатора устройство подходит, если оно реализует соответствующий интерфейс; для приёмника и передатчика устройство подходит, если оно не реализует ни секвенсор, ни синтезатор и предоставляет по крайней мере одного приёмника или передатчика соответственно. Например, свойство javax.sound.midi.Receiver со значением "com.sun.media.sound.MidiProvider#SunMIDI1" при вызове getReceiver будет иметь следующие последствия: если класс com.sun.media.sound.MidiProvider существует в списке установленных поставщиков MIDI-устройств, возвращается первое устройство Receiver с именем "SunMIDI1". Если его нельзя найти, возвращается первое устройство Receiver из этого поставщика, независимо от имени. Если его нет, возвращается первое устройство Receiver с именем "SunMIDI1" в списке всех устройств (как возвращается getMidiDeviceInfo), или, если не найдено, первое устройство Receiver которое можно найти в списке всех устройств. Если и это не удается, выбрасывается исключение MidiUnavailableException.

Методы

getMidiDeviceInfo

public static MidiDevice.Info[] getMidiDeviceInfo()

Получает массив объектов информации, представляющих все устройства MIDI, доступные в системе. Возвращаемый объект информации можно использовать для получения соответствующего объекта устройства, вызвав getMidiDevice.

Возвращает:

массив MidiDevice.Info объектов, по одному для каждого установленного устройства MIDI. Если такие устройства не установлены, возвращается массив длиной 0.

getMidiDevice

public static MidiDevice getMidiDevice(MidiDevice.Info info)
                                throws MidiUnavailableException

Получает запрашиваемое устройство MIDI.

Параметры:

info - объект информации об устройстве, представляющий желаемое устройство.

Возвращает:

запрашиваемое устройство

Выбрасывает:

MidiUnavailableException - если запрашиваемое устройство недоступно из-за ограничений ресурсов

IllegalArgumentException - если объект info не представляет установленное в системе устройство MIDI

См. также:

getMidiDeviceInfo()

getReceiver

public static Receiver getReceiver()
                            throws MidiUnavailableException

Возвращает:

приемник MIDI по умолчанию

Выбрасывает:

MidiUnavailableException - если приемник по умолчанию недоступен из-за ограничений ресурсов или нет устройства, предоставляющего приемники, установленного в системе

getTransmitter

public static Transmitter getTransmitter()
                                  throws MidiUnavailableException

Возвращает:

передатчик MIDI по умолчанию

Выбрасывает:

MidiUnavailableException - если передатчик по умолчанию недоступен из-за ограничений ресурсов или нет устройства, предоставляющего передатчики, установленного в системе

getSynthesizer

public static Synthesizer getSynthesizer()
                                  throws MidiUnavailableException

Возвращает:

синтезатор по умолчанию

Выбрасывает:

MidiUnavailableException - если синтезатор недоступен из-за ограничений ресурсов или нет синтезатора, установленного в системе

getSequencer

public static Sequencer getSequencer()
                              throws MidiUnavailableException

Возвращает:

секвенсор по умолчанию, подключенный к приемнику по умолчанию

Выбрасывает:

MidiUnavailableException - если секвенсор недоступен из-за ограничений ресурсов, или нет Receiver, доступного ни одним установленным MidiDevice, или секвенсор не установлен в системе.

См. также:

getSequencer(boolean), getSynthesizer(), getReceiver()

getSequencer

public static Sequencer getSequencer(boolean connected)
                              throws MidiUnavailableException

Параметры:

connected - подключать ли возвращаемый Sequencer к Synthesizer по умолчанию

Возвращает:

секвенсор по умолчанию

Выбрасывает:

MidiUnavailableException - если секвенсор недоступен из-за ограничений ресурсов или секвенсор не установлен в системе, или если connected равно true, и Receiver недоступно ни одним установленным MidiDevice

С:

1.5

См. также:

getSynthesizer(), getReceiver()

getSoundbank

public static Soundbank getSoundbank(InputStream stream)
                              throws InvalidMidiDataException,
                                     IOException

Создает звуковую библиотеку MIDI, считывая ее из указанного потока. Поток должен указывать на действительный звуковой файл MIDI. В общем случае поставщикам звуковых библиотек MIDI может потребоваться прочитать некоторые данные из потока, прежде чем определить, поддерживают ли они его. Эти парсеры должны уметь помечать поток, читать достаточное количество данных, чтобы определить, поддерживают ли они поток, и, если нет, сбросить указатель чтения потока в его исходное положение. Если входной поток не поддерживает это, этот метод может завершиться ошибкой IOException.

Параметры:

stream - источник данных звуковой библиотеки.

Возвращает:

звуковую библиотеку

Выбрасывает:

InvalidMidiDataException - если поток не указывает на действительные данные звуковой библиотеки MIDI, распознанные системой

IOException - если при загрузке звуковой библиотеки произошла ошибка ввода-вывода

См. также:

InputStream.markSupported(), InputStream.mark(int)

getSoundbank

public static Soundbank getSoundbank(URL url)
                              throws InvalidMidiDataException,
                                     IOException

Создает звуковую библиотеку Soundbank , считывая ее из указанного URL. URL должен указывать на действительный звуковой файл MIDI.

Параметры:

url - источник данных звуковой библиотеки

Возвращает:

звуковую библиотеку

Выбрасывает:

InvalidMidiDataException - если URL не указывает на действительные данные звуковой библиотеки MIDI, распознанные системой

IOException - если при загрузке звуковой библиотеки произошла ошибка ввода-вывода

getSoundbank

public static Soundbank getSoundbank(File file)
                              throws InvalidMidiDataException,
                                     IOException

Создает звуковую библиотеку Soundbank , считывая ее из указанного файла. Файл должен указывать на действительный звуковой файл MIDI.

Параметры:

file - источник данных звуковой библиотеки

Возвращает:

звуковую библиотеку

Выбрасывает:

InvalidMidiDataException - если файл не указывает на действительные данные звуковой библиотеки MIDI, распознанные системой

IOException - если при загрузке звуковой библиотеки произошла ошибка ввода-вывода

getMidiFileFormat

public static MidiFileFormat getMidiFileFormat(InputStream stream)
                                        throws InvalidMidiDataException,
                                               IOException

Параметры:

stream - поток ввода, из которого должна быть извлечена информация о формате файла

Возвращает:

объект MidiFileFormat, описывающий формат MIDI-файла

Исключения:

InvalidMidiDataException - если поток не указывает на данные действительного MIDI-файла, распознаваемые системой

IOException - если при доступе к потоку произошла ошибка ввода-вывода

См. также:

getMidiFileFormat(URL), getMidiFileFormat(File), InputStream.markSupported(), InputStream.mark(int)

getMidiFileFormat

public static MidiFileFormat getMidiFileFormat(URL url)
                                        throws InvalidMidiDataException,
                                               IOException

Параметры:

url - URL-адрес, из которого должна быть извлечена информация о формате файла

Возвращает:

объект MidiFileFormat, описывающий формат MIDI-файла

Исключения:

InvalidMidiDataException - если URL-адрес не указывает на данные действительного MIDI-файла, распознаваемые системой

IOException - если при доступе к URL-адресу произошла ошибка ввода-вывода

См. также:

getMidiFileFormat(InputStream), getMidiFileFormat(File)

getMidiFileFormat

public static MidiFileFormat getMidiFileFormat(File file)
                                        throws InvalidMidiDataException,
                                               IOException

Параметры:

file - File, из которого должна быть извлечена информация о формате файла

Возвращает:

объект MidiFileFormat, описывающий формат MIDI-файла

Исключения:

InvalidMidiDataException - если File не указывает на данные действительного MIDI-файла, распознаваемые системой

IOException - если при доступе к файлу произошла ошибка ввода-вывода

См. также:

getMidiFileFormat(InputStream), getMidiFileFormat(URL)

getSequence

public static Sequence getSequence(InputStream stream)
                            throws InvalidMidiDataException,
                                   IOException

Параметры:

stream - поток ввода, из которого должна быть построена Sequence

Возвращает:

объект Sequence, основанный на данных MIDI-файла, содержащихся в потоке ввода

Исключения:

InvalidMidiDataException - если поток не указывает на данные действительного MIDI-файла, распознаваемые системой

IOException - если при доступе к потоку произошла ошибка ввода-вывода

См. также:

InputStream.markSupported(), InputStream.mark(int)

getSequence

public static Sequence getSequence(URL url)
                            throws InvalidMidiDataException,
                                   IOException

Параметры:

url - URL-адрес, из которого должна быть построена Sequence

Возвращает:

объект Sequence, основанный на данных MIDI-файла, указанных в URL-адресе

Исключения:

InvalidMidiDataException - если URL-адрес не указывает на данные действительного MIDI-файла, распознаваемые системой

IOException - если при доступе к URL-адресу произошла ошибка ввода-вывода

getSequence

public static Sequence getSequence(File file)
                            throws InvalidMidiDataException,
                                   IOException

Параметры:

file - File, из которого должна быть построена Sequence

Возвращает:

объект Sequence, основанный на данных MIDI-файла, указанных в файле

Исключения:

InvalidMidiDataException - если файл не указывает на данные действительного MIDI-файла, распознаваемые системой

IOException - если произошла ошибка ввода-вывода

getMidiFileTypes

public static int[] getMidiFileTypes()

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

Возвращает:

массив уникальных типов файлов. Если типы файлов не поддерживаются, возвращается массив длины 0.

isFileTypeSupported

public static boolean isFileTypeSupported(int fileType)

Указывает, предоставляется ли системой поддержка записи файлов для указанного типа MIDI-файла.

Параметры:

fileType - тип файла, для которого запрашиваются возможности записи

Возвращает:

true если тип файла поддерживается, иначе false

getMidiFileTypes

public static int[] getMidiFileTypes(Sequence sequence)

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

Параметры:

sequence - последовательность, для которой запрашивается поддержка типа MIDI-файла

Возвращает:

набор уникальных поддерживаемых типов файлов. Если типы файлов не поддерживаются, возвращается массив длиной 0.

isFileTypeSupported

public static boolean isFileTypeSupported(int fileType,
                                          Sequence sequence)

Указывает, может ли MIDI-файл указанного типа быть записан из указанной последовательности.

Параметры:

fileType - тип файла, для которого запрашиваются возможности записи

sequence - последовательность, для которой запрашивается поддержка записи файла

Возвращает:

true если тип файла поддерживается для этой последовательности, иначе false

write

public static int write(Sequence in,
                        int fileType,
                        OutputStream out)
                 throws IOException

Записывает поток байтов, представляющий файл указанного типа MIDI-файла, в предоставленный поток вывода.

Параметры:

in - последовательность, содержащая MIDI-данные, которые должны быть записаны в файл

fileType - тип файла, который должен быть записан в поток вывода

out - поток, в который должны быть записаны данные файла

Возвращает:

количество байтов, записанных в поток вывода

Исключения:

IOException - если произошла ошибка ввода-вывода

IllegalArgumentException - если формат файла не поддерживается системой

См. также:

isFileTypeSupported(int, Sequence), getMidiFileTypes(Sequence)

write

public static int write(Sequence in,
                        int type,
                        File out)
                 throws IOException

Записывает поток байтов, представляющий файл указанного типа MIDI-файла, в предоставленный внешний файл.

Параметры:

in - последовательность, содержащая данные MIDI, которые должны быть записаны в файл

type - тип файла, который должен быть записан в выходной поток

out - внешний файл, в который должны быть записаны данные файла

Возвращает:

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

Исключения:

IOException - если происходит исключение ввода-вывода

IllegalArgumentException - если тип файла не поддерживается системой

См. также:

isFileTypeSupported(int, Sequence), getMidiFileTypes(Sequence)