com.github.mathiewz.slick.openal.AudioInputStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of modernized-slick Show documentation

The main purpose of this libraryis to modernize and maintain the slick2D library.

The newest version!

package com.github.mathiewz.slick.openal;

import java.io.IOException;

/**
 * The description of an input stream that supplied audio data suitable for
 * use in OpenAL buffers
 *
 * @author kevin
 */
interface AudioInputStream {
    /**
     * Get the number of channels used by the audio
     *
     * @return The number of channels used by the audio
     */
    public int getChannels();

    /**
     * The play back rate described in the underling audio file
     *
     * @return The playback rate
     */
    public int getRate();

    /**
     * Read a single byte from the stream
     *
     * @return The single byte read
     * @throws IOException
     *             Indicates a failure to read the underlying media
     * @see java.io.InputStream#read()
     */
    public int read() throws IOException;

    /**
     * Read up to data.length bytes from the stream
     *
     * @param data
     *            The array to read into
     * @return The number of bytes read or -1 to indicate no more bytes are available
     * @throws IOException
     *             Indicates a failure to read the underlying media
     * @see java.io.InputStream#read(byte[])
     */
    public int read(byte[] data) throws IOException;

    /**
     * Read up to len bytes from the stream
     *
     * @param data
     *            The array to read into
     * @param ofs
     *            The offset into the array at which to start writing
     * @param len
     *            The maximum number of bytes to read
     * @return The number of bytes read or -1 to indicate no more bytes are available
     * @throws IOException
     *             Indicates a failure to read the underlying media
     * @see java.io.InputStream#read(byte[], int, int)
     */
    public int read(byte[] data, int ofs, int len) throws IOException;

    /**
     * Check if the stream is at the end, i.e. end of file or URL
     *
     * @return True if the stream has no more data available
     */
    public boolean atEnd();

    /**
     * Close the stream
     *
     * @see java.io.InputStream#close()
     * @throws IOException
     *             Indicates a failure to access the resource
     */
    public void close() throws IOException;
}