Package dev.prozilla.pine.common.asset.audio

Class AudioSource

java.lang.Object

dev.prozilla.pine.common.asset.audio.AudioSource

All Implemented Interfaces:

Asset, AudioSourceContext, Cloneable<AudioSource>, Destructible, Initializable

public class AudioSource
extends Object
implements Initializable, Destructible, Asset, AudioSourceContext, Cloneable<AudioSource>

Constructor Summary

Constructors

Constructor	Description
AudioSource(String path, ShortBuffer buffer, int channels, int sampleRate)
AudioSource(ShortBuffer buffer, int channels, int sampleRate)

Method Summary

Modifier and Type	Method	Description
AudioSource	clone()	Returns a new object that is equal to this object.
void	destroy()	Destroys this object.
boolean	equals(AudioSource audioSource)	Checks if the given object is equal to this object.
boolean	equals(Object object)
int	getAttribute(int attribute)
double[]	getAverageMagnitudes(int intervalCount)
double[]	getMagnitudes()
String	getPath()	Returns the path to the file this asset was loaded from.
int	getState()
void	init()	Initializes this object to prepare its usage.
boolean	isCaptured()
boolean	isPlaying()
void	pause()
void	play()
void	rewind()
void	setAttribute(int attribute, boolean value)
void	setAttribute(int attribute, float value)
void	setAttribute(int attribute, int value)
void	setCapture(boolean capture)
void	setGain(float gain)
void	setLoop(boolean loop)
void	setPitch(float pitch)
void	setVolume(float volume)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.common.asset.audio.AudioSourceContext

restart, stop, togglePause

Constructor Details

AudioSource

public AudioSource(ShortBuffer buffer,
 int channels,
 int sampleRate)

AudioSource

public AudioSource(String path,
 ShortBuffer buffer,
 int channels,
 int sampleRate)

Method Details

init

public void init()
          throws IllegalStateException

Description copied from interface: Initializable

Initializes this object to prepare its usage.

Specified by:

init in interface Initializable

Throws:

IllegalStateException

destroy

public void destroy()

Description copied from interface: Destructible

Destroys this object.

Specified by:

destroy in interface Asset

Specified by:

destroy in interface Destructible

getPath

public String getPath()

Description copied from interface: Asset

Returns the path to the file this asset was loaded from.

Specified by:

getPath in interface Asset

Returns:

The path of this asset.

setCapture

public void setCapture(boolean capture)

isCaptured

public boolean isCaptured()

rewind

public void rewind()

Specified by:

rewind in interface AudioSourceContext

play

public void play()

Specified by:

play in interface AudioSourceContext

pause

public void pause()

Specified by:

pause in interface AudioSourceContext

isPlaying

public boolean isPlaying()

Specified by:

isPlaying in interface AudioSourceContext

getState

public int getState()

getAttribute

public int getAttribute(int attribute)
                 throws IllegalStateException

Throws:

IllegalStateException

setVolume

public void setVolume(float volume)
               throws IllegalStateException

Specified by:

setVolume in interface AudioSourceContext

Throws:

IllegalStateException

setPitch

public void setPitch(float pitch)
              throws IllegalStateException

Specified by:

setPitch in interface AudioSourceContext

Throws:

IllegalStateException

setGain

public void setGain(float gain)

Specified by:

setGain in interface AudioSourceContext

setLoop

public void setLoop(boolean loop)
             throws IllegalStateException

Specified by:

setLoop in interface AudioSourceContext

Throws:

IllegalStateException

setAttribute

public void setAttribute(int attribute,
 float value)
                  throws IllegalStateException

Throws:

IllegalStateException

setAttribute

public void setAttribute(int attribute,
 boolean value)
                  throws IllegalStateException

Throws:

IllegalStateException

setAttribute

public void setAttribute(int attribute,
 int value)
                  throws IllegalStateException

Throws:

IllegalStateException

getAverageMagnitudes

public double[] getAverageMagnitudes(int intervalCount)

getMagnitudes

public double[] getMagnitudes()

equals

public boolean equals(Object object)

Overrides:

equals in class Object

equals

public boolean equals(AudioSource audioSource)

Description copied from interface: Cloneable

Checks if the given object is equal to this object.

Specified by:

equals in interface Cloneable<AudioSource>

Parameters:

audioSource - Other object

Returns:

true if both objects are equal.

clone

public AudioSource clone()

Description copied from interface: Cloneable

Returns a new object that is equal to this object.

Specified by:

clone in interface Cloneable<AudioSource>

Overrides:

clone in class Object

Returns:

Clone of this object