Spec-Zone.ru › OpenJDK 21

Интерфейс Синтезатор

Все суперинтерфейсы:
AutoCloseable, MidiDevice
public interface Synthesizer extends MidiDevice
Синтезатор Synthesizer генерирует звук. Это обычно происходит, когда один из объектов Synthesizer MidiChannel получает сообщение noteOn, либо напрямую, либо через объект Synthesizer. Многие Synthesizer поддерживают Receivers, посредством которых события MIDI могут быть доставлены Synthesizer. В таких случаях Synthesizer обычно отвечает, отправляя соответствующее сообщение в соответствующий MidiChannel, или обрабатывая само событие, если оно не является сообщением канала MIDI.

Интерфейс Synthesizer включает методы для загрузки и выгрузки инструментов из звуковых банков. Инструмент представляет собой спецификацию для синтеза определенного типа звука, будь то имитация традиционного инструмента, какой-либо звуковой эффект или другой воображаемый звук. Звуковой банк представляет собой коллекцию инструментов, организованных по номеру банка и программе (через объект инструмента Patch). Разные классы Synthesizer могут реализовывать различные методы синтеза звука, что означает, что некоторые инструменты, а не другие, могут быть совместимы с данным синтезатором. Кроме того, синтезаторы могут иметь ограниченный объём памяти для инструментов, что означает, что не каждый звуковой банк и инструмент может быть использован каждым синтезатором, даже если методика синтеза совместима. Чтобы узнать, могут ли инструменты из определённого звукового банка воспроизводиться данным синтезатором, вызовите метод isSoundbankSupported объекта Synthesizer.

«Загрузка» инструмента означает, что этот инструмент становится доступным для синтеза нот. Инструмент загружается в указанную его объектом Patch позицию банка и программы. Загрузка не обязательно означает, что последующие воспроизведённые ноты сразу же будут иметь звук этого только что загруженного инструмента. Для воспроизведения нот инструментом один из объектов синтезатора MidiChannel должен получить (или уже получил) сообщение о смене программы, которое вызывает выбор банка и номера программы этого конкретного инструмента.

См. также:
  • MidiSystem.getSynthesizer()
  • Soundbank
  • Instrument
  • MidiChannel.programChange(int, int)
  • Receiver
  • Transmitter
  • MidiDevice

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в интерфейсе javax.sound.midi.MidiDevice

MidiDevice.Info

Краткое описание методов

Модификатор и тип Метод Описание
Instrument[] getAvailableInstruments()
Получает список инструментов, поставляемых с синтезатором.
MidiChannel[] getChannels()
Получает набор каналов MIDI, управляемых этим синтезатором.
Soundbank getDefaultSoundbank()
Получает стандартный звуковой банк для синтезатора, если он существует.
long getLatency()
Получает задержку обработки, производимую этим синтезатором, выраженную в микросекундах.
Instrument[] getLoadedInstruments()
Получает список инструментов, которые в данный момент загружены в этот Synthesizer.
int getMaxPolyphony()
Получает максимальное количество нот, которые этот синтезатор может воспроизводить одновременно.
VoiceStatus[] getVoiceStatus()
Получает текущий статус голосов, производимых этим синтезатором.
boolean isSoundbankSupported(Soundbank soundbank)
Уведомляет вызывающую сторону о том, способен ли этот синтезатор загружать инструменты из указанного звукового банка.
boolean loadAllInstruments(Soundbank soundbank)
Загружает все инструменты, содержащиеся в указанном Soundbank, в Synthesizer.
boolean loadInstrument(Instrument instrument)
Делает конкретный инструмент доступным для синтеза.
boolean loadInstruments(Soundbank soundbank, Patch[] patchList)
Загружает инструменты, на которые ссылаются указанные патчи, из указанного Soundbank.
boolean remapInstrument(Instrument from, Instrument to)
Переназначает инструмент.
void unloadAllInstruments(Soundbank soundbank)
Выгружает все инструменты, содержащиеся в указанном Soundbank.
void unloadInstrument(Instrument instrument)
Выгружает конкретный инструмент.
void unloadInstruments(Soundbank soundbank, Patch[] patchList)
Выгружает инструменты, на которые ссылаются указанные патчи, из указанного звукового банка MIDI.

Методы, объявленные в интерфейсе javax.sound.midi.MidiDevice

close, getDeviceInfo, getMaxReceivers, getMaxTransmitters, getMicrosecondPosition, getReceiver, getReceivers, getTransmitter, getTransmitters, isOpen, open

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

getMaxPolyphony

int getMaxPolyphony()
Получает максимальное количество нот, которые этот синтезатор может воспроизводить одновременно.
Возвращает:
максимальное количество одновременных нот
См. также:
  • getVoiceStatus()

getLatency

long getLatency()
Получает задержку обработки, вносимую этим синтезатором, выраженную в микросекундах. Эта задержка измеряет максимальную задержку между моментом передачи сообщения MIDI синтезатору и моментом, когда синтезатор фактически производит соответствующий результат.

