org.tritonus.share.sampled.convert
Class TAudioInputStream

java.lang.Object
  extended by java.io.InputStream
      extended by javax.sound.sampled.AudioInputStream
          extended by org.tritonus.share.sampled.convert.TAudioInputStream
All Implemented Interfaces:
java.io.Closeable
Direct Known Subclasses:
TAsynchronousFilteredAudioInputStream, TSynchronousFilteredAudioInputStream

public class TAudioInputStream
extends AudioInputStream

AudioInputStream base class. This class implements "dynamic" properties. "Dynamic" properties are properties that may change during the life time of the objects. This is typically used to pass information like the current frame number, volume of subbands and similar values. "Dynamic" properties are different from properties in AudioFormat and AudioFileFormat, which are considered "static", as they aren't allowed to change after creating of the object, thereby maintaining the immutable character of these classes.


Constructor Summary
TAudioInputStream(java.io.InputStream inputStream, AudioFormat audioFormat, long lLengthInFrames)
          Constructor without properties.
TAudioInputStream(java.io.InputStream inputStream, AudioFormat audioFormat, long lLengthInFrames, java.util.Map<java.lang.String,java.lang.Object> properties)
          Constructor with properties.
 
Method Summary
 java.util.Map<java.lang.String,java.lang.Object> properties()
          Obtain a Map containing the properties.
 
Methods inherited from class javax.sound.sampled.AudioInputStream
available, close, getFormat, getFrameLength, mark, markSupported, read, read, read, reset, skip
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TAudioInputStream

public TAudioInputStream(java.io.InputStream inputStream,
                         AudioFormat audioFormat,
                         long lLengthInFrames)
Constructor without properties. Creates an empty properties map.


TAudioInputStream

public TAudioInputStream(java.io.InputStream inputStream,
                         AudioFormat audioFormat,
                         long lLengthInFrames,
                         java.util.Map<java.lang.String,java.lang.Object> properties)
Constructor with properties. The passed properties map is not copied. This allows subclasses to change values in the map after creation, and the changes are reflected in the map the application program can obtain.

Method Detail

properties

public java.util.Map<java.lang.String,java.lang.Object> properties()
Obtain a Map containing the properties. This method returns a Map that cannot be modified by the application program, but reflects changes to the map made by the implementation.

Returns:
a map containing the properties.