Packages

trait AudioFile extends Channel

Linear Supertypes
Channel, Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AudioFile
  2. Channel
  3. Closeable
  4. AutoCloseable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cleanUp(): Unit

    Flushes and closes the file.

    Flushes and closes the file. As opposed to close(), this does not throw any exceptions but simply ignores any errors.

    See also

    #close()

  2. abstract def close(): Unit

    Flushes and closes the file

    Flushes and closes the file

    Definition Classes
    AudioFile → Channel → Closeable → AutoCloseable
    Annotations
    @throws( classOf[IOException] )
    Exceptions thrown

    java.io.IOException if an error occurs during buffer flush or closing the file.

  3. abstract def copyTo(target: AudioFile, numFrames: Long): AudioFile

    Copies sample frames from a source sound file to a target file (either another sound file or any other class implementing the InterleavedStreamFile interface).

    Copies sample frames from a source sound file to a target file (either another sound file or any other class implementing the InterleavedStreamFile interface). Both files must have the same number of channels.

    target

    to file to copy to from this audio file

    numFrames

    the number of frames to copy. Reading and writing begins at the current positions of both files.

    Annotations
    @throws( classOf[IOException] )
    Exceptions thrown

    java.io.IOException if a read or writer error occurs

  4. abstract def file: Option[File]

    Returns the underlying File if it was provided to the AudioFile constructor.

    Returns the underlying File if it was provided to the AudioFile constructor. For an AudioFile created from an InputStream this will return None.

  5. abstract def flush(): AudioFile

    Flushes pending buffer content, and updates the sound file header information (i.e.

    Flushes pending buffer content, and updates the sound file header information (i.e. numFrames fields). Usually you will not have to call this method directly, unless you pause writing for some time and want the file information to appear as accurate as possible.

  6. abstract def isOpen(): Boolean
    Definition Classes
    Channel
  7. abstract def isReadable: Boolean
  8. abstract def isWritable: Boolean
  9. abstract def numFrames: Long

    Returns the number of frames in the file.

    Returns the number of frames in the file.

    returns

    the number of sample frames in the file. includes pending buffer content

    Exceptions thrown

    java.io.IOException this is never thrown but declared as of the InterleavedStreamFile interface

  10. abstract def position: Long

    Returns the current file pointer in sample frames

    Returns the current file pointer in sample frames

    returns

    the sample frame index which is the off for the next reader or writer operation.

    Exceptions thrown

    java.io.IOException when the position cannot be queried

  11. abstract def read(data: Frames, off: Int, len: Int): AudioFile

    Reads sample frames from the current position

    Reads sample frames from the current position

    data

    buffer to hold the frames reader from hard-disc. the samples will be de-interleaved such that data[0][] holds the first channel, data[1][] holds the second channel etc. ; it is allowed to have null arrays in the data (e.g. data[0] == null), in which case these channels are skipped when reading

    off

    off in the buffer in sample frames, such that he first frame of the first channel will be placed in data[0][off] etc.

    len

    number of continuous frames to reader.

    Annotations
    @throws( classOf[IOException] )
    Exceptions thrown

    java.io.IOException if a reader error or end-of-file occurs.

  12. abstract def seek(frame: Long): AudioFile

    Moves the file pointer to a specific frame.

    Moves the file pointer to a specific frame.

    frame

    the sample frame which should be the new file position. this is really the sample index and not the physical file pointer.

    Annotations
    @throws( classOf[IOException] )
    Exceptions thrown

    java.io.IOException when a seek error occurs or you try to seek past the file's end.

  13. abstract def spec: AudioFileSpec

    Returns a description of the audio file's specification.

  14. abstract def write(data: Frames, off: Int, len: Int): AudioFile

    Writes sample frames to the file starting at the current position.

    Writes sample frames to the file starting at the current position.

    data

    buffer holding the frames to writer to hard-disc. the samples must be de-interleaved such that data[0][] holds the first channel, data[1][] holds the second channel etc.

    off

    off in the buffer in sample frames, such that he first frame of the first channel will be reader from data[0][off] etc.

    len

    number of continuous frames to writer.

    Annotations
    @throws( classOf[IOException] )
    Exceptions thrown

    java.io.IOException if a writer error occurs.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def buffer(bufFrames: Int = 8192): Frames
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def fileType: AudioFileType
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def numChannels: Int

    Convenience method: Returns the number of channels in the file.

    Convenience method: Returns the number of channels in the file. Same as spec.numChannels.

    returns

    the number of channels

  18. final def position_=(frame: Long): Unit
    Annotations
    @throws( classOf[IOException] )
  19. final def read(data: Frames): AudioFile
    Annotations
    @throws( classOf[IOException] )
  20. final def sampleFormat: SampleFormat
  21. final def sampleRate: Double
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. final def write(data: Frames): AudioFile
    Annotations
    @throws( classOf[IOException] )

Inherited from Channel

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped