Класс 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` представляет один из стандартных типов аудиофайла.

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

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

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

Модификатор и тип	Метод и описание
`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
Возвращает:: формат файла в виде строки

© 1993, 2020, 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.