File	Doc	Category	Size	Date	Package
AudioFileFormat.java	API Doc	Java SE 5 API	10505	Fri Aug 26 14:57:50 BST 2005	javax.sound.sampled

AudioFileFormat

• java.lang.Object

Fields Summary
private Type	type File type.
private int	byteLength File length in bytes
private AudioFormat	format Format of the audio data contained in the file.
private int	frameLength Audio data length in sample frames
private HashMap	properties The set of properties

Constructors Summary
protected AudioFileFormat(Type type, int byteLength, AudioFormat format, int frameLength) Constructs an audio file format object. This protected constructor is intended for use by providers of file-reading services when returning information about an audio file or about supported audio file formats. param type the type of the audio file param byteLength the length of the file in bytes, or AudioSystem.NOT_SPECIFIED param format the format of the audio data contained in the file param frameLength the audio data length in sample frames, or AudioSystem.NOT_SPECIFIED see #getType this.type = type; this.byteLength = byteLength; this.format = format; this.frameLength = frameLength; this.properties = null;
public AudioFileFormat(Type type, AudioFormat format, int frameLength) Constructs an audio file format object. This public constructor may be used by applications to describe the properties of a requested audio file. param type the type of the audio file param format the format of the audio data contained in the file param frameLength the audio data length in sample frames, or AudioSystem.NOT_SPECIFIED this(type,AudioSystem.NOT_SPECIFIED,format,frameLength);
public AudioFileFormat(Type type, AudioFormat format, int frameLength, Map properties) Construct an audio file format object with a set of defined properties. This public constructor may be used by applications to describe the properties of a requested audio file. The properties map will be copied to prevent any changes to it. param type the type of the audio file param format the format of the audio data contained in the file param frameLength the audio data length in sample frames, or AudioSystem.NOT_SPECIFIED param properties a Map<String,Object> object with properties since 1.5 this(type,AudioSystem.NOT_SPECIFIED,format,frameLength); this.properties = new HashMap<String, Object>(properties);

Methods Summary
public int	getByteLength() Obtains the size in bytes of the entire audio file (not just its audio data). return the audio file length in bytes see AudioSystem#NOT_SPECIFIED return byteLength;
public javax.sound.sampled.AudioFormat	getFormat() Obtains the format of the audio data contained in the audio file. return the audio data format return format;
public int	getFrameLength() Obtains the length of the audio data contained in the file, expressed in sample frames. return the number of sample frames of audio data in the file see AudioSystem#NOT_SPECIFIED return frameLength;
public java.lang.Object	getProperty(java.lang.String key) Obtain the property value specified by the key. The concept of properties is further explained in the {@link AudioFileFormat class description}. If the specified property is not defined for a particular file format, this method returns null. param key the key of the desired property return the value of the property with the specified key, or null if the property does not exist. see #properties since 1.5 if (properties == null) { return null; } return properties.get(key);
public javax.sound.sampled.AudioFileFormat$Type	getType() Obtains the audio file type, such as WAVE or AU. return the audio file type see Type#WAVE see Type#AU see Type#AIFF see Type#AIFC see Type#SND return type;
public java.util.Map	properties() Obtain an unmodifiable map of properties. The concept of properties is further explained in the {@link AudioFileFormat class description}. return a Map<String,Object> object containing all properties. If no properties are recognized, an empty map is returned. see #getProperty(String) since 1.5 Map<String,Object> ret; if (properties == null) { ret = new HashMap<String,Object>(0); } else { ret = (Map<String,Object>) (properties.clone()); } return (Map<String,Object>) Collections.unmodifiableMap(ret);
public java.lang.String	toString() Provides a string representation of the file format. return the file format as a string StringBuffer buf = new StringBuffer(); //$$fb2002-11-01: fix for 4672864: AudioFileFormat.toString() throws unexpected NullPointerException if (type != null) { buf.append(type.toString() + " (." + type.getExtension() + ") file"); } else { buf.append("unknown file format"); } if (byteLength != AudioSystem.NOT_SPECIFIED) { buf.append(", byte length: " + byteLength); } buf.append(", data format: " + format); if (frameLength != AudioSystem.NOT_SPECIFIED) { buf.append(", frame length: " + frameLength); } return new String(buf);