Package ca.corbett.extras.audio

Class PlaybackThread

java.lang.Object

ca.corbett.extras.audio.PlaybackThread

All Implemented Interfaces:

Runnable

public class PlaybackThread
extends Object
implements Runnable

Provides a worker thread that can be used to play audio clips. You can instantiate this directly, but it's easier to go through the various play() wrapper functions in AudioUtil to generate and start the thread for you.

Since:

2018-01-10

Author:

scorbo2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlaybackThread.StopReason

Field Summary

Fields

Modifier and Type	Field	Description
protected final Clip	clip
protected boolean	isPlaying
protected long	lastPlayPositionms
protected final long	limitms
protected final List<PlaybackListener>	listeners
protected final long	offsetms
protected PlaybackThread.StopReason	stopReason
protected static int	UPDATE_MS

Constructor Summary

Constructors

Constructor	Description
PlaybackThread(AudioInputStream audioStream, long offset, long limit, PlaybackListener listener)

Method Summary

Modifier and Type	Method	Description
void	addPlaybackListener(PlaybackListener listener)
protected boolean	fireProgressEvent(long current, long total)
protected void	fireStartedEvent()
protected void	fireStopEvent(PlaybackThread.StopReason stopReason)
long	getCurrentOffset()	Returns the current offset, in milliseconds, of the playback.
static int	getUpdateIntervalMs()
boolean	isPlaying()
void	removePlaybackListener(PlaybackListener listener)
void	run()
static void	setUpdateIntervalMs(int ms)
void	stop()

Methods inherited from class java.lang.Object

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

Field Details

UPDATE_MS

protected static int UPDATE_MS

clip

protected final Clip clip

isPlaying

protected volatile boolean isPlaying

offsetms

protected final long offsetms

limitms

protected final long limitms

lastPlayPositionms

protected long lastPlayPositionms

listeners

protected final List<PlaybackListener> listeners

stopReason

protected volatile PlaybackThread.StopReason stopReason

Constructor Details

PlaybackThread

public PlaybackThread(AudioInputStream audioStream,
 long offset,
 long limit,
 PlaybackListener listener)
               throws LineUnavailableException,
IOException

Throws:

LineUnavailableException

IOException

Method Details

isPlaying

public boolean isPlaying()

stop

public void stop()

getCurrentOffset

public long getCurrentOffset()

Returns the current offset, in milliseconds, of the playback. If the playback is stopped, this value will represent the last playback position.

Returns:

The current offset, in ms, of the playback.

getUpdateIntervalMs

public static int getUpdateIntervalMs()

setUpdateIntervalMs

public static void setUpdateIntervalMs(int ms)

run

public void run()

Specified by:

run in interface Runnable

addPlaybackListener

public void addPlaybackListener(PlaybackListener listener)

removePlaybackListener

public void removePlaybackListener(PlaybackListener listener)

fireStartedEvent

protected void fireStartedEvent()

fireProgressEvent

protected boolean fireProgressEvent(long current,
 long total)

fireStopEvent

protected void fireStopEvent(PlaybackThread.StopReason stopReason)