Package org.openhab.core.audio

Class URLAudioStream

java.lang.Object

java.io.InputStream

org.openhab.core.audio.AudioStream

org.openhab.core.audio.URLAudioStream

All Implemented Interfaces:

Closeable, AutoCloseable, ClonableAudioStream

@NonNullByDefault
public class URLAudioStream
extends AudioStream
implements ClonableAudioStream

This is an AudioStream from a URL. Note that some sinks, like Sonos, can directly handle URL based streams, and therefore can/should call getURL() to get a direct reference to the URL.

Author:

Karel Goderis - Initial contribution, Kai Kreuzer - Refactored to not require a source, Christoph Weitkamp - Refactored use of filename extension

Field Summary

Fields

Modifier and Type	Field	Description
static final String	M3U_EXTENSION
static final String	PLS_EXTENSION

Constructor Summary

Constructors

Constructor	Description
URLAudioStream(String url)

Method Summary

Modifier and Type	Method	Description
void	close()
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
String	getURL()
int	read()
String	toString()

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

getId

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

M3U_EXTENSION

public static final String M3U_EXTENSION

See Also:

• Constant Field Values

PLS_EXTENSION

public static final String PLS_EXTENSION

See Also:

• Constant Field Values

Constructor Details

URLAudioStream

public URLAudioStream(String url)
               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

getURL

public String getURL()

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

toString

public String toString()

Overrides:

toString in class Object

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