io.github.amyassist.amy.core.audio.sound

Interface SoundPlayer

public interface SoundPlayer

A sound player. It can be started and stopped by the given methods. To played data is written to the AudioInputStream returned by getAudioStream(). The sound is not played directly.

Author:

Tim Neumann

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SoundPlayer.StopReason All possible reasons for the SoundPlayer to stop.

Method Summary

Modifier and Type	Method and Description
AudioInputStream	getAudioStream() Get the AudioInputStream on which the audio is being played.
boolean	isRunning() Checks if the player is currently running
void	setOnStopHook(Consumer<SoundPlayer.StopReason> callback) Sets the callback, which is called when this player ends playback.
void	start() Starts the audio output.
void	stop() Stops / cancels the audio output.

Method Detail

getAudioStream

AudioInputStream getAudioStream()

Get the AudioInputStream on which the audio is being played.

Returns:

The audio stream

start

void start()

Starts the audio output.

stop

void stop()

Stops / cancels the audio output.

isRunning

boolean isRunning()

Checks if the player is currently running

Returns:

Whether the player is running

setOnStopHook

void setOnStopHook(Consumer<SoundPlayer.StopReason> callback)

Sets the callback, which is called when this player ends playback.

This method can only be called before start().

The callback is provided with a reason for the end of the playback.

Parameters:

callback - The method called.

Throws:

IllegalStateException - When the player has already been started.