Class JavaStreamingAudioPlayer
- All Implemented Interfaces:
AudioPlayer
com.sun.speech.freetts.audio.AudioPlayer.drainWorksProperly;
to true
.
If the workaround is enabled, the line.isActive method will be
performed periodically. The period of the test can be controlled
with:
com.sun.speech.freetts.audio.AudioPlayer.drainDelay"
The default if 5ms.
The property
com.sun.speech.freetts.audio.AudioPlayer.bufferSize"
Controls the audio buffer size, it defaults to 8192
Even with this drain work around, there are some issues with this
class. The workaround drain is not completely reliable.
A resume
following a pause
does not
always continue at the proper position in the audio. On a rare
occasion, sound output will be repeated a number of times. This may
be related to bug 4421330 in the Bug Parade database.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
begin
(int size) Starts the output of a set of data.void
cancel()
Cancels currently playing audio.void
close()
Closes this audio playerboolean
drain()
Waits for all queued audio to be playedboolean
end()
Marks the end of a set of data.Gets the audio format for this playerlong
getTime()
Gets the amount of played since the last markfloat
Returns the current volume.void
pause()
Pauses audio outputvoid
reset()
Prepares for another batch of output.void
Resets the audio clockvoid
resume()
Resumes audio outputvoid
setAudioFormat
(AudioFormat format) Sets the audio format for this playervoid
setVolume
(float volume) Sets the current volume.void
Shows metrics for this audio playervoid
Starts the first sample timertoString()
Returns the name of this audioplayerboolean
write
(byte[] audioData) Writes the given bytes to the audio streamboolean
write
(byte[] bytes, int offset, int size) Writes the given bytes to the audio stream
-
Constructor Details
-
JavaStreamingAudioPlayer
public JavaStreamingAudioPlayer()Constructs a default JavaStreamingAudioPlayer
-
-
Method Details
-
setAudioFormat
Sets the audio format for this player- Specified by:
setAudioFormat
in interfaceAudioPlayer
- Parameters:
format
- the audio format- Throws:
UnsupportedOperationException
- if the line cannot be opened with the given format
-
getAudioFormat
Gets the audio format for this player- Specified by:
getAudioFormat
in interfaceAudioPlayer
- Returns:
- format the audio format
-
startFirstSampleTimer
public void startFirstSampleTimer()Starts the first sample timer- Specified by:
startFirstSampleTimer
in interfaceAudioPlayer
-
pause
public void pause()Pauses audio output- Specified by:
pause
in interfaceAudioPlayer
-
resume
public void resume()Resumes audio output- Specified by:
resume
in interfaceAudioPlayer
-
cancel
public void cancel()Cancels currently playing audio.- Specified by:
cancel
in interfaceAudioPlayer
-
reset
public void reset()Prepares for another batch of output. Larger groups of output (such as all output associated with a single FreeTTSSpeakable) should be grouped between a reset/drain pair.- Specified by:
reset
in interfaceAudioPlayer
-
close
public void close()Closes this audio player- Specified by:
close
in interfaceAudioPlayer
-
getVolume
public float getVolume()Returns the current volume.- Specified by:
getVolume
in interfaceAudioPlayer
- Returns:
- the current volume (between 0 and 1)
-
setVolume
public void setVolume(float volume) Sets the current volume.- Specified by:
setVolume
in interfaceAudioPlayer
- Parameters:
volume
- the current volume (between 0 and 1)
-
begin
public void begin(int size) Starts the output of a set of data. For this JavaStreamingAudioPlayer, it actually opens the audio line. Since this is a streaming audio player, thesize
parameter has no meaning and effect at all, so any value can be used. Audio data for a single utterance should be grouped between begin/end pairs.- Specified by:
begin
in interfaceAudioPlayer
- Parameters:
size
- supposedly the size of data between now and the end, but since this is a streaming audio player, this parameter has no meaning and effect at all
-
end
public boolean end()Marks the end of a set of data. Audio data for a single utterance should be groupd between begin/end pairs.- Specified by:
end
in interfaceAudioPlayer
- Returns:
- true if the audio was output properly, false if the output was cancelled or interrupted.
-
drain
public boolean drain()Waits for all queued audio to be played- Specified by:
drain
in interfaceAudioPlayer
- Returns:
- true if the audio played to completion, false if the audio was stopped [[[ WORKAROUND TODO The javax.sound.sampled drain is almost working properly. On linux, there is still a little bit of sound that needs to go out, even after drain is called. Thus, the drainDelay. We wait for a few hundred milliseconds while the data is really drained out of the system ]]]
-
getTime
public long getTime()Gets the amount of played since the last mark- Specified by:
getTime
in interfaceAudioPlayer
- Returns:
- the amount of audio in milliseconds
-
resetTime
public void resetTime()Resets the audio clock- Specified by:
resetTime
in interfaceAudioPlayer
-
write
public boolean write(byte[] audioData) Writes the given bytes to the audio stream- Specified by:
write
in interfaceAudioPlayer
- Parameters:
audioData
- audio data to write to the device- Returns:
true
of the write completed successfully,false
if the write was cancelled.
-
write
public boolean write(byte[] bytes, int offset, int size) Writes the given bytes to the audio stream- Specified by:
write
in interfaceAudioPlayer
- Parameters:
bytes
- audio data to write to the deviceoffset
- the offset into the buffersize
- the size into the buffer- Returns:
true
of the write completed successfully,false
if the write was cancelled.
-
toString
Returns the name of this audioplayer -
showMetrics
public void showMetrics()Shows metrics for this audio player- Specified by:
showMetrics
in interfaceAudioPlayer
-