org.joshvm.media

Class AudioTrack

java.lang.Object

org.joshvm.media.AudioTrack

public class AudioTrack
extends Object

AudioTrack is used to play a single audio resource.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PLAYSTATE_PAUSED indicates AudioTrack state is paused
static int	PLAYSTATE_PLAYING indicates AudioTrack state is playing
static int	PLAYSTATE_STOPPED indicates AudioTrack state is stopped

Constructor Summary

Constructors

Constructor and Description
AudioTrack() Creates an AudioTrack. Call release() to release native resources after using it.

Method Summary

Methods

Modifier and Type	Method and Description
void	flush() Flushes the audio data currently queued for playback.
int	getBufferSize() Returns native buffer size.
int	getPlayState() Returns play state.
void	pause() Pauses the playback of the audio data.
void	play() Start playing
void	release() Releases the native AudioTrack resources.
void	setAudioBitRate(int audioBitRate) Set bit rate.
void	setAudioSampleRate(int sampleRateInHz) Set audio sample rate in Hertz.
void	setChannelConfig(int channelConfig) Set the configuration of the audio channels.
void	stop() Stops playing the audio data.
int	write(byte[] audioData, int offset, int size) Writes the audio data to the audio sink for playback, block until all data has been written to the audio sink.

Methods inherited from class java.lang.Object

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

Field Detail

PLAYSTATE_STOPPED

public static final int PLAYSTATE_STOPPED

indicates AudioTrack state is stopped

See Also:

Constant Field Values

PLAYSTATE_PAUSED

public static final int PLAYSTATE_PAUSED

indicates AudioTrack state is paused

See Also:

Constant Field Values

PLAYSTATE_PLAYING

public static final int PLAYSTATE_PLAYING

indicates AudioTrack state is playing

See Also:

Constant Field Values

Constructor Detail

AudioTrack

public AudioTrack()
           throws IOException

Creates an AudioTrack.
Call release() to release native resources after using it.

Throws:

IOException - if failed to create AudioTrack

Method Detail

setAudioSampleRate

public void setAudioSampleRate(int sampleRateInHz)
                        throws IllegalArgumentException

Set audio sample rate in Hertz.

Parameters:

sampleRateInHz - sample rate. Normally use 8000, 16000, 22050, 44100, 48000. Default is 16000.

Throws:

IllegalArgumentException

setChannelConfig

public void setChannelConfig(int channelConfig)
                      throws IllegalArgumentException

Set the configuration of the audio channels.

Parameters:

channelConfig - audio channel configuration. See AudioFormat.CHANNEL_MONO and AudioFormat.CHANNEL_STEREO. Default is CHANNEL_MONO

Throws:

IllegalArgumentException

setAudioBitRate

public void setAudioBitRate(int audioBitRate)
                     throws IllegalArgumentException

Set bit rate.

Parameters:

audioBitRate - bit per sample. Normally use 8, 16. Default is 16

Throws:

IllegalArgumentException

getBufferSize

public int getBufferSize()

Returns native buffer size.

getPlayState

public int getPlayState()

Returns play state.

See Also:

PLAYSTATE_STOPPED, PLAYSTATE_PAUSED, PLAYSTATE_PLAYING

write

public int write(byte[] audioData,
        int offset,
        int size)
          throws IOException

Writes the audio data to the audio sink for playback, block until all data has been written to the audio sink.

Parameters:

audioData - the array that holds the data to play.

offset - the start offset in the audioData

size - the number of bytes to write

Returns:

number of bytes written

Throws:

IOException - if an I/O error occurs or player has been stopped.

play

public void play()
          throws IOException

Start playing

Throws:

IOException - if an I/O error occurs

pause

public void pause()
           throws IOException

Pauses the playback of the audio data. Data that has not been played back will not be discarded. Subsequent calls to play() will play this data back. See flush() to discard this data.

Throws:

IOException - if an I/O error occurs

flush

public void flush()
           throws IOException

Flushes the audio data currently queued for playback. Any data that has not been played back will be discarded. No-op if not stopped or paused.

Throws:

IOException - if an I/O error occurs

stop

public void stop()
          throws IOException

Stops playing the audio data. Audio will stop playing after the last buffer that was written has been played. For an immediate stop, use pause(), followed by flush() to discard audio data that hasn't been played back yet.

Throws:

IOException - if an I/O error occurs

release

public void release()
             throws IOException

Releases the native AudioTrack resources.

Throws:

IOException - if an I/O error occurs