Class LinePlayer

java.lang.Object

net.avadeaux.klipspringer.codec.LinePlayer

All Implemented Interfaces:

Closeable, AutoCloseable, Device.Player, PcmWriter

public class LinePlayer
extends Object
implements Device.Player

Audio output adapter for writing to a SourceDataLine.

Nested Class Summary

Nested classes/interfaces inherited from interface net.avadeaux.klipspringer.codec.Device.Player

Device.Player.Factory

Constructor Summary

Constructors

Constructor	Description
LinePlayer(SourceDataLine line, boolean paused)	Constructs a player for the given line.

Method Summary

Modifier and Type	Method	Description
int	bufferedFrames()	Gets an estimate of how many frames are currently buffered, waiting to be played.
boolean	canPause()	Returns true.
void	close()	See Closeable.close().
void	drain()	Waits for player to send on any data it has buffered up and closes it.
PcmFormat	format()	Gets the audio expected by the player.
Device.BitLayout	layout()	Gets the bit layout expected by the player.
void	pause()	Pauses, if this optional operation is supported, audio playback at the destination.
void	unpause()	Resumes paused audio playback at the destination.
boolean	write(ByteBuffer data)	Writes a block of audio data in the bit layout expected by the player.

Methods inherited from class java.lang.Object

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

Constructor Details

LinePlayer

public LinePlayer(SourceDataLine line,
 boolean paused)
           throws IOException

Constructs a player for the given line. Opens the line if not already open, and starts it unless the paused parameter is true.

Throws:

IOException

Method Details

format

public PcmFormat format()

Description copied from interface: Device.Player

Gets the audio expected by the player.

Specified by:

format in interface Device.Player

layout

public Device.BitLayout layout()

Description copied from interface: Device.Player

Gets the bit layout expected by the player. If the player is produced by a Factory, the layout should match the value returned by Device.Player.Factory.layout(PcmFormat), and if the player is associated with a device, this should match what is returned by Device.layout(PcmFormat). Default returns Device.BitLayout.LSB. Default returns Device.BitLayout.LSB.

Specified by:

layout in interface Device.Player

write

public boolean write(ByteBuffer data)
              throws IOException

Description copied from interface: Device.Player

Writes a block of audio data in the bit layout expected by the player. For most players, it makes sense to always return true, since players do not usually have a limit on the stream.

Specified by:

write in interface Device.Player

Specified by:

write in interface PcmWriter

Throws:

IOException

bufferedFrames

public int bufferedFrames()

Description copied from interface: Device.Player

Gets an estimate of how many frames are currently buffered, waiting to be played. Default returns zero.

Specified by:

bufferedFrames in interface Device.Player

canPause

public boolean canPause()

Returns true.

Specified by:

canPause in interface Device.Player

pause

public void pause()

Description copied from interface: Device.Player

Pauses, if this optional operation is supported, audio playback at the destination. Pausing during write may have the effect that write returns false, with the buffer position set to where writing stopped. If already in paused state, this method does nothing. Default implementation throws UnsupportedOperationException.

Specified by:

pause in interface Device.Player

unpause

public void unpause()

Description copied from interface: Device.Player

Resumes paused audio playback at the destination. If already in playback state, or if pausing is not supported, this method does nothing (the default).

Specified by:

unpause in interface Device.Player

drain

public void drain()

Description copied from interface: Device.Player

Waits for player to send on any data it has buffered up and closes it. Default implementation calls PcmWriter.close() immediately.

Specified by:

drain in interface Device.Player

close

public void close()

Description copied from interface: PcmWriter

See Closeable.close().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface PcmWriter