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

Interface SoundFactory

public interface SoundFactory

A factory to produce a Sound object

Author:

Tim Neumann

Method Summary

Modifier and Type	Method and Description
Sound	loadSound(AudioInputStream data) Creates a new sound and reads the data for it from the given AudioInputStream
Sound	loadSound(Path location) Creates a new sound from the file at the given Path.
Sound	loadSound(URL location) Creates a new sound from the file at the given URL.

Method Detail

loadSound

Sound loadSound(AudioInputStream data)
         throws IOException

Creates a new sound and reads the data for it from the given AudioInputStream

Parameters:

data - The stream delivering the audio data for this sound

Returns:

The loaded Sound object.

Throws:

IOException - if an input or output error occurs while reading from the stream.

loadSound

Sound loadSound(URL location)
         throws UnsupportedAudioFileException,
                IOException

Creates a new sound from the file at the given URL.

Parameters:

location - The URL of the file to load

Returns:

The loaded Sound object.

Throws:

UnsupportedAudioFileException - When the file at the URL is not in a supported format

IOException - if an input or output error occurs while reading the file

loadSound

Sound loadSound(Path location)
         throws UnsupportedAudioFileException,
                IOException

Creates a new sound from the file at the given Path.

Parameters:

location - The Path of the file to load

Returns:

The loaded Sound object.

Throws:

UnsupportedAudioFileException - When the file at the Path is not in a supported format

IOException - if an input or output error occurs while reading the file