io.github.amyassist.amy.core.audio

Interface AudioManager

public interface AudioManager

The class that manages everything that has to do with audio.

Author:

Tim Neumann

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AudioManager.OutputBehavior The possible behaviors of a output, if there is currently another output

Method Summary

Modifier and Type	Method and Description
List<UUID>	getAllRegisteredAudioEnvironments()
AudioFormat	getDefaultInputAudioFormat()
AudioFormat	getDefaultOutputAudioFormat()
AudioInputStream	getInputStreamOfAudioEnvironment(UUID identifier) Get's a AudioInputStream with the audio input from the audio environment described by the given identifier.
boolean	isAudioEnvironmentCurrentlyOutputting(UUID identifier) Checks whether the audio environment described by the given identifier is currently outputting any audio.
void	playAudio(UUID identifier, AudioInputStream audioToPlay, AudioManager.OutputBehavior behavior) Queues the playback of the given audio input stream on the audio environment specified by the given identifier
void	stopAudioOutput(UUID identifier) Stops all audio output on the audio environment specified by the given identifier.

Method Detail

playAudio

void playAudio(UUID identifier,
               AudioInputStream audioToPlay,
               AudioManager.OutputBehavior behavior)

Queues the playback of the given audio input stream on the audio environment specified by the given identifier

Parameters:

identifier - The identifier of the audio environment to play this audio on.

audioToPlay - The audio to play.

behavior - How to behave if there is some output already.

stopAudioOutput

void stopAudioOutput(UUID identifier)

Stops all audio output on the audio environment specified by the given identifier. This includes all queued output.

Parameters:

identifier - The identifier of the audio environment to interrupt.

getAllRegisteredAudioEnvironments

List<UUID> getAllRegisteredAudioEnvironments()

Returns:

A list of UUIDs, each being the identifier of a registered audio environment

isAudioEnvironmentCurrentlyOutputting

boolean isAudioEnvironmentCurrentlyOutputting(UUID identifier)

Checks whether the audio environment described by the given identifier is currently outputting any audio.

Parameters:

identifier - The identifier of the audio environment to check

Returns:

Whether the audio environment is currently outputting.

getInputStreamOfAudioEnvironment

AudioInputStream getInputStreamOfAudioEnvironment(UUID identifier)

Get's a AudioInputStream with the audio input from the audio environment described by the given identifier.

For example the microphone input.

This stream should be read from with appropriate speed, because every other thread that has a InputStream from the same environment will need to wait otherwise.

If the stream is no longer needed, it must be closed.

Parameters:

identifier - The identifier of the audio environment to get the input Stream from.

Returns:

The audio input stream of the audio environment.

getDefaultOutputAudioFormat

AudioFormat getDefaultOutputAudioFormat()

Returns:

The default audio format used for output(e.g. speaker).

getDefaultInputAudioFormat

AudioFormat getDefaultInputAudioFormat()

Returns:

The default audio format used for input(e.g. microphone).