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

Interface Sound

public interface Sound

The representation of a sound, which can be played.

Author:

Tim Neumann

Method Summary

Modifier and Type	Method and Description
AudioFormat	getFormat() Get's the AudioFormat of this sound
int	getFrameLength() Get's the length of the sound, expressed in sample frames rather than bytes.
SoundPlayer	getInfiniteLoopPlayer() Get a sound player that will play this audio for ever.
SoundPlayer	getLoopPlayer(int loopCount) Get a sound player that will play this audio the given amount of times.
SoundPlayer	getSinglePlayer() Get a sound player that will play this audio once.

Method Detail

getSinglePlayer

SoundPlayer getSinglePlayer()

Get a sound player that will play this audio once.

Returns:

The SoundPlayer.

getLoopPlayer

SoundPlayer getLoopPlayer(int loopCount)

Get a sound player that will play this audio the given amount of times.

Parameters:

loopCount - How often to loop. Must be greater 0

Returns:

The SoundPlayer

getInfiniteLoopPlayer

SoundPlayer getInfiniteLoopPlayer()

Get a sound player that will play this audio for ever.

Returns:

The SoundPlayer

getFrameLength

int getFrameLength()

Get's the length of the sound, expressed in sample frames rather than bytes.

Returns:

the length in sample frames

getFormat

AudioFormat getFormat()

Get's the AudioFormat of this sound

Returns:

the format