Несмотря на то, что задержка выражается в микросекундах, фактическая измеренная задержка синтезатора может варьироваться в более широком диапазоне, чем предполагает эта точность. Например, синтезатор может иметь максимальную задержку в несколько миллисекунд или более.

Возвращает:
максимальную задержку в микросекундах

getChannels

MidiChannel[] getChannels()
Получает набор каналов MIDI, контролируемых этим синтезатором. Каждый ненулевой элемент в возвращаемом массиве является MidiChannel, который получает сообщения MIDI, отправленные на этом номере канала.

Спецификация MIDI 1.0 предусматривает 16 каналов, поэтому этот метод возвращает массив из как минимум 16 элементов. Однако, если этот синтезатор не использует все 16 каналов, некоторые элементы массива могут быть null, поэтому вы должны проверить каждый элемент перед его использованием.

Возвращает:
массив объектов MidiChannel, управляемых этим Synthesizer. Некоторые элементы массива могут быть null.

getVoiceStatus

VoiceStatus[] getVoiceStatus()
Получает текущий статус голосов, производимых этим синтезатором. Если этот класс Synthesizer не предоставляет информацию о голосах, возвращаемый массив всегда будет длиной 0. В противном случае его длина всегда равна общему количеству голосов, как возвращается getMaxPolyphony(). (См. описание класса VoiceStatus для объяснения голосов синтезатора.)
Возвращает:
массив объектов VoiceStatus , предоставляющих информацию о соответствующих голосах синтезатора
См. также:
  • getMaxPolyphony()
  • VoiceStatus

isSoundbankSupported

boolean isSoundbankSupported(Soundbank soundbank)
Сообщает вызывающей стороне, может ли этот синтезатор загружать инструменты из указанного звукового банка. Если звуковой банк не поддерживается, любые попытки загрузить инструменты из него приведут к IllegalArgumentException.
Параметры:
soundbank - звуковой банк, для которого запрашивается поддержка
Возвращает:
true если звуковой банк поддерживается, в противном случае false
См. также:
  • loadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])
  • loadAllInstruments(javax.sound.midi.Soundbank)
  • unloadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])
  • unloadAllInstruments(javax.sound.midi.Soundbank)
  • getDefaultSoundbank()

loadInstrument

boolean loadInstrument(Instrument instrument)
Делает определенный инструмент доступным для синтеза. Этот инструмент загружается в место патча, указанное его объектом Patch , так что если получено (или было получено) сообщение о смене программы, которое приводит к выбору этого патча, последующие ноты будут воспроизводиться с помощью звука instrument. Если указанный инструмент уже загружен, этот метод ничего не делает и возвращает true.

Инструмент должен быть частью звукового банка, который поддерживается этим Synthesizer. (Чтобы убедиться, можно использовать метод getSoundbank объекта Instrument и метод isSoundbankSupported объекта Synthesizer.)

Параметры:
instrument - инструмент для загрузки
Возвращает:
true если инструмент успешно загружен (или уже был загружен), false если инструмент не удалось загрузить (например, если у синтезатора недостаточно памяти для его загрузки)
Исключения:
IllegalArgumentException - если этот Synthesizer не поддерживает звуковой банк указанного инструмента
См. также:
  • unloadInstrument(javax.sound.midi.Instrument)
  • loadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])
  • loadAllInstruments(javax.sound.midi.Soundbank)
  • remapInstrument(javax.sound.midi.Instrument, javax.sound.midi.Instrument)
  • SoundbankResource.getSoundbank()
  • MidiChannel.programChange(int, int)

unloadInstrument

void unloadInstrument(Instrument instrument)
Выгружает определенный инструмент.
Параметры:
instrument - инструмент для выгрузки
Исключения:
IllegalArgumentException - если этот Synthesizer не поддерживает звуковой банк указанного инструмента
См. также:
  • loadInstrument(javax.sound.midi.Instrument)
  • unloadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])
  • unloadAllInstruments(javax.sound.midi.Soundbank)
  • getLoadedInstruments()
  • remapInstrument(javax.sound.midi.Instrument, javax.sound.midi.Instrument)

remapInstrument

boolean remapInstrument(Instrument from, Instrument to)
Переназначение инструмента. Инструмент to заменяет инструмент from.
Например, если from находился в банке 2, программе 11, переназначение приводит к тому, что это место банка и программы вместо этого займет to.
Если функция выполнена успешно, инструмент from выгружается.

Чтобы отменить переназначение, загрузите инструмент from, вызвав один из loadInstrument(javax.sound.midi.Instrument), loadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[]) или loadAllInstruments(javax.sound.midi.Soundbank).

Параметры:
from - объект инструмента, который нужно заменить
to - объект инструмента, который нужно использовать вместо старого, он должен быть загружен в синтезатор
Возвращает:
true если инструмент успешно переназначен, false если функция не реализована синтезатором
Исключения:
IllegalArgumentException - если инструмент from или инструмент to не поддерживаются синтезатором или если инструмент to не загружен
NullPointerException - если параметры from или to имеют нулевое значение
См. также:
  • loadInstrument(javax.sound.midi.Instrument)
  • loadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])
  • loadAllInstruments(javax.sound.midi.Soundbank)

getDefaultSoundbank

Soundbank getDefaultSoundbank()
Получает стандартный звуковой банк для синтезатора, если он существует. (Некоторые синтезаторы предоставляют стандартный или встроенный звуковой банк.) Если у синтезатора нет стандартного звукового банка, инструменты необходимо загружать явно из внешнего звукового банка.
Возвращает:
стандартный звуковой банк или null если он не существует
См. также:
  • isSoundbankSupported(javax.sound.midi.Soundbank)

getAvailableInstruments

Instrument[] getAvailableInstruments()
Получает список инструментов, поставляемых с синтезатором. Эти инструменты могут быть встроенными в синтезатор, или они могут быть частью стандартного звукового банка, поставляемого с синтезатором, и т. д.

Обратите внимание, что вы не используете этот метод для определения того, какие инструменты в настоящее время загружены в синтезатор; для этой цели вы используете getLoadedInstruments(). Метод также не показывает все инструменты, которые могут быть загружены в синтезатор; он указывает только подмножество, поставляемое с синтезатором. Чтобы узнать, может ли быть загружен другой инструмент, можно вызвать isSoundbankSupported(), и если звуковой банк инструмента поддерживается, можно попробовать загрузить инструмент.

Возвращает:
список доступных инструментов. Если синтезатор не поставляется с инструментами, возвращается массив длиной 0.
См. также:
  • getLoadedInstruments()
  • isSoundbankSupported(Soundbank)
  • loadInstrument(javax.sound.midi.Instrument)

getLoadedInstruments

Instrument[] getLoadedInstruments()
Получает список инструментов, загруженных в данный Synthesizer.
Возвращает:
список загруженных инструментов
См. также:
  • loadInstrument(javax.sound.midi.Instrument)
  • getAvailableInstruments()
  • Soundbank.getInstruments()

loadAllInstruments

boolean loadAllInstruments(Soundbank soundbank)
Загружает все инструменты, содержащиеся в указанном Soundbank в Synthesizer.
Параметры:
soundbank - Soundbank, инструменты которого необходимо загрузить
Возвращает:
true если все инструменты успешно загружены (или уже были загружены), false если какой-либо инструмент не удалось загрузить (например, из-за недостаточной памяти у Synthesizer)
Исключения:
IllegalArgumentException - если указанный звуковой банк несовместим с данным синтезатором
См. также:
  • isSoundbankSupported(javax.sound.midi.Soundbank)
  • loadInstrument(javax.sound.midi.Instrument)
  • loadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])

unloadAllInstruments

void unloadAllInstruments(Soundbank soundbank)
Выгружает все инструменты, содержащиеся в указанном Soundbank.
Параметры:
soundbank - звуковой банк, содержащий инструменты для выгрузки
Исключения:
IllegalArgumentException - выбрасывается, если звуковой банк не поддерживается
См. также:
  • isSoundbankSupported(javax.sound.midi.Soundbank)
  • unloadInstrument(javax.sound.midi.Instrument)
  • unloadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])

loadInstruments

boolean loadInstruments(Soundbank soundbank, Patch[] patchList)
Загружает инструменты, на которые ссылаются указанные патчи, из указанного Soundbank. Каждый из Patch объектов указывает номер банка и программы; загружается инструмент, имеющий соответствующий Patch, в это место банка и программы.
Параметры:
soundbank - Soundbank, содержащий инструменты для загрузки
patchList - список патчей, для которых необходимо загрузить инструменты
Возвращает:
true если все инструменты успешно загружены (или уже были загружены), false если какой-либо инструмент не удалось загрузить (например, из-за недостаточной памяти у Synthesizer)
Исключения:
IllegalArgumentException - выбрасывается, если звуковой банк не поддерживается
См. также:
  • isSoundbankSupported(javax.sound.midi.Soundbank)
  • Instrument.getPatch()
  • loadAllInstruments(javax.sound.midi.Soundbank)
  • loadInstrument(javax.sound.midi.Instrument)
  • Soundbank.getInstrument(Patch)
  • Sequence.getPatchList()

unloadInstruments

void unloadInstruments(Soundbank soundbank, Patch[] patchList)
Выгружает инструменты, на которые ссылаются указанные патчи, из указанного звукового банка MIDI.
Параметры:
soundbank - звуковой банк, содержащий инструменты для выгрузки
patchList - список патчей, для которых необходимо выгрузить инструменты
Исключения:
IllegalArgumentException - выбрасывается, если звуковой банк не поддерживается
См. также:
  • unloadInstrument(javax.sound.midi.Instrument)
  • unloadAllInstruments(javax.sound.midi.Soundbank)
  • isSoundbankSupported(javax.sound.midi.Soundbank)
  • Instrument.getPatch()
  • loadInstruments(javax.sound.midi.Soundbank, javax.sound.midi.Patch[])

© 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/Synthesizer.html

Spec-Zone.ru

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