Package org.openhab.core.audio

Class FileAudioStream

java.lang.Object

java.io.InputStream

org.openhab.core.audio.AudioStream

org.openhab.core.audio.FileAudioStream

All Implemented Interfaces:

Closeable, AutoCloseable, ClonableAudioStream, SizeableAudioStream, Disposable

@NonNullByDefault
public class FileAudioStream
extends AudioStream
implements SizeableAudioStream, ClonableAudioStream, Disposable

This is an AudioStream from an audio file

Author:

Karel Goderis - Initial contribution, Kai Kreuzer - Refactored to take a file as input, Christoph Weitkamp - Refactored use of filename extension

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AAC_EXTENSION
static final String	FLAC_EXTENSION
static final String	MP3_EXTENSION
static final String	OGG_EXTENSION
static final String	WAV_EXTENSION

Constructor Summary

Constructors

Constructor	Description
FileAudioStream(File file)
FileAudioStream(File file, AudioFormat format)
FileAudioStream(File file, AudioFormat format, boolean isTemporaryFile)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	dispose()
InputStream	getClonedStream()	Returns a new, fully independent stream instance, which can be read and closed without impacting the original instance.
AudioFormat	getFormat()	Gets the supported audio format
long	length()	Provides the length of the stream in bytes.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte @Nullable [] b)
int	read(byte @Nullable [] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class org.openhab.core.audio.AudioStream

getId

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

WAV_EXTENSION

public static final String WAV_EXTENSION

See Also:

• Constant Field Values

MP3_EXTENSION

public static final String MP3_EXTENSION

See Also:

• Constant Field Values

OGG_EXTENSION

public static final String OGG_EXTENSION

See Also:

• Constant Field Values

AAC_EXTENSION

public static final String AAC_EXTENSION

See Also:

• Constant Field Values

FLAC_EXTENSION

public static final String FLAC_EXTENSION

See Also:

• Constant Field Values

Constructor Details

FileAudioStream

public FileAudioStream(File file)
                throws AudioException

Throws:

AudioException

FileAudioStream

public FileAudioStream(File file,
 AudioFormat format)
                throws AudioException

Throws:

AudioException

FileAudioStream

public FileAudioStream(File file,
 AudioFormat format,
 boolean isTemporaryFile)
                throws AudioException

Throws:

AudioException

Method Details

getFormat

public AudioFormat getFormat()

Description copied from class: AudioStream

Gets the supported audio format

Specified by:

getFormat in class AudioStream

Returns:

The supported audio format

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte @Nullable [] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte @Nullable [] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

length

public long length()

Description copied from interface: SizeableAudioStream

Provides the length of the stream in bytes.

Specified by:

length in interface SizeableAudioStream

Returns:

absolute length in bytes

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

getClonedStream

public InputStream getClonedStream()
                            throws AudioException

Description copied from interface: ClonableAudioStream

Returns a new, fully independent stream instance, which can be read and closed without impacting the original instance.

Specified by:

getClonedStream in interface ClonableAudioStream

Returns:

a new input stream that can be consumed by the caller

Throws:

AudioException - if stream cannot be created

dispose

public void dispose()
             throws IOException

Specified by:

dispose in interface Disposable

Throws:

IOException