com.devbrackets.android.exomedia

Class AudioPlayer

java.lang.Object

com.devbrackets.android.exomedia.AudioPlayer

public class AudioPlayer
extends java.lang.Object

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 Android MediaPlayer provides.

Field Summary

Fields

Modifier and Type	Field and Description
protected AudioPlayerApi	audioPlayerImpl
protected ListenerMux	listenerMux
protected long	overriddenDuration

Constructor Summary

Constructors

Constructor and Description
AudioPlayer(AudioPlayerApi audioPlayerImpl)
AudioPlayer(android.content.Context context)
AudioPlayer(android.content.Context context, DeviceUtil deviceUtil)

Method Summary

Modifier and Type	Method and Description
int	getAudioSessionId() Returns the audio session ID.
java.util.Map<ExoMedia.RendererType,com.google.android.exoplayer2.source.TrackGroupArray>	getAvailableTracks() Retrieves a list of available tracks to select from.
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.
protected void	init(AudioPlayerApi audioPlayerImpl)
boolean	isPlaying() Returns if an audio item is currently in playback
void	overrideDuration(long duration) Setting this will override the duration that the item may actually be.
void	pause() If an audio item is currently in playback, it will be paused
void	prepareAsync() Prepares the media specified with setDataSource(Uri) or setDataSource(Uri, MediaSource) in an asynchronous manner
void	release() Releases the resources associated with this media player
void	reset() Stops the current audio playback and resets the listener states so that we receive the callbacks for events like onPrepared
void	seekTo(long milliSeconds) Moves the current audio progress to the specified location.
void	setAudioStreamType(int streamType) Sets the audio stream type for this MediaPlayer.
void	setDataSource(android.net.Uri uri) Sets the source path for the audio item.
void	setDataSource(android.net.Uri uri, com.google.android.exoplayer2.source.MediaSource mediaSource) Sets the source path for the audio item.
void	setDrmCallback(com.google.android.exoplayer2.drm.MediaDrmCallback drmCallback) Sets the MediaDrmCallback to use when handling DRM for media.
void	setMetadataListener(MetadataListener listener) Sets the listener to inform of ID3 metadata updates
void	setOnBufferUpdateListener(OnBufferUpdateListener listener) Sets the listener to inform of VideoPlayer buffer update events
void	setOnCompletionListener(OnCompletionListener listener) Sets the listener to inform of VideoPlayer completion events
void	setOnErrorListener(OnErrorListener listener) Sets the listener to inform of playback errors
void	setOnPreparedListener(OnPreparedListener listener) Sets the listener to inform of VideoPlayer prepared events
void	setOnSeekCompletionListener(OnSeekCompletionListener listener) Sets the listener to inform of VideoPlayer seek completion events
boolean	setPlaybackSpeed(float speed) Sets the playback speed for this MediaPlayer.
void	setTrack(ExoMedia.RendererType trackType, int trackIndex) Changes to the track with trackIndex for the specified trackType
void	setVolume(float leftVolume, float rightVolume) Sets the volume level for the audio playback.
void	setWakeMode(android.content.Context context, int mode) Set the low-level power management behavior for this AudioPlayer.
void	start() Starts the playback for the audio item specified in setDataSource(Uri).
void	stopPlayback() If an audio item is currently in playback then the playback will be stopped
boolean	trackSelectionAvailable() Determines if the current video player implementation supports track selection for audio or video tracks.

Methods inherited from class java.lang.Object

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

Field Detail

listenerMux

protected ListenerMux listenerMux

audioPlayerImpl

protected AudioPlayerApi audioPlayerImpl

overriddenDuration

protected long overriddenDuration

Constructor Detail

AudioPlayer

public AudioPlayer(@NonNull
                   android.content.Context context)

AudioPlayer

public AudioPlayer(@NonNull
                   android.content.Context context,
                   @NonNull
                   DeviceUtil deviceUtil)

AudioPlayer

public AudioPlayer(AudioPlayerApi audioPlayerImpl)

Method Detail

init

protected void init(AudioPlayerApi audioPlayerImpl)

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.

setPlaybackSpeed

public boolean setPlaybackSpeed(float speed)

Sets the playback speed for this MediaPlayer.

Parameters:

speed - The speed to play the media back at

Returns:

True if the speed was set

setAudioStreamType

public void setAudioStreamType(int streamType)

Sets the audio stream type for this MediaPlayer. See AudioManager for a list of stream types. Must call this method before prepare() or prepareAsync() in order for the target stream type to become effective thereafter.

Parameters:

streamType - The audio stream type

See Also:

AudioManager

setDataSource

public void setDataSource(@Nullable
                          android.net.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://)

Parameters:

uri - The Uri representing the path to the audio item

setDataSource

public void setDataSource(@Nullable
                          android.net.Uri uri,
                          @Nullable
                          com.google.android.exoplayer2.source.MediaSource mediaSource)

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:

uri - The Uri representing the path to the audio item

mediaSource - The MediaSource to use for audio playback

setDrmCallback

public void setDrmCallback(@Nullable
                           com.google.android.exoplayer2.drm.MediaDrmCallback drmCallback)

Sets the MediaDrmCallback to use when handling DRM for media. This should be called before specifying the videos uri or path
NOTE: DRM is only supported on API 18 +

Parameters:

drmCallback - The callback to use when handling DRM media

prepareAsync

public void prepareAsync()

Prepares the media specified with setDataSource(Uri) or setDataSource(Uri, MediaSource) in an asynchronous manner

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(android.content.Context context,
                        int mode)

Set the low-level power management behavior for this AudioPlayer.

This function has the AudioPlayer access the low-level power manager service to control the device's power usage while playing is occurring. The parameter is a combination of PowerManager wake flags. Use of this method requires Manifest.permission.WAKE_LOCK permission. By default, no attempt is made to keep the device awake during playback.

Parameters:

context - the Context to use

mode - the power/wake mode to set

See Also:

PowerManager

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(long milliSeconds)

Moves the current audio progress to the specified location. This method should only be called after the AudioPlayer is prepared. (see setOnPreparedListener(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(Uri). This should be called after the AudioPlayer is correctly prepared (see setOnPreparedListener(OnPreparedListener))

pause

public void pause()

If an audio item is currently in playback, it will be paused

stopPlayback

public void stopPlayback()

If an audio item is currently in playback then the playback will be stopped

release

public void release()

Releases the resources associated with this media player

getDuration

public long getDuration()

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

Returns:

The millisecond duration of the video

overrideDuration

public void overrideDuration(long 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(OnPreparedListener))

Returns:

The millisecond value for the current position

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(OnPreparedListener))

Returns:

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

trackSelectionAvailable

public boolean trackSelectionAvailable()

Determines if the current video player implementation supports track selection for audio or video tracks.

Returns:

True if tracks can be manually specified

setTrack

public void setTrack(ExoMedia.RendererType trackType,
                     int trackIndex)

Changes to the track with trackIndex for the specified trackType

Parameters:

trackType - The type for the track to switch to the selected index

trackIndex - The index for the track to switch to

getAvailableTracks

@Nullable
public java.util.Map<ExoMedia.RendererType,com.google.android.exoplayer2.source.TrackGroupArray> getAvailableTracks()

Retrieves a list of available tracks to select from. Typically trackSelectionAvailable() should be called before this.

Returns:

A list of available tracks associated with each track type

setOnPreparedListener

public void setOnPreparedListener(@Nullable
                                  OnPreparedListener listener)

Sets the listener to inform of VideoPlayer prepared events

Parameters:

listener - The listener

setOnCompletionListener

public void setOnCompletionListener(@Nullable
                                    OnCompletionListener listener)

Sets the listener to inform of VideoPlayer completion events

Parameters:

listener - The listener

setOnBufferUpdateListener

public void setOnBufferUpdateListener(@Nullable
                                      OnBufferUpdateListener listener)

Sets the listener to inform of VideoPlayer buffer update events

Parameters:

listener - The listener

setOnSeekCompletionListener

public void setOnSeekCompletionListener(@Nullable
                                        OnSeekCompletionListener listener)

Sets the listener to inform of VideoPlayer seek completion events

Parameters:

listener - The listener

setOnErrorListener

public void setOnErrorListener(@Nullable
                               OnErrorListener listener)

Sets the listener to inform of playback errors

Parameters:

listener - The listener

setMetadataListener

public void setMetadataListener(@Nullable
                                MetadataListener listener)

Sets the listener to inform of ID3 metadata updates

Parameters:

listener - The listener to inform