org.joshvm.media

Class MediaPlayer

java.lang.Object

org.joshvm.media.MediaPlayer

public class MediaPlayer
extends Object

MediaPlayer is used to control playback of audio files.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MediaPlayer() Creates an MediaPlayer. Call release() to release native resources after using the MediaPlayer.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCurrentPosition() Gets the current playback position.
int	getDuration() Gets the total duration of the media source.
int	getPlayState() Returns play state.
boolean	isPlaying() Checks whether the MediaPlayer is playing.
void	pause() Pauses playback.
void	prepare() Prepares the player for playback, asynchronously. When the media source is ready for playback, MediaPlayerListener.onPrepared() will be called.
void	release() Releases the native MediaPlayer resources.
void	reset() Resets the MediaPlayer to its uninitialized state.
void	seekTo(int ms) Seeks to specified time position.
void	setDataSource(String source) Sets the data source.
void	setMediaPlayerListener(MediaPlayerListener listener) Register a callback to be invoked when the media source is ready, or the seek operation is completed, or the end of a media source is reached.
void	start() Starts or resumes playback.
void	stop() Stops playback. Need to call prepare before start again.

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 MediaPlayer state is stopped

See Also:

Constant Field Values

PLAYSTATE_PAUSED

public static final int PLAYSTATE_PAUSED

indicates MediaPlayer state is paused

See Also:

Constant Field Values

PLAYSTATE_PLAYING

public static final int PLAYSTATE_PLAYING

indicates MediaPlayer state is playing

See Also:

Constant Field Values

Constructor Detail

MediaPlayer

public MediaPlayer()
            throws IOException

Creates an MediaPlayer.
Call release() to release native resources after using the MediaPlayer.

Throws:

IOException - if failed to create player

Method Detail

setDataSource

public void setDataSource(String source)
                   throws IOException

Sets the data source.

Data source format examples:

 [local file]      file:///sdcard/1.wav   or   /sdcard/1.wav
 [file in jar]     res://1.wav
 [http URL]        http://xx.com/1.wav
 

Parameters:

source - the path of the file or URL of the data

Throws:

IOException

getPlayState

public int getPlayState()

Returns play state.

See Also:

PLAYSTATE_STOPPED, PLAYSTATE_PAUSED, PLAYSTATE_PLAYING

prepare

public void prepare()
             throws IOException

Prepares the player for playback, asynchronously.
When the media source is ready for playback, MediaPlayerListener.onPrepared() will be called.

Throws:

IOException - if data source has not set or an I/O error occurs

See Also:

setMediaPlayerListener(org.joshvm.media.MediaPlayerListener)

start

public void start()
           throws IOException

Starts or resumes playback. When the end of a media source is reached, MediaPlayerListener.onCompletion() will be called.

Throws:

IOException

pause

public void pause()
           throws IOException

Pauses playback. Call start() to resume.

Throws:

IOException

stop

public void stop()
          throws IOException

Stops playback.
Need to call prepare before start again.

Throws:

IOException

reset

public void reset()
           throws IOException

Resets the MediaPlayer to its uninitialized state. After calling this method, you will have to initialize it again by setting the data source and calling prepare().

Throws:

IOException

release

public void release()
             throws IOException

Releases the native MediaPlayer resources. The object can no longer be used.

Throws:

IOException

getCurrentPosition

public int getCurrentPosition()

Gets the current playback position.

Returns:

the current position in milliseconds, if no position is available, -1 is returned.

getDuration

public int getDuration()

Gets the total duration of the media source.

Returns:

the duration in milliseconds, if no duration is available, -1 is returned.

isPlaying

public boolean isPlaying()

Checks whether the MediaPlayer is playing.

Returns:

true if currently playing, false otherwise

seekTo

public void seekTo(int ms)
            throws IOException

Seeks to specified time position. When the seek operation is completed, MediaPlayerListener.onSeekComplete() will be called.

Parameters:

ms - the offset in milliseconds from the start to seek to

Throws:

IOException

setMediaPlayerListener

public void setMediaPlayerListener(MediaPlayerListener listener)

Register a callback to be invoked when the media source is ready, or the seek operation is completed, or the end of a media source is reached.

Parameters:

listener - the callback that will be run.