Package dev.prozilla.pine.core.component.audio

Class AudioPlayer

java.lang.Object

dev.prozilla.pine.core.component.Component

dev.prozilla.pine.core.component.audio.AudioPlayer

All Implemented Interfaces:

AudioSourceContext, Destructible, Printable, ApplicationContext, ApplicationProvider, ComponentsContext, ComponentsProvider, EntityContext, EntityProvider, SceneContext, SceneProvider

public class AudioPlayer
extends Component
implements AudioSourceContext

Field Summary

Fields

Modifier and Type	Field	Description
boolean	autoplay
static final float	DEFAULT_GAIN
static final float	DEFAULT_PITCH
static final float	DEFAULT_VOLUME
AudioSource	source

Fields inherited from class dev.prozilla.pine.core.component.Component

entity, id, isActive

Constructor Summary

Constructors

Constructor	Description
AudioPlayer(AudioSource source)
AudioPlayer(AudioSource source, float volume)
AudioPlayer(String sourcePath)
AudioPlayer(String sourcePath, float volume)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Removes this component from its entity.
boolean	isMuted()
boolean	isPlaying()
void	mute()
void	pause()
void	play()
void	rewind()
void	setGain(float gain)
void	setLoop(boolean loop)
void	setPitch(float pitch)
void	setSource(AudioSource source)
void	setVolume(float volume)
void	toggleMute()
void	unmute()

Methods inherited from class dev.prozilla.pine.core.component.Component

equals, getApplication, getEntity, getName, getScene, hashCode, onEntityChange, setActive, setEntity, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.prozilla.pine.core.ApplicationProvider

getAudioDevice, getConfig, getInput, getLocalStorage, getLogger, getModManager, getRenderer, getTimer, getTracker, getWindow

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

restart, stop, togglePause

Methods inherited from interface dev.prozilla.pine.core.component.ComponentsProvider

getComponent, getComponentInParent, getComponentInParent, getComponents, getComponentsInChildren

Methods inherited from interface dev.prozilla.pine.core.entity.EntityContext

isDescendantOf

Methods inherited from interface dev.prozilla.pine.core.entity.EntityProvider

getChild, getChildWithTag, getFirstChild, getLastChild, getParentWithTag, getTransform, isDescendantOf

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Methods inherited from interface dev.prozilla.pine.core.scene.SceneProvider

getCameraData, getWorld

Field Details

source

public AudioSource source

autoplay

public boolean autoplay

DEFAULT_VOLUME

public static final float DEFAULT_VOLUME

See Also:

• Constant Field Values

DEFAULT_PITCH

public static final float DEFAULT_PITCH

See Also:

• Constant Field Values

DEFAULT_GAIN

public static final float DEFAULT_GAIN

See Also:

• Constant Field Values

Constructor Details

AudioPlayer

public AudioPlayer(String sourcePath)

AudioPlayer

public AudioPlayer(AudioSource source)

AudioPlayer

public AudioPlayer(String sourcePath,
 float volume)

AudioPlayer

public AudioPlayer(AudioSource source,
 float volume)

Method Details

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

setSource

public void setSource(AudioSource source)

isPlaying

public boolean isPlaying()

Specified by:

isPlaying in interface AudioSourceContext

setVolume

public void setVolume(float volume)

Specified by:

setVolume in interface AudioSourceContext

setPitch

public void setPitch(float pitch)

Specified by:

setPitch in interface AudioSourceContext

setGain

public void setGain(float gain)

Specified by:

setGain in interface AudioSourceContext

setLoop

public void setLoop(boolean loop)

Specified by:

setLoop in interface AudioSourceContext

toggleMute

public void toggleMute()

mute

public void mute()

unmute

public void unmute()

isMuted

public boolean isMuted()

destroy

public void destroy()

Description copied from class: Component

Removes this component from its entity.

Specified by:

destroy in interface Destructible

Overrides:

destroy in class Component