Home » openjdk-7 » javax.sound » sampled » [javadoc | source]
javax.sound.sampled
public class: AudioSystem [javadoc | source]
java.lang.Object
   javax.sound.sampled.AudioSystem
The AudioSystem class acts as the entry point to the sampled-audio system resources. This class lets you query and access the mixers that are installed on the system. AudioSystem includes a number of methods for converting audio data between different formats, and for translating between audio files and streams. It also provides a method for obtaining a Line directly from the AudioSystem without dealing explicitly with mixers.

Properties can be used to specify the default mixer for specific line types. Both system properties and a properties file are considered. In the Oracle reference implementation, the properties file is "lib/sound.properties" in the JRE directory. If a property exists both as a system property and in the properties file, the system property takes precedence. If none is specified, a suitable default is chosen among the available devices. The syntax of the properties file is specified in Properties.load . The following table lists the available property keys and which methods consider them:
Property Key Interface Affected Method(s)
javax.sound.sampled.Clip Clip #getLine , #getClip
javax.sound.sampled.Port Port #getLine
javax.sound.sampled.SourceDataLine SourceDataLine #getLine , #getSourceDataLine
javax.sound.sampled.TargetDataLine TargetDataLine #getLine , #getTargetDataLine
The property value consists of the provider class name and the mixer name, separated by the hash mark ("#"). The provider class name is the fully-qualified name of a concrete mixer provider class. The mixer name is matched against the String returned by the getName method of Mixer.Info. Either the class name, or the mixer name may be omitted. If only the class name is specified, the trailing hash mark is optional.

If the provider class is specified, and it can be successully retrieved from the installed providers, the list of Mixer.Info objects is retrieved from the provider. Otherwise, or when these mixers do not provide a subsequent match, the list is retrieved from #getMixerInfo to contain all available Mixer.Info objects.

If a mixer name is specified, the resulting list of Mixer.Info objects is searched: the first one with a matching name, and whose Mixer provides the respective line interface, will be returned. If no matching Mixer.Info object is found, or the mixer name is not specified, the first mixer from the resulting list, which provides the respective line interface, will be returned. For example, the property javax.sound.sampled.Clip with a value "com.sun.media.sound.MixerProvider#SunClip" will have the following consequences when getLine is called requesting a Clip instance: if the class com.sun.media.sound.MixerProvider exists in the list of installed mixer providers, the first Clip from the first mixer with name "SunClip" will be returned. If it cannot be found, the first Clip from the first mixer of the specified provider will be returned, regardless of name. If there is none, the first Clip from the first Mixer with name "SunClip" in the list of all mixers (as returned by getMixerInfo) will be returned, or, if not found, the first Clip of the first Mixerthat can be found in the list of all mixers is returned. If that fails, too, an IllegalArgumentException is thrown.

Field Summary
public static final  int NOT_SPECIFIED    An integer that stands for an unknown numeric value. This value is appropriate only for signed quantities that do not normally take negative values. Examples include file sizes, frame sizes, buffer sizes, and sample rates. A number of Java Sound constructors accept a value of NOT_SPECIFIED for such parameters. Other methods may also accept or return this value, as documented. 
Method from javax.sound.sampled.AudioSystem Summary:
getAudioFileFormat,   getAudioFileFormat,   getAudioFileFormat,   getAudioFileTypes,   getAudioFileTypes,   getAudioInputStream,   getAudioInputStream,   getAudioInputStream,   getAudioInputStream,   getAudioInputStream,   getClip,   getClip,   getLine,   getMixer,   getMixerInfo,   getSourceDataLine,   getSourceDataLine,   getSourceLineInfo,   getTargetDataLine,   getTargetDataLine,   getTargetEncodings,   getTargetEncodings,   getTargetFormats,   getTargetLineInfo,   isConversionSupported,   isConversionSupported,   isFileTypeSupported,   isFileTypeSupported,   isLineSupported,   write,   write
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.sound.sampled.AudioSystem Detail:
 public static AudioFileFormat getAudioFileFormat(InputStream stream) throws UnsupportedAudioFileException, IOException 
    Obtains the audio file format of the provided input stream. The stream must point to valid audio file data. The implementation of this method may require multiple parsers to examine the stream to determine whether they support it. These parsers must be able to mark the stream, read enough data to determine whether they support the stream, and, if not, reset the stream's read pointer to its original position. If the input stream does not support these operations, this method may fail with an IOException.
 public static AudioFileFormat getAudioFileFormat(URL url) throws UnsupportedAudioFileException, IOException 
    Obtains the audio file format of the specified URL. The URL must point to valid audio file data.
 public static AudioFileFormat getAudioFileFormat(File file) throws UnsupportedAudioFileException, IOException 
    Obtains the audio file format of the specified File. The File must point to valid audio file data.
 public static Type[] getAudioFileTypes() 
    Obtains the file types for which file writing support is provided by the system.
 public static Type[] getAudioFileTypes(AudioInputStream stream) 
    Obtains the file types that the system can write from the audio input stream specified.
 public static AudioInputStream getAudioInputStream(InputStream stream) throws UnsupportedAudioFileException, IOException 
    Obtains an audio input stream from the provided input stream. The stream must point to valid audio file data. The implementation of this method may require multiple parsers to examine the stream to determine whether they support it. These parsers must be able to mark the stream, read enough data to determine whether they support the stream, and, if not, reset the stream's read pointer to its original position. If the input stream does not support these operation, this method may fail with an IOException.
 public static AudioInputStream getAudioInputStream(URL url) throws UnsupportedAudioFileException, IOException 
    Obtains an audio input stream from the URL provided. The URL must point to valid audio file data.
 public static AudioInputStream getAudioInputStream(File file) throws UnsupportedAudioFileException, IOException 
    Obtains an audio input stream from the provided File. The File must point to valid audio file data.
 public static AudioInputStream getAudioInputStream(Encoding targetEncoding,
    AudioInputStream sourceStream) 
    Obtains an audio input stream of the indicated encoding, by converting the provided audio input stream.
 public static AudioInputStream getAudioInputStream(AudioFormat targetFormat,
    AudioInputStream sourceStream) 
    Obtains an audio input stream of the indicated format, by converting the provided audio input stream.
 public static Clip getClip() throws LineUnavailableException 
    Obtains a clip that can be used for playing back an audio file or an audio stream. The returned clip will be provided by the default system mixer, or, if not possible, by any other mixer installed in the system that supports a Clip object.

    The returned clip must be opened with the open(AudioFormat) or open(AudioInputStream) method.

    This is a high-level method that uses getMixer and getLine internally.

    If the system property javax.sound.sampled.Clip is defined or it is defined in the file "sound.properties", it is used to retrieve the default clip. For details, refer to the class description .

 public static Clip getClip(Info mixerInfo) throws LineUnavailableException 
    Obtains a clip from the specified mixer that can be used for playing back an audio file or an audio stream.

    The returned clip must be opened with the open(AudioFormat) or open(AudioInputStream) method.

    This is a high-level method that uses getMixer and getLine internally.

 public static Line getLine(Info info) throws LineUnavailableException 
    Obtains a line that matches the description in the specified Line.Info object.

    If a DataLine is requested, and info is an instance of DataLine.Info specifying at least one fully qualified audio format, the last one will be used as the default format of the returned DataLine.

    If system properties javax.sound.sampled.Clip, javax.sound.sampled.Port, javax.sound.sampled.SourceDataLine and javax.sound.sampled.TargetDataLine are defined or they are defined in the file "sound.properties", they are used to retrieve default lines. For details, refer to the class description . If the respective property is not set, or the mixer requested in the property is not installed or does not provide the requested line, all installed mixers are queried for the requested line type. A Line will be returned from the first mixer providing the requested line type.

 public static Mixer getMixer(Info info) 
    Obtains the requested audio mixer.
 public static Info[] getMixerInfo() 
    Obtains an array of mixer info objects that represents the set of audio mixers that are currently installed on the system.
 public static SourceDataLine getSourceDataLine(AudioFormat format) throws LineUnavailableException 
    Obtains a source data line that can be used for playing back audio data in the format specified by the AudioFormat object. The returned line will be provided by the default system mixer, or, if not possible, by any other mixer installed in the system that supports a matching SourceDataLine object.

    The returned line should be opened with the open(AudioFormat) or open(AudioFormat, int) method.

    This is a high-level method that uses getMixer and getLine internally.

    The returned SourceDataLine's default audio format will be initialized with format.

    If the system property javax.sound.sampled.SourceDataLine is defined or it is defined in the file "sound.properties", it is used to retrieve the default source data line. For details, refer to the class description .

 public static SourceDataLine getSourceDataLine(AudioFormat format,
    Info mixerinfo) throws LineUnavailableException 
    Obtains a source data line that can be used for playing back audio data in the format specified by the AudioFormat object, provided by the mixer specified by the Mixer.Info object.

    The returned line should be opened with the open(AudioFormat) or open(AudioFormat, int) method.

    This is a high-level method that uses getMixer and getLine internally.

    The returned SourceDataLine's default audio format will be initialized with format.

 public static Info[] getSourceLineInfo(Info info) 
    Obtains information about all source lines of a particular type that are supported by the installed mixers.
 public static TargetDataLine getTargetDataLine(AudioFormat format) throws LineUnavailableException 
    Obtains a target data line that can be used for recording audio data in the format specified by the AudioFormat object. The returned line will be provided by the default system mixer, or, if not possible, by any other mixer installed in the system that supports a matching TargetDataLine object.

    The returned line should be opened with the open(AudioFormat) or open(AudioFormat, int) method.

    This is a high-level method that uses getMixer and getLine internally.

    The returned TargetDataLine's default audio format will be initialized with format.

    If the system property {@code javax.sound.sampled.TargetDataLine} is defined or it is defined in the file "sound.properties", it is used to retrieve the default target data line. For details, refer to the class description .

 public static TargetDataLine getTargetDataLine(AudioFormat format,
    Info mixerinfo) throws LineUnavailableException 
    Obtains a target data line that can be used for recording audio data in the format specified by the AudioFormat object, provided by the mixer specified by the Mixer.Info object.

    The returned line should be opened with the open(AudioFormat) or open(AudioFormat, int) method.

    This is a high-level method that uses getMixer and getLine internally.

    The returned TargetDataLine's default audio format will be initialized with format.

 public static Encoding[] getTargetEncodings(Encoding sourceEncoding) 
    Obtains the encodings that the system can obtain from an audio input stream with the specified encoding using the set of installed format converters.
 public static Encoding[] getTargetEncodings(AudioFormat sourceFormat) 
    Obtains the encodings that the system can obtain from an audio input stream with the specified format using the set of installed format converters.
 public static AudioFormat[] getTargetFormats(Encoding targetEncoding,
    AudioFormat sourceFormat) 
    Obtains the formats that have a particular encoding and that the system can obtain from a stream of the specified format using the set of installed format converters.
 public static Info[] getTargetLineInfo(Info info) 
    Obtains information about all target lines of a particular type that are supported by the installed mixers.
 public static boolean isConversionSupported(Encoding targetEncoding,
    AudioFormat sourceFormat) 
    Indicates whether an audio input stream of the specified encoding can be obtained from an audio input stream that has the specified format.
 public static boolean isConversionSupported(AudioFormat targetFormat,
    AudioFormat sourceFormat) 
    Indicates whether an audio input stream of a specified format can be obtained from an audio input stream of another specified format.
 public static boolean isFileTypeSupported(Type fileType) 
    Indicates whether file writing support for the specified file type is provided by the system.
 public static boolean isFileTypeSupported(Type fileType,
    AudioInputStream stream) 
    Indicates whether an audio file of the specified file type can be written from the indicated audio input stream.
 public static boolean isLineSupported(Info info) 
    Indicates whether the system supports any lines that match the specified Line.Info object. A line is supported if any installed mixer supports it.
 public static int write(AudioInputStream stream,
    Type fileType,
    OutputStream out) throws IOException 
    Writes a stream of bytes representing an audio file of the specified file type to the output stream provided. Some file types require that the length be written into the file header; such files cannot be written from start to finish unless the length is known in advance. An attempt to write a file of such a type will fail with an IOException if the length in the audio file type is AudioSystem.NOT_SPECIFIED.
 public static int write(AudioInputStream stream,
    Type fileType,
    File out) throws IOException 
    Writes a stream of bytes representing an audio file of the specified file type to the external file provided.