Класс MidiFileWriter

java.lang.Object

javax.sound.midi.spi.MidiFileWriter

public abstract class MidiFileWriter extends Object

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

Since:: 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 указанного типа, в предоставленный поток вывода.

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

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

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

MidiFileWriter

protected MidiFileWriter()

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

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

getMidiFileTypes

public abstract int[] getMidiFileTypes()

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

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

getMidiFileTypes

public abstract int[] getMidiFileTypes(Sequence sequence)

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

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

isFileTypeSupported

public boolean isFileTypeSupported(int fileType)

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

Parameters:: fileType - тип файла, для которого запрашиваются возможности записи
Returns:: true если тип файла поддерживается, в противном случае false

isFileTypeSupported

public boolean isFileTypeSupported(int fileType, Sequence sequence)

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

Parameters:: fileType - тип файла, для которого запрашиваются возможности записи; sequence - последовательность, для которой запрашивается поддержка записи файла
Returns:: true если тип файла поддерживается для этой последовательности, в противном случае false
Throws:: NullPointerException - если sequence является null

write

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

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

Parameters:

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

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

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

Returns:

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

Throws:

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

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

NullPointerException - если in или out являются null

See Also:

isFileTypeSupported(int, Sequence)
getMidiFileTypes(Sequence)

write

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

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

Parameters:

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

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

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

Returns:

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

Throws:

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

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

NullPointerException - если in или out являются null

See Also:

isFileTypeSupported(int, Sequence)
getMidiFileTypes(Sequence)

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