StreamPlayer (java-stream-player 9.0.3 API)

java.lang.Object
- com.goxr3plus.streamplayer.stream.StreamPlayer

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Void>

Direct Known Subclasses:

Main
```
public class StreamPlayer
extends java.lang.Object
implements java.util.concurrent.Callable<java.lang.Void>
```
StreamPlayer is a class based on JavaSound API. It has been successfully tested under Java 10

Author:

GOXR3PLUS (www.goxr3plus.co.nf), JavaZOOM (www.javazoom.net)

Constructor Summary

Constructors
Constructor and Description

StreamPlayer()
Constructor.

Constructors
Constructor and Description
`StreamPlayer()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStreamPlayerListener(StreamPlayerListener streamPlayerListener)` Add a listener to be notified.
`java.lang.Void`	`call()` Main loop.
`float`	`getBalance()` Return the balance Value.
`int`	`getDurationInSeconds()`
`int`	`getEncodedStreamPosition()` Calculates the current position of the encoded audio based on nEncodedBytes = encodedAudioLength - encodedAudioInputStream.available();
`float`	`getGainValue()` Returns Gain value.
`int`	`getLineBufferSize()` Return SourceDataLine buffer size.
`int`	`getLineCurrentBufferSize()` Return SourceDataLine current buffer size.
`float`	`getMaximumGain()` Returns maximum Gain value.
`float`	`getMinimumGain()` Returns minimum Gain value.
`java.util.List<java.lang.String>`	`getMixers()` Returns all available mixers.
`boolean`	`getMute()` Return the mute Value(true \|\| false).
`float`	`getPan()` Returns Pan value.
`int`	`getPositionByte()`
`float`	`getPrecision()` Returns Pan precision.
`javax.sound.sampled.SourceDataLine`	`getSourceDataLine()` Gets the source data line.
`double`	`getSpeedFactor()`
`Status`	`getStatus()` This method will return the status of the player
`long`	`getTotalBytes()` Return the total size of this file in bytes.
`boolean`	`isOpened()` Checks if is opened.
`boolean`	`isPaused()` Checks if is paused.
`boolean`	`isPausedOrPlaying()` Checks if is paused or playing.
`boolean`	`isPlaying()` Checks if is playing.
`boolean`	`isSeeking()` Checks if is seeking.
`boolean`	`isStopped()` Checks if is stopped.
`boolean`	`isUnknown()` Checks if is unknown.
`void`	`open(java.lang.Object object)` Open the specific object which can be File,URL or InputStream.
`boolean`	`pause()` Pauses the play back.
`void`	`play()` Starts the play back.
`void`	`removeStreamPlayerListener(StreamPlayerListener streamPlayerListener)` Remove registered listener.
`void`	`reset()` Freeing the resources.
`boolean`	`resume()` Resumes the play back.
`long`	`seekBytes(long bytes)` Skip bytes in the File input stream.
`long`	`seekSeconds(int seconds)` Skip x seconds of audio See `seekBytes(long)`
`long`	`seekTo(int seconds)` Go to X time of the Audio See `seekBytes(long)`
`void`	`setBalance(float fBalance)` Represents a control for the relative balance of a stereo signal between two stereo speakers.
`void`	`setEqualizer(float[] array, int stop)` Changes specific values from equalizer.
`void`	`setEqualizerKey(float value, int key)` Changes a value from equalizer.
`void`	`setGain(double fGain)` Sets Gain value.
`void`	`setLineBufferSize(int size)` Set SourceDataLine buffer size.
`void`	`setMute(boolean mute)` Set the mute of the Line.
`void`	`setPan(double fPan)` Sets Pan value.
`void`	`setSpeedFactor(double speedFactor)` Change the Speed Rate of the Audio , this variable affects the Sample Rate , for example 1.0 is normal , 0.5 is half the speed and 2.0 is double the speed Note that you have to restart the audio for this to take effect
`void`	`stop()` Stops the play back.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StreamPlayer
```
public StreamPlayer()
```
    Constructor.
- Method Detail
  - reset
```
public void reset()
```
    Freeing the resources.
  - addStreamPlayerListener
```
public void addStreamPlayerListener(StreamPlayerListener streamPlayerListener)
```
    Add a listener to be notified.
    
    Parameters:
    
    streamPlayerListener - the listener
  - removeStreamPlayerListener
```
public void removeStreamPlayerListener(StreamPlayerListener streamPlayerListener)
```
    Remove registered listener.
    
    Parameters:
    
    streamPlayerListener - the listener
  - open
```
public void open(java.lang.Object object)
          throws StreamPlayerException
```
    Open the specific object which can be File,URL or InputStream.
    
    Parameters:
    
    object - the object [File or URL or InputStream ]
    
    Throws:
    
    StreamPlayerException - the stream player exception
  - setSpeedFactor
```
public void setSpeedFactor(double speedFactor)
```
    Change the Speed Rate of the Audio , this variable affects the Sample Rate , for example 1.0 is normal , 0.5 is half the speed and 2.0 is double the speed Note that you have to restart the audio for this to take effect
    
    Parameters:
    
    speedFactor - speedFactor
  - play
```
public void play()
          throws StreamPlayerException
```
    Starts the play back.
    
    Throws:
    
    StreamPlayerException - the stream player exception
  - pause
```
public boolean pause()
```
    Pauses the play back.
    
    Player Status = PAUSED. * @return False if failed(so simple...)
    
    Returns:
    
    true, if successful
  - stop
```
public void stop()
```
    Stops the play back.
    
    Player Status = STOPPED.
    Thread should free Audio resources.
  - resume
```
public boolean resume()
```
    Resumes the play back.
    
    Player Status = PLAYING*
    
    Returns:
    
    False if failed(so simple...)
  - seekBytes
```
public long seekBytes(long bytes)
               throws StreamPlayerException
```
    Skip bytes in the File input stream. It will skip N frames matching to bytes, so it will never skip given bytes len
    
    Parameters:
    
    bytes - the bytes
    
    Returns:
    
    value bigger than 0 for File and value = 0 for URL and InputStream
    
    Throws:
    
    StreamPlayerException - the stream player exception
  - seekSeconds
```
public long seekSeconds(int seconds)
                 throws java.lang.Exception
```
    Skip x seconds of audio See seekBytes(long)
    
    Parameters:
    
    seconds - Seconds to Skip
    
    Throws:
    
    java.lang.Exception
  - seekTo
```
public long seekTo(int seconds)
            throws java.lang.Exception
```
    Go to X time of the Audio See seekBytes(long)
    
    Parameters:
    
    seconds - Seconds to Skip
    
    Throws:
    
    java.lang.Exception
  - getDurationInSeconds
```
public int getDurationInSeconds()
```
  - call
```
public java.lang.Void call()
```
    Main loop.
    Player Status == STOPPED || SEEKING = End of Thread + Freeing Audio Resources.
    Player Status == PLAYING = Audio stream data sent to Audio line.
    Player Status == PAUSED = Waiting for another status.
    
    Specified by:
    
    call in interface java.util.concurrent.Callable<java.lang.Void>
  - getEncodedStreamPosition
```
public int getEncodedStreamPosition()
```
    Calculates the current position of the encoded audio based on
    nEncodedBytes = encodedAudioLength - encodedAudioInputStream.available();
    
    Returns:
    
    The Position of the encoded stream in term of bytes
  - getLineBufferSize
```
public int getLineBufferSize()
```
    Return SourceDataLine buffer size.
    
    Returns:
    
    -1 maximum buffer size.
  - getLineCurrentBufferSize
```
public int getLineCurrentBufferSize()
```
    Return SourceDataLine current buffer size.
    
    Returns:
    
    The current line buffer size
  - getMixers
```
public java.util.List<java.lang.String> getMixers()
```
    Returns all available mixers.
    
    Returns:
    
    A List of available Mixers
  - getGainValue
```
public float getGainValue()
```
    Returns Gain value.
    
    Returns:
    
    The Gain Value
  - getMaximumGain
```
public float getMaximumGain()
```
    Returns maximum Gain value.
    
    Returns:
    
    The Maximum Gain Value
  - getMinimumGain
```
public float getMinimumGain()
```
    Returns minimum Gain value.
    
    Returns:
    
    The Minimum Gain Value
  - getPrecision
```
public float getPrecision()
```
    Returns Pan precision.
    
    Returns:
    
    The Precision Value
  - getPan
```
public float getPan()
```
    Returns Pan value.
    
    Returns:
    
    The Pan Value
  - getMute
```
public boolean getMute()
```
    Return the mute Value(true || false).
    
    Returns:
    
    True if muted , False if not
  - getBalance
```
public float getBalance()
```
    Return the balance Value.
    
    Returns:
    
    The Balance Value
  - getTotalBytes
```
public long getTotalBytes()
```
    Return the total size of this file in bytes.
    
    Returns:
    
    encodedAudioLength
  - getPositionByte
```
public int getPositionByte()
```
    Returns:
    
    BytePosition
  - getSourceDataLine
```
public javax.sound.sampled.SourceDataLine getSourceDataLine()
```
    Gets the source data line.
    
    Returns:
    
    The SourceDataLine
  - getStatus
```
public Status getStatus()
```
    This method will return the status of the player
    
    Returns:
    
    The Player Status
  - setLineBufferSize
```
public void setLineBufferSize(int size)
```
    Set SourceDataLine buffer size. It affects audio latency. (the delay between line.write(data) and real sound). Minimum value should be over 10000 bytes.
    
    Parameters:
    
    size - -1 means maximum buffer size available.
  - setPan
```
public void setPan(double fPan)
```
    Sets Pan value. Line should be opened before calling this method. Linear scale : -1.0 ... +1.0
    
    Parameters:
    
    fPan - the new pan
  - setGain
```
public void setGain(double fGain)
```
    Sets Gain value. Line should be opened before calling this method. Linear scale 0.0 ... 1.0 Threshold Coef. : 1/2 to avoid saturation.
    
    Parameters:
    
    fGain - The new gain value
  - setMute
```
public void setMute(boolean mute)
```
    Set the mute of the Line. Note that mute status does not affect gain.
    
    Parameters:
    
    mute - True to mute the audio of False to unmute it
  - setBalance
```
public void setBalance(float fBalance)
```
    Represents a control for the relative balance of a stereo signal between two stereo speakers. The valid range of values is -1.0 (left channel only) to 1.0 (right channel only). The default is 0.0 (centered).
    
    Parameters:
    
    fBalance - the new balance
  - setEqualizer
```
public void setEqualizer(float[] array,
                         int stop)
```
    Changes specific values from equalizer.
    
    Parameters:
    
    array - the array
    
    stop - the stop
  - setEqualizerKey
```
public void setEqualizerKey(float value,
                            int key)
```
    Changes a value from equalizer.
    
    Parameters:
    
    value - the value
    
    key - the key
  - getSpeedFactor
```
public double getSpeedFactor()
```
    Returns:
    
    The Speech Factor of the Audio
  - isUnknown
```
public boolean isUnknown()
```
    Checks if is unknown.
    
    Returns:
    
    If Status==STATUS.UNKNOWN.
  - isPlaying
```
public boolean isPlaying()
```
    Checks if is playing.
    
    Returns:
    
    true if player is playing ,false if not.
  - isPaused
```
public boolean isPaused()
```
    Checks if is paused.
    
    Returns:
    
    true if player is paused ,false if not.
  - isPausedOrPlaying
```
public boolean isPausedOrPlaying()
```
    Checks if is paused or playing.
    
    Returns:
    
    true if player is paused/playing,false if not
  - isStopped
```
public boolean isStopped()
```
    Checks if is stopped.
    
    Returns:
    
    true if player is stopped ,false if not
  - isOpened
```
public boolean isOpened()
```
    Checks if is opened.
    
    Returns:
    
    true if player is opened ,false if not
  - isSeeking
```
public boolean isSeeking()
```
    Checks if is seeking.
    
    Returns:
    
    true if player is seeking ,false if not

Class StreamPlayer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamPlayer

Method Detail

reset

addStreamPlayerListener

removeStreamPlayerListener

open

setSpeedFactor

play

pause

stop

resume

seekBytes

seekSeconds

seekTo

getDurationInSeconds

call

getEncodedStreamPosition

getLineBufferSize

getLineCurrentBufferSize

getMixers

getGainValue

getMaximumGain

getMinimumGain

getPrecision

getPan

getMute

getBalance

getTotalBytes

getPositionByte

getSourceDataLine

getStatus

setLineBufferSize

setPan

setGain

setMute

setBalance

setEqualizer

setEqualizerKey

getSpeedFactor

isUnknown

isPlaying

isPaused

isPausedOrPlaying

isStopped

isOpened

isSeeking