Uses of Class
org.openhab.core.audio.AudioStream

Packages that use AudioStream

Package	Description
org.openhab.core.audio
org.openhab.core.audio.utils
org.openhab.core.voice

Uses of AudioStream in org.openhab.core.audio

Subclasses of AudioStream in org.openhab.core.audio

Modifier and Type	Class	Description
class	ByteArrayAudioStream	This is an implementation of an AudioStream with known length and a clone method, which is based on a simple byte array.
class	FileAudioStream	This is an AudioStream from an audio file
class	FixedLengthAudioStream	Deprecated. You should consider using ClonableAudioStream and/or SizeableAudioStream to detect audio stream capabilities
class	PipedAudioStream	This is an implementation of an AudioStream used to transmit raw audio data to a sink.
class	URLAudioStream	This is an AudioStream from a URL.

Fields in org.openhab.core.audio with type parameters of type AudioStream

Modifier and Type	Field	Description
protected final Map<AudioStream,CompletableFuture<@Nullable Void>>	AudioSinkAsync.runnableByAudioStream

Methods in org.openhab.core.audio that return AudioStream

Modifier and Type	Method	Description
AudioStream	StreamServed.audioStream()	Returns the value of the audioStream record component.
AudioStream	AudioSource.getInputStream(AudioFormat format)	Gets an AudioStream for reading audio data in supported audio format

Methods in org.openhab.core.audio that return types with arguments of type AudioStream

Modifier and Type	Method	Description
Set<Class<? extends AudioStream>>	AudioSink.getSupportedStreams()	Gets a set containing all supported audio stream formats
@Nullable Class<? extends @Nullable AudioStream>	UnsupportedAudioStreamException.getUnsupportedAudioStreamClass()	Gets the unsupported audio stream class.

Methods in org.openhab.core.audio with parameters of type AudioStream

Modifier and Type	Method	Description
void	AudioManager.play(@Nullable AudioStream audioStream)	Plays the passed audio stream using the default audio sink.
void	AudioManager.play(@Nullable AudioStream audioStream, @Nullable String sinkId)	Plays the passed audio stream on the given sink.
void	AudioManager.play(@Nullable AudioStream audioStream, @Nullable String sinkId, @Nullable PercentType volume)	Plays the passed audio stream on the given sink.
protected void	AudioSinkAsync.playbackFinished(AudioStream audioStream)	Will complete the future previously returned, allowing the core to run delayed task.
void	AudioSink.process(@Nullable AudioStream audioStream)	Deprecated. Use AudioSink.processAndComplete(AudioStream)
void	AudioSinkAsync.process(@Nullable AudioStream audioStream)
void	AudioSinkSync.process(@Nullable AudioStream audioStream)
default CompletableFuture<@Nullable Void>	AudioSink.processAndComplete(@Nullable AudioStream audioStream)	Processes the passed AudioStream, and returns a CompletableFuture that should complete when the sound is fully played.
CompletableFuture<@Nullable Void>	AudioSinkAsync.processAndComplete(@Nullable AudioStream audioStream)
CompletableFuture<@Nullable Void>	AudioSinkSync.processAndComplete(@Nullable AudioStream audioStream)
protected abstract void	AudioSinkAsync.processAsynchronously(@Nullable AudioStream audioStream)	Processes the passed AudioStream asynchronously.
protected abstract void	AudioSinkSync.processSynchronously(@Nullable AudioStream audioStream)	Processes the passed AudioStream and returns only when the playback is ended.
String	AudioHTTPServer.serve(AudioStream stream)	Deprecated. Use AudioHTTPServer.serve(AudioStream, int, boolean)
String	AudioHTTPServer.serve(AudioStream stream, int seconds)	Deprecated. Use AudioHTTPServer.serve(AudioStream, int, boolean)
StreamServed	AudioHTTPServer.serve(AudioStream stream, int seconds, boolean multiTimeStream)	Creates a relative url for a given AudioStream where it can be requested one or multiple times within the given time frame.

Constructors in org.openhab.core.audio with parameters of type AudioStream

Modifier	Constructor	Description
	StreamServed(String url, AudioStream audioStream, AtomicInteger currentlyServedStream, AtomicLong timeout, boolean multiTimeStream, CompletableFuture<@Nullable Void> playEnd)	Creates an instance of a StreamServed record class.

Constructor parameters in org.openhab.core.audio with type arguments of type AudioStream

Modifier	Constructor	Description
	UnsupportedAudioStreamException(String message, @Nullable Class<? extends @Nullable AudioStream> unsupportedAudioStreamClass)	Constructs a new exception with the specified detail message and unsupported format.
	UnsupportedAudioStreamException(String message, @Nullable Class<? extends @Nullable AudioStream> unsupportedAudioStreamClass, @Nullable Throwable cause)	Constructs a new exception with the specified detail message, unsupported format, and cause.

Uses of AudioStream in org.openhab.core.audio.utils

Methods in org.openhab.core.audio.utils that return AudioStream

Modifier and Type	Method	Description
AudioStream	ToneSynthesizer.getStream(List<ToneSynthesizer.Tone> tones)	Synthesize a list of ToneSynthesizer.Tone into a wav audio stream

Uses of AudioStream in org.openhab.core.voice

Methods in org.openhab.core.voice that return AudioStream

Modifier and Type	Method	Description
AudioStream	TTSCache.get(org.openhab.core.voice.internal.cache.CachedTTSService tts, String text, Voice voice, AudioFormat requestedFormat)	Returns an AudioStream containing the TTS results.
AudioStream	AbstractCachedTTSService.synthesize(String text, Voice voice, AudioFormat requestedFormat)
AudioStream	TTSService.synthesize(String text, Voice voice, AudioFormat requestedFormat)	Returns an AudioStream containing the TTS results.

Methods in org.openhab.core.voice with parameters of type AudioStream

Modifier and Type	Method	Description
STTServiceHandle	STTService.recognize(STTListener sttListener, AudioStream audioStream, Locale locale, Set<String> grammars)	This method starts the process of speech recognition.
default KSServiceHandle	KSEdgeService.spot(KSListener ksListener, AudioStream audioStream, Locale locale, String keyword)
KSServiceHandle	KSService.spot(KSListener ksListener, AudioStream audioStream, Locale locale, String keyword)	This method starts the process of keyword spotting The audio data of the passed AudioStream is passed to the keyword spotting engine.
String	VoiceManager.transcribe(AudioStream audioStream, @Nullable String sttId, @Nullable Locale locale)	Run speech-to-text over the provided audio stream.