com.dff.cordova.plugin.mediaplayer

Class AudioPlayerTask

java.lang.Object

android.os.AsyncTask<java.lang.Void,java.lang.Void,java.lang.Void>

com.dff.cordova.plugin.mediaplayer.AudioPlayerTask

All Implemented Interfaces:

android.media.MediaPlayer.OnCompletionListener, android.media.MediaPlayer.OnErrorListener, android.media.MediaPlayer.OnPreparedListener

public class AudioPlayerTask
extends android.os.AsyncTask<java.lang.Void,java.lang.Void,java.lang.Void>
implements android.media.MediaPlayer.OnPreparedListener, android.media.MediaPlayer.OnErrorListener, android.media.MediaPlayer.OnCompletionListener

AsyncTsk Class consists to play audio files in the background. Since the Async Tasks do not follow the activity instances's life cycle, the task will be performed till the end even if the activity get destroyed. The AsyncTask will not die.

Since:

17.11.2016

Nested Class Summary

Nested classes/interfaces inherited from class android.os.AsyncTask

android.os.AsyncTask.Status

Field Summary

Fields inherited from class android.os.AsyncTask

SERIAL_EXECUTOR, THREAD_POOL_EXECUTOR

Constructor Summary

Constructors

Constructor and Description
AudioPlayerTask(java.lang.String filePath, CordovaInterface cordova, CallbackContext callbackContext) Initializing the mediaplayer

Method Summary

Modifier and Type	Method and Description
protected java.lang.Void	doInBackground(java.lang.Void... arg0) Perform playing the audio file in the background async
void	onCompletion(android.media.MediaPlayer mp) Destroy the mediaplayer when the audio file ends and then send a success callback to JS
boolean	onError(android.media.MediaPlayer mp, int what, int extra) Destroy the mediaplayer and send an error callback to JS
void	onPrepared(android.media.MediaPlayer mp) When the mediaplayer is done with preparing async, the mediaplayer is ready for playback and the task will be executed and respectively the audio file will be played.

Methods inherited from class android.os.AsyncTask

cancel, execute, execute, executeOnExecutor, get, get, getStatus, isCancelled, onCancelled, onCancelled, onPostExecute, onPreExecute, onProgressUpdate, publishProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioPlayerTask

public AudioPlayerTask(java.lang.String filePath,
                       CordovaInterface cordova,
                       CallbackContext callbackContext)

Initializing the mediaplayer

Parameters:

filePath - The path of the audio file

cordova - The cordova interface used

callbackContext - The callback context used when calling back into JavaScript

Method Detail

onPrepared

public void onPrepared(android.media.MediaPlayer mp)

When the mediaplayer is done with preparing async, the mediaplayer is ready for playback and the task will be executed and respectively the audio file will be played.

Specified by:

onPrepared in interface android.media.MediaPlayer.OnPreparedListener

Parameters:

mp - The mediaplayer that has been prepared and ready for playback

onCompletion

public void onCompletion(android.media.MediaPlayer mp)

Destroy the mediaplayer when the audio file ends and then send a success callback to JS

Specified by:

onCompletion in interface android.media.MediaPlayer.OnCompletionListener

Parameters:

mp - The mediaplayer that plays the audio file and will be released

onError

public boolean onError(android.media.MediaPlayer mp,
                       int what,
                       int extra)

Destroy the mediaplayer and send an error callback to JS

Specified by:

onError in interface android.media.MediaPlayer.OnErrorListener

Parameters:

mp - The mediaplayer, which faced an error

what - Type of the error occurred

extra - an extra code, specific to the error

Returns:

whether the error is handled

doInBackground

protected java.lang.Void doInBackground(java.lang.Void... arg0)

Perform playing the audio file in the background async

Specified by:

doInBackground in class android.os.AsyncTask<java.lang.Void,java.lang.Void,java.lang.Void>

Parameters:

arg0 - No args

Returns:

Nothing to return