Класс MidiFileWriter

java.lang.Object

javax.sound.midi.spi.MidiFileWriter

public abstract class MidiFileWriter extends Object

MidiFileWriter предоставляет службы записи MIDI-файлов. Классы, реализующие этот интерфейс, могут записывать один или несколько типов MIDI-файлов из объекта Sequence.

Начиная с:: 1.3

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

MidiFileWriter()

Модификатор	Конструктор	Описание
`protected`	Конструктор для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`abstract int[]`	`getMidiFileTypes()`	Получает набор типов MIDI-файлов, для которых этот модуль записи поддерживает запись файлов.
`abstract int[]`	`getMidiFileTypes(Sequence sequence)`	Получает типы файлов, которые этот модуль записи может записывать из указанной последовательности.
`boolean`	`isFileTypeSupported(int fileType)`	Указывает, поддерживает ли этот модуль записи запись файлов указанного типа MIDI-файла.
`boolean`	`isFileTypeSupported(int fileType, Sequence sequence)`	Указывает, можно ли записать MIDI-файл указанного типа из указанной последовательности.
`abstract int`	`write(Sequence in, int fileType, File out)`	Записывает в предоставленный внешний файл поток байтов, представляющий MIDI-файл указанного типа.
`abstract int`	`write(Sequence in, int fileType, OutputStream out)`	Записывает в предоставленный выходной поток поток байтов, представляющий MIDI-файл указанного типа.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли другой объект этому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого объекта `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать, пока он не будет пробужден, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать, пока он не будет пробужден, обычно посредством уведомления или прерывания, либо пока не истечет заданное время.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать, пока он не будет пробужден, обычно посредством уведомления или прерывания, либо пока не истечет заданное время.

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

MidiFileWriter

protected MidiFileWriter()

Конструктор для вызова подклассами.

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

getMidiFileTypes

public abstract int[] getMidiFileTypes()

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

Возвращает:: массив типов файлов. Если ни один тип файла не поддерживается, возвращается массив длины 0.

getMidiFileTypes

public abstract int[] getMidiFileTypes(Sequence sequence)

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

Параметры:: sequence — последовательность, для которой запрашивается поддержка типов MIDI-файлов
Возвращает:: массив типов файлов. Если ни один тип файла не поддерживается, возвращается массив длины 0.
Вызывает:: NullPointerException — если sequence равно null

isFileTypeSupported

public boolean isFileTypeSupported(int fileType)

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

Параметры:: fileType — тип файла, для которого запрашиваются возможности записи
Возвращает:: true, если тип файла поддерживается; в противном случае — false

isFileTypeSupported

public boolean isFileTypeSupported(int fileType, Sequence sequence)

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

Параметры:: fileType — тип файла, для которого запрашиваются возможности записи; sequence — последовательность, для которой запрашивается поддержка записи файлов
Возвращает:: true, если тип файла поддерживается для этой последовательности; в противном случае — false
Вызывает:: NullPointerException — если sequence равно null

write

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

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

Параметры:

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

fileType — тип файла, который требуется записать в выходной поток

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

Возвращает:

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

Вызывает:

IOException — если возникает исключение ввода-вывода

IllegalArgumentException — если этот модуль записи не поддерживает данный тип файла

NullPointerException — если in или out равны null

См. также:

write

public abstract int write(Sequence in, int fileType, File out) throws IOException

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

Параметры:

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

fileType — тип файла, который требуется записать во внешний файл

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