Class OggInputStream

java.lang.Object
de.pottgames.tuningfork.decoder.OggInputStream
All Implemented Interfaces:
AudioStream, Closeable, AutoCloseable
public class OggInputStream extends Object implements AudioStream
An input stream to read Ogg Vorbis.

  • Constructor Details

    • OggInputStream

      public OggInputStream(com.badlogic.gdx.files.FileHandle file, OggInputStream previousStream)
      Initializes a OggInputStream from a FileHandle and an optional OggInputStream for buffer reusage, the old stream shouldn't be used afterward.
      Parameters:
      file - the file handle
      previousStream - may be null

    • OggInputStream

      public OggInputStream(InputStream stream)
      Initializes a OggInputStream from an InputStream. This stream does not support the reset and getDuration function. Use OggInputStream(FileHandle, OggInputStream) instead to get the full functionality.
      Parameters:
      stream - the input stream

  • Method Details

    • reset

      public AudioStream reset()
      Description copied from interface: AudioStream
      Resets the audio stream as if it was re-opened. Implementations are free to close themselves and provide a new AudioStream. The AudioStream returned by this function will be used, regardless of whether it is a new instance or the old one.
      Specified by:
      reset in interface AudioStream
      Returns:
      an AudioStream

    • getDuration

      public float getDuration()
      Description copied from interface: AudioStream
      Returns the duration in seconds or -1 if this information is not available.
      Specified by:
      getDuration in interface AudioStream
      Returns:
      duration in seconds or -1 if the information is not available

    • getLength

      public int getLength()
      Get the number of bytes on the stream
      Returns:
      The number of the bytes on the stream

    • getChannels

      public int getChannels()
      Description copied from interface: AudioStream
      Returns the number of audio channels.
      Specified by:
      getChannels in interface AudioStream
      Returns:
      number of channels

    • getSampleRate

      public int getSampleRate()
      Description copied from interface: AudioStream
      Returns the sample rate.
      Specified by:
      getSampleRate in interface AudioStream
      Returns:
      the sample rate

    • getBitsPerSample

      public int getBitsPerSample()
      Description copied from interface: AudioStream
      Returns the number of bits per sample, also known as the sample depth.
      Specified by:
      getBitsPerSample in interface AudioStream
      Returns:
      the number of bits per sample

    • read

      public int read()

    • atEnd

      public boolean atEnd()

    • read

      public int read(byte[] b, int off, int len)

    • read

      public int read(byte[] b)
      Description copied from interface: AudioStream
      Reads bytes from the stream until the given array is full or the stream ends. Returns the number of bytes that were actually read.
      Specified by:
      read in interface AudioStream
      Parameters:
      b - the byte array to store the bytes in
      Returns:
      number of bytes read or -1 if there are no bytes left

    • getPcmDataType

      public PcmFormat.PcmDataType getPcmDataType()
      Description copied from interface: AudioStream
      Returns the output data format of this AudioStream.
      Specified by:
      getPcmDataType in interface AudioStream
      Returns:
      the pcm data type

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • isClosed

      public boolean isClosed()
      Description copied from interface: AudioStream
      Returns true if the AudioStream is closed.
      Specified by:
      isClosed in interface AudioStream
      Returns:
      true if closed, false if open