javax.sound.sampled

クラスAudioFileFormat

java.lang.Object

javax.sound.sampled.AudioFileFormat

public class AudioFileFormat
extends Object

AudioFileFormatクラスのインスタンスは、オーディオ・ファイルについて、ファイル・タイプ、バイト数で表されるファイルの長さ、ファイルに含まれるオーディオ・データのサンプル・フレーム数で表される長さ、オーディオ・データの形式などを記述します。

AudioSystemクラスには、オーディオ・ファイル形式の判別、オーディオ・ファイルからのオーディオ入力ストリームの取得、およびオーディオ入力ストリームからのオーディオ・ファイルの書出しを実行するメソッドが含まれます。

AudioFileFormatオブジェクトには、一式のプロパティを組み込むことができます。1つのプロパティは、キーと値のペアから成ります。キーは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)

オーディオ・ファイル形式オブジェクトを構築します。このprotectedコンストラクタは、オーディオ・ファイルまたはサポートされているオーディオ・ファイル形式に関する情報を返すときに、ファイル読込みサービスを行うプロバイダによって使用されます。

パラメータ:

type - オーディオ・ファイルのタイプ

byteLength - ファイルの長さ(バイト単位)か、AudioSystem.NOT_SPECIFIED

format - ファイルに含まれるオーディオ・データの形式

frameLength - サンプル・フレーム数で表されるオーディオ・データの長さ、またはAudioSystem.NOT_SPECIFIED

関連項目:

getType()

AudioFileFormat

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

オーディオ・ファイル形式オブジェクトを構築します。このpublicコンストラクタは、要求されたオーディオ・ファイルのプロパティを記述するためにアプリケーションで使用できます。

パラメータ:

type - オーディオ・ファイルのタイプ

format - ファイルに含まれるオーディオ・データの形式

frameLength - サンプル・フレーム数で表されるオーディオ・データの長さ、またはAudioSystem.NOT_SPECIFIED

AudioFileFormat

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

定義された一式のプロパティを使用して、オーディオ・ファイル形式オブジェクトを構築します。このpublicコンストラクタは、要求されたオーディオ・ファイルのプロパティを記述するためにアプリケーションで使用できます。プロパティ・マップは、変更できないようにするためにコピーされます。

パラメータ:

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つも認識されない場合は、空のマップが返される。

導入されたバージョン:

1.5

関連項目:

getProperty(String)

getProperty

public Object getProperty(String key)

キーによって指定されたプロパティ値を取得します。プロパティの概念の詳細は、class descriptionの説明を参照してください。

指定したプロパティが特定のファイル形式で定義されていない場合、このメソッドはnullを返します。

パラメータ:

key - 取得したいプロパティのキー

戻り値:

指定されたキーを持つプロパティの値、またはプロパティが存在しない場合はnull。

導入されたバージョン:

1.5

関連項目:

properties()

toString

public String toString()

ファイル形式の文字列表現を提供します。

オーバーライド:

toString、クラス: Object

戻り値:

文字列としてのファイル形式