de.gurkenlabs.litiengine.sound

Class SoundPlayback

java.lang.Object

de.gurkenlabs.litiengine.sound.SoundPlayback

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

MusicPlayback, SFXPlayback

public abstract class SoundPlayback
extends java.lang.Object
implements java.lang.Runnable

The SoundPlayback class is a wrapper SourceDataLine on which a Sound playback can be carried out.

See Also:

play(Sound)

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.sound.sampled.SourceDataLine	line

Method Summary

Modifier and Type	Method and Description
void	addSoundPlaybackListener(SoundPlaybackListener listener) Adds a SoundPlaybackListener to this instance.
void	cancel() Attempts to cancel the playback of this audio.
protected void	finalize()
float	getMasterVolume() Gets the current volume of this playback, considering all VolumeControl objects created for it.
float	getVolume() Gets the current master volume of this playback.
boolean	isPaused() Determines if this playback is paused.
boolean	isPlaying() Determines if this playback has sound to play.
void	pausePlayback() Pauses this playback.
void	removeSoundPlaybackListener(SoundPlaybackListener listener) Removes a SoundPlaybackListener from this instance.
void	resumePlayback() Resumes this playback.
void	setPaused(boolean paused) Sets the paused state of this playback to the provided value.
void	setVolume(float volume) Sets the master volume of this playback.
void	start() Starts playing the audio.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Runnable

run

Field Detail

line

protected final javax.sound.sampled.SourceDataLine line

Method Detail

start

public void start()

Starts playing the audio.

Throws:

java.lang.IllegalStateException - if the audio has already been started

addSoundPlaybackListener

public void addSoundPlaybackListener(SoundPlaybackListener listener)

Adds a SoundPlaybackListener to this instance.

Parameters:

listener - The SoundPlaybackListener to be added.

removeSoundPlaybackListener

public void removeSoundPlaybackListener(SoundPlaybackListener listener)

Removes a SoundPlaybackListener from this instance.

Parameters:

listener - The SoundPlaybackListener to be removed.

setPaused

public void setPaused(boolean paused)

Sets the paused state of this playback to the provided value.

Parameters:

paused - Whether to pause or resume this playback

pausePlayback

public void pausePlayback()

Pauses this playback. If this playback is already paused, this call has no effect.

resumePlayback

public void resumePlayback()

Resumes this playback. If this playback is already playing, this call has no effect.

isPaused

public boolean isPaused()

Determines if this playback is paused.

Returns:

Whether this playback is paused

isPlaying

public boolean isPlaying()

Determines if this playback has sound to play. If it is paused but still in the middle of playback, it will return true, but it will return false if it has finished or it has been cancelled.

Returns:

Whether this playback has sound to play

cancel

public void cancel()

Attempts to cancel the playback of this audio. If the playback was successfully cancelled, it will notify listeners.

getMasterVolume

public float getMasterVolume()

Gets the current volume of this playback, considering all VolumeControl objects created for it.

Returns:

The current volume.

getVolume

public float getVolume()

Gets the current master volume of this playback. This will be approximately equal to the value set by a previous call to setVolume, though rounding errors may occur.

Returns:

The settable volume.

setVolume

public void setVolume(float volume)

Sets the master volume of this playback.

Parameters:

volume - The new volume.

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object