Spec-Zone.ru › OpenJDK 17

Класс 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 Произвольный текст
Since:
1.3
See Also:
  • AudioInputStream

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

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

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

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)
Модификатор Конструктор Описание
protected
Создаёт объект формата аудиофайла.
Создаёт объект формата аудиофайла.
Создаёт объект формата аудиофайла с набором определенных свойств.

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

Модификатор и тип Метод Описание
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, 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/sampled/AudioFileFormat.html

Spec-Zone.ru

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