com.devbrackets.android.exomedia

Class EMAudioPlayer

java.lang.Object

com.devbrackets.android.exomedia.EMAudioPlayer

All Implemented Interfaces:

com.google.android.exoplayer.audio.AudioCapabilitiesReceiver.Listener

public class EMAudioPlayer
extends java.lang.Object
implements com.google.android.exoplayer.audio.AudioCapabilitiesReceiver.Listener

An AudioPlayer that uses the ExoPlayer as the backing architecture. If the current device does NOT pass the Android Compatibility Test Suite (CTS) then the backing architecture will fall back to using the default Android MediaPlayer.

To help with quick conversions from the Android MediaPlayer this class follows the APIs the MediaPlayer provides.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EMAudioPlayer.AudioType

Constructor Summary

Constructors

Constructor and Description
EMAudioPlayer(Context context)

Method Summary

Modifier and Type	Method and Description
void	addExoPlayerListener(ExoPlayerListener listener) Sets the listener to inform of any exoPlayer events
int	getAudioSessionId() Returns the audio session ID.
int	getBufferPercentage() Retrieves the current buffer percent of the audio item.
long	getCurrentPosition() Retrieves the current position of the audio playback.
long	getDuration() Retrieves the duration of the current audio item.
java.lang.String	getUserAgent() Retrieves the user agent that the EMAudioPlayer will use when communicating with media servers
boolean	isPlaying() Returns if an audio item is currently in playback
void	onAudioCapabilitiesChanged(com.google.android.exoplayer.audio.AudioCapabilities audioCapabilities)
void	overrideDuration(int duration) Setting this will override the duration that the item may actually be.
void	overridePosition(boolean override) Sets if the audio position should be overridden, allowing the time to be restarted at will.
void	pause() If an audio item is currently in playback, it will be paused and the progressPoll will be stopped (see startProgressPoll(EMEventBus))
void	prepareAsync()
void	release()
void	removeExoPlayerListener(ExoPlayerListener listener) Removes the specified listener for the ExoPlayer.
void	reset() Stops the current audio playback and resets the listener states so that we receive the callbacks for events like onPrepared
void	restartOverridePosition() Restarts the audio position to the start if the position is being overridden (see overridePosition(boolean)).
void	seekTo(int milliSeconds) Moves the current audio progress to the specified location.
void	setAudioStreamType(int steamType)
void	setBus(EMEventBus bus) Sets the bus to use for dispatching Events such as the poll progress
void	setDataSource(Context context, Uri uri) Sets the source path for the audio item.
void	setDataSource(Context context, Uri uri, MediaUtil.MediaType defaultMediaType) Sets the source path for the audio item.
void	setOnBufferingUpdateListener(android.media.MediaPlayer.OnBufferingUpdateListener listener) Sets the listener to inform of buffering updates
void	setOnCompletionListener(MediaPlayer.OnCompletionListener listener) Sets the listener to inform of VideoPlayer completion events.
void	setOnErrorListener(MediaPlayer.OnErrorListener listener) Sets the listener to inform of playback errors.
void	setOnInfoListener(MediaPlayer.OnInfoListener listener) Sets the listener to inform of media information events.
void	setOnPreparedListener(MediaPlayer.OnPreparedListener listener) Sets the listener to inform of VideoPlayer prepared events.
void	setPositionOffset(int offset) Sets the amount of time to change the return value from getCurrentPosition().
void	setProgressPollDelay(int milliSeconds) Sets the delay to use when notifying of progress.
void	setVolume(float leftVolume, float rightVolume) Sets the volume level for the audio playback.
void	setWakeMode(Context context, int mode)
void	start() Starts the playback for the audio item specified in #setDataSource(android.content.Context, android.net.Uri).
void	startProgressPoll(EMEventBus bus) Starts the progress poll.
void	startProgressPoll(EMProgressCallback callback) Starts the progress poll with the callback to be informed of the progress events.
void	stopPlayback() If an audio item is currently in playback then the playback will be stopped and the progressPoll will be stopped (see startProgressPoll(EMEventBus))
void	stopProgressPoll() Stops the progress poll (see startProgressPoll(EMEventBus))

Methods inherited from class java.lang.Object

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

Constructor Detail

EMAudioPlayer

public EMAudioPlayer(Context context)

Method Detail

onAudioCapabilitiesChanged

public void onAudioCapabilitiesChanged(com.google.android.exoplayer.audio.AudioCapabilities audioCapabilities)

Specified by:

onAudioCapabilitiesChanged in interface com.google.android.exoplayer.audio.AudioCapabilitiesReceiver.Listener

setProgressPollDelay

public void setProgressPollDelay(int milliSeconds)

Sets the delay to use when notifying of progress. The default is 33 milliseconds, or 30 frames-per-second

Parameters:

milliSeconds - The millisecond delay to use

setBus

public void setBus(EMEventBus bus)

Sets the bus to use for dispatching Events such as the poll progress

Parameters:

bus - The EventBus to dispatch events on

startProgressPoll

public void startProgressPoll(EMEventBus bus)

Starts the progress poll.

Parameters:

bus - The EventBus event dispatcher that the listener is connected to

startProgressPoll

public void startProgressPoll(EMProgressCallback callback)

Starts the progress poll with the callback to be informed of the progress events.

Parameters:

callback - The Callback to inform of progress events

stopProgressPoll

public void stopProgressPoll()

Stops the progress poll (see startProgressPoll(EMEventBus))

getUserAgent

public java.lang.String getUserAgent()

Retrieves the user agent that the EMAudioPlayer will use when communicating with media servers

Returns:

The String user agent for the EMAudioPlayer

getAudioSessionId

public int getAudioSessionId()

Returns the audio session ID.

Returns:

the audio session ID. Note that the audio session ID is 0 only if a problem occurred when the AudioPlayer was constructed or the audio stream hasn't been instantiated.

setAudioStreamType

public void setAudioStreamType(int steamType)

setDataSource

public void setDataSource(Context context,
                          Uri uri)

Sets the source path for the audio item. This path can be a web address (e.g. http://) or an absolute local path (e.g. file://). Uses MP3 as the default for media type.

Parameters:

context - The applications context that owns the media

uri - The Uri representing the path to the audio item

setDataSource

public void setDataSource(Context context,
                          Uri uri,
                          MediaUtil.MediaType defaultMediaType)

Sets the source path for the audio item. This path can be a web address (e.g. http://) or an absolute local path (e.g. file://)

Parameters:

context - The applications context that owns the media

uri - The Uri representing the path to the audio item

defaultMediaType - The MediaType to use when auto-detection fails

prepareAsync

public void prepareAsync()

setVolume

public void setVolume(float leftVolume,
                      float rightVolume)

Sets the volume level for the audio playback.

Parameters:

leftVolume - The volume range [0.0 - 1.0]

rightVolume - The volume range [0.0 - 1.0]

setWakeMode

public void setWakeMode(Context context,
                        int mode)

reset

public void reset()

Stops the current audio playback and resets the listener states so that we receive the callbacks for events like onPrepared

seekTo

public void seekTo(int milliSeconds)

Moves the current audio progress to the specified location. This method should only be called after the EMAudioPlayer is prepared. (see #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)

Parameters:

milliSeconds - The time to move the playback to

isPlaying

public boolean isPlaying()

Returns if an audio item is currently in playback

Returns:

True if an audio item is playing

start

public void start()

Starts the playback for the audio item specified in #setDataSource(android.content.Context, android.net.Uri). This should be called after the AudioPlayer is correctly prepared (see #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener))

pause

public void pause()

If an audio item is currently in playback, it will be paused and the progressPoll will be stopped (see startProgressPoll(EMEventBus))

stopPlayback

public void stopPlayback()

If an audio item is currently in playback then the playback will be stopped and the progressPoll will be stopped (see startProgressPoll(EMEventBus))

release

public void release()

getDuration

public long getDuration()

Retrieves the duration of the current audio item. This should only be called after the item is prepared (see #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)). If overrideDuration(int) is set then that value will be returned.

Returns:

The millisecond duration of the video

overrideDuration

public void overrideDuration(int duration)

Setting this will override the duration that the item may actually be. This method should only be used when the item doesn't return the correct duration such as with audio streams. This only overrides the current audio item.

Parameters:

duration - The duration for the current media item or < 0 to disable

getCurrentPosition

public long getCurrentPosition()

Retrieves the current position of the audio playback. If an audio item is not currently in playback then the value will be 0. This should only be called after the item is prepared (see #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener))

Returns:

The millisecond value for the current position

setPositionOffset

public void setPositionOffset(int offset)

Sets the amount of time to change the return value from getCurrentPosition(). This value will be reset when a new audio item is selected.

Parameters:

offset - The millisecond value to offset the position

restartOverridePosition

public void restartOverridePosition()

Restarts the audio position to the start if the position is being overridden (see overridePosition(boolean)). This will be the value specified with setPositionOffset(int) or 0 if it hasn't been set.

overridePosition

public void overridePosition(boolean override)

Sets if the audio position should be overridden, allowing the time to be restarted at will. This is useful for streaming audio where the audio doesn't have breaks between songs.

Parameters:

override - True if the position should be overridden

getBufferPercentage

public int getBufferPercentage()

Retrieves the current buffer percent of the audio item. If an audio item is not currently prepared or buffering the value will be 0. This should only be called after the audio item is prepared (see #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener))

Returns:

The integer percent that is buffered [0, 100] inclusive

addExoPlayerListener

public void addExoPlayerListener(ExoPlayerListener listener)

Sets the listener to inform of any exoPlayer events

Parameters:

listener - The listener

removeExoPlayerListener

public void removeExoPlayerListener(ExoPlayerListener listener)

Removes the specified listener for the ExoPlayer.

Parameters:

listener - The listener to remove

setOnPreparedListener

public void setOnPreparedListener(MediaPlayer.OnPreparedListener listener)

Sets the listener to inform of VideoPlayer prepared events. This can also be accessed through the bus event EMMediaPreparedEvent

Parameters:

listener - The listener

setOnCompletionListener

public void setOnCompletionListener(MediaPlayer.OnCompletionListener listener)

Sets the listener to inform of VideoPlayer completion events. This can also be accessed through the bus event EMMediaCompletionEvent

Parameters:

listener - The listener

setOnErrorListener

public void setOnErrorListener(MediaPlayer.OnErrorListener listener)

Sets the listener to inform of playback errors. This can also be accessed through the bus event EMMediaErrorEvent

Parameters:

listener - The listener

setOnInfoListener

public void setOnInfoListener(MediaPlayer.OnInfoListener listener)

Sets the listener to inform of media information events.

Parameters:

listener - The listener

setOnBufferingUpdateListener

public void setOnBufferingUpdateListener(android.media.MediaPlayer.OnBufferingUpdateListener listener)

Sets the listener to inform of buffering updates

Parameters:

listener - The listener