Package org.openhab.core.audio

Class AudioSinkSync

java.lang.Object

org.openhab.core.audio.AudioSinkSync

All Implemented Interfaces:

AudioSink

@NonNullByDefault
public abstract class AudioSinkSync
extends Object
implements AudioSink

Definition of an audio output like headphones, a speaker or for writing to a file / clip. Helper class for synchronous sink : when the process() method returns, the source is considered played, and could be disposed. Any delayed tasks can then be performed, such as volume restoration.

Author:

Gwendal Roulleau - Initial contribution

Constructor Summary

Constructors

Constructor	Description
AudioSinkSync()

Method Summary

Modifier and Type	Method	Description
void	process(@Nullable AudioStream audioStream)	Processes the passed AudioStream If the passed AudioStream is not supported by this instance, an UnsupportedAudioStreamException is thrown.
CompletableFuture<@Nullable Void>	processAndComplete(@Nullable AudioStream audioStream)	Processes the passed AudioStream, and returns a CompletableFuture that should complete when the sound is fully played.
protected abstract void	processSynchronously(@Nullable AudioStream audioStream)	Processes the passed AudioStream and returns only when the playback is ended.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhab.core.audio.AudioSink

getId, getLabel, getSupportedFormats, getSupportedStreams, getVolume, setVolume

Constructor Details

AudioSinkSync

public AudioSinkSync()

Method Details

processAndComplete

public CompletableFuture<@Nullable Void> processAndComplete(@Nullable AudioStream audioStream)

Description copied from interface: AudioSink

Processes the passed AudioStream, and returns a CompletableFuture that should complete when the sound is fully played. It is the sink responsibility to complete this future. If the passed AudioStream is not supported by this instance, an UnsupportedAudioStreamException is thrown. If the passed AudioStream has an AudioFormat not supported by this instance, an UnsupportedAudioFormatException is thrown. In case the audioStream is null, this should be interpreted as a request to end any currently playing stream. When the stream is not needed anymore, if the stream implements the Disposable interface, the sink should hereafter get rid of it by calling the dispose method.

Specified by:

processAndComplete in interface AudioSink

Parameters:

audioStream - the audio stream to play or null to keep quiet

Returns:

A future completed when the sound is fully played. The method can instead complete with UnsupportedAudioFormatException if the audioStream format is not supported, or UnsupportedAudioStreamException If audioStream is not supported

process

public void process(@Nullable AudioStream audioStream)
             throws UnsupportedAudioFormatException,
UnsupportedAudioStreamException

Description copied from interface: AudioSink

Processes the passed AudioStream If the passed AudioStream is not supported by this instance, an UnsupportedAudioStreamException is thrown. If the passed AudioStream has an AudioFormat not supported by this instance, an UnsupportedAudioFormatException is thrown. In case the audioStream is null, this should be interpreted as a request to end any currently playing stream. When the stream is not needed anymore, if the stream implements the Disposable interface, the sink should hereafter get rid of it by calling the dispose method.

Specified by:

process in interface AudioSink

Parameters:

audioStream - the audio stream to play or null to keep quiet

Throws:

UnsupportedAudioFormatException - If audioStream format is not supported

UnsupportedAudioStreamException - If audioStream is not supported

processSynchronously

protected abstract void processSynchronously(@Nullable AudioStream audioStream)
                                      throws UnsupportedAudioFormatException,
UnsupportedAudioStreamException

Processes the passed AudioStream and returns only when the playback is ended. If the passed AudioStream is not supported by this instance, an UnsupportedAudioStreamException is thrown. If the passed AudioStream has an AudioFormat not supported by this instance, an UnsupportedAudioFormatException is thrown. In case the audioStream is null, this should be interpreted as a request to end any currently playing stream.

Parameters:

audioStream - the audio stream to play or null to keep quiet

Throws:

UnsupportedAudioFormatException - If audioStream format is not supported

UnsupportedAudioStreamException - If audioStream is not supported