Класс AudioFileFormat

java.lang.Object
- javax.sound.sampled.AudioFileFormat

public class AudioFileFormat
extends Object

Экземпляр класса AudioFileFormat описывает аудиофайл, включая тип файла, длину файла в байтах, длину аудиоданных в файле в образцах-кадрах и формат аудиоданных.

Класс AudioSystem содержит методы для определения формата аудиофайла, получения потока аудиоввода из аудиофайла и записи аудиофайла из потока аудиоввода.

Объект AudioFileFormat может содержать набор свойств. Свойство — это пара ключ-значение: ключ типа String, а связанное значение свойства — произвольный объект. Свойства задают дополнительную метаданную информацию (например, автор, авторские права или продолжительность файла). Свойства — необязательная информация, и реализации читателя и писателя файлов не обязаны предоставлять или распознавать свойства.

В следующей таблице перечислены некоторые распространённые свойства, которые должны использоваться в реализациях:

Ключ свойства	Тип значения	Описание
"duration"	`Long`	Продолжительность воспроизведения файла в микросекундах
"author"	`String`	Имя автора этого файла
"title"	`String`	Название этого файла
"copyright"	`String`	Сообщение об авторских правах
"date"	`Date`	Дата записи или выпуска
"comment"	`String`	Произвольный текст

С момента:: 1.3
См. также:: AudioInputStream

Вложенные классы

Модификатор и тип	Класс	Описание
`static class`	`AudioFileFormat.Type`	Экземпляр класса `Type` представляет один из стандартных типов аудиофайла.

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

Модификатор	Конструктор	Описание
`protected`	`AudioFileFormat(AudioFileFormat.Type type, int byteLength, AudioFormat format, int frameLength)`	Создаёт объект формата аудиофайла.
	`AudioFileFormat(AudioFileFormat.Type type, AudioFormat format, int frameLength)`	Создаёт объект формата аудиофайла.
	`AudioFileFormat(AudioFileFormat.Type type, AudioFormat format, int frameLength, Map<String,Object> properties)`	Создаёт объект формата аудиофайла с заданным набором свойств.

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

Модификатор и тип	Метод	Описание
`int`	`getByteLength()`	Возвращает размер всего аудиофайла в байтах (а не только аудиоданных).
`AudioFormat`	`getFormat()`	Возвращает формат аудиоданных, содержащихся в аудиофайле.
`int`	`getFrameLength()`	Возвращает длину аудиоданных, содержащихся в файле, в образцах-кадрах.
`Object`	`getProperty(String key)`	Получает значение свойства, указанное ключом.
`AudioFileFormat.Type`	`getType()`	Получает тип аудиофайла, например, `WAVE` или `AU`.
`Map<String,Object>`	`properties()`	Получает неизменяемую карту свойств.
`String`	`toString()`	Возвращает строковое представление формата файла.

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

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

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

AudioFileFormat

protected AudioFileFormat(AudioFileFormat.Type type,
                          int byteLength,
                          AudioFormat format,
                          int frameLength)

Создаёт объект формата аудиофайла. Этот защищённый конструктор предназначен для использования поставщиками служб чтения файлов при возврате информации об аудиофайле или о поддерживаемых форматах аудиофайлов.

Параметры:: type - тип аудиофайла; byteLength - длина файла в байтах или AudioSystem.NOT_SPECIFIED; format - формат аудиоданных, содержащихся в файле; frameLength - длина аудиоданных в образцах-кадрах или AudioSystem.NOT_SPECIFIED
См. также:: getType()

AudioFileFormat

public AudioFileFormat(AudioFileFormat.Type type,
                       AudioFormat format,
                       int frameLength)

Создаёт объект формата аудиофайла. Этот общедоступный конструктор может использоваться приложениями для описания свойств запрошенного аудиофайла.

Параметры:: type - тип аудиофайла; format - формат аудиоданных, содержащихся в файле; frameLength - длина аудиоданных в образцах-кадрах или AudioSystem.NOT_SPECIFIED

AudioFileFormat

public AudioFileFormat(AudioFileFormat.Type type,
                       AudioFormat format,
                       int frameLength,
                       Map<String,Object> properties)

Создаёт объект формата аудиофайла с заданным набором свойств. Этот общедоступный конструктор может использоваться приложениями для описания свойств запрошенного аудиофайла. Карта свойств будет скопирована, чтобы предотвратить любые изменения в ней.

Параметры:: type - тип аудиофайла; format - формат аудиоданных, содержащихся в файле; frameLength - длина аудиоданных в образцах-кадрах или AudioSystem.NOT_SPECIFIED; properties - объект Map<String, Object> со свойствами
С момента:: 1.5

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

getType

public AudioFileFormat.Type getType()

Получает тип аудиофайла, например, WAVE или AU.

Возвращает:: тип аудиофайла
См. также:: AudioFileFormat.Type.WAVE, AudioFileFormat.Type.AU, AudioFileFormat.Type.AIFF, AudioFileFormat.Type.AIFC, AudioFileFormat.Type.SND

getByteLength

public int getByteLength()

Возвращает размер всего аудиофайла в байтах (а не только аудиоданных).

Возвращает:: длину аудиофайла в байтах
См. также:: AudioSystem.NOT_SPECIFIED

getFormat

public AudioFormat getFormat()

Возвращает формат аудиоданных, содержащихся в аудиофайле.

Возвращает:: формат аудиоданных

getFrameLength

public int getFrameLength()

Возвращает длину аудиоданных, содержащихся в файле, в образцах-кадрах.

Возвращает:: количество образцов-кадров аудиоданных в файле
См. также:: AudioSystem.NOT_SPECIFIED

properties

public Map<String,Object> properties()

Получает неизменяемую карту свойств. Концепция свойств более подробно описана в class description.

Возвращает:: объект Map<String, Object>, содержащий все свойства. Если свойства не распознаны, возвращается пустая карта.
С момента:: 1.5
См. также:: getProperty(String)

getProperty

public Object getProperty(String key)

Получает значение свойства, указанное ключом. Концепция свойств более подробно описана в class description.

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

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

toString

public String toString()

Возвращает строковое представление формата файла.

Переопределяет:: toString в классе Object
Возвращает:: формат файла в виде строки