com.devbrackets.android.exomedia

Class EMVideoView

java.lang.Object

RelativeLayout

com.devbrackets.android.exomedia.EMVideoView

All Implemented Interfaces:

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

public class EMVideoView
extends RelativeLayout
implements com.google.android.exoplayer.audio.AudioCapabilitiesReceiver.Listener

This is a support VideoView that will use the standard VideoView on devices below JellyBean. On devices with JellyBean and up we will use the ExoPlayer in order to better support HLS streaming and full 1080p video resolutions which the VideoView struggles with, and in some cases crashes.

To an external user this view should have the same APIs used with the standard VideoView to help with quick implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EMVideoView.TouchVideoView Since the default Android VideoView will consume the touch events without calling super
static class	EMVideoView.VideoType

Field Summary

Fields

Modifier and Type	Field and Description
protected DefaultControls	defaultControls
protected Repeater	pollRepeater

Constructor Summary

Constructors

Constructor and Description
EMVideoView(Context context)
EMVideoView(Context context, AttributeSet attrs)
EMVideoView(Context context, AttributeSet attrs, int defStyleAttr)
EMVideoView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Method Summary

Modifier and Type	Method and Description
void	addExoPlayerListener(ExoPlayerListener listener) Sets the listener to inform of any exoPlayer events
int	getBufferPercentage() Retrieves the current buffer percent of the video.
long	getCurrentPosition() Retrieves the current position of the audio playback.
long	getDuration() Retrieves the duration of the current audio item.
ImageView	getPreviewImageView() Gets the preview ImageView for use with image loading libraries.
java.lang.String	getUserAgent() Retrieves the user agent that the EMVideoView will use when communicating with media servers
Uri	getVideoUri() Retrieves the current Video URI.
boolean	isPlaying() Returns if a video is currently in playback
void	onAudioCapabilitiesChanged(com.google.android.exoplayer.audio.AudioCapabilities audioCapabilities)
protected void	onDetachedFromWindow()
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 a video is currently in playback, it will be paused and the progressPoll will be stopped (see startProgressPoll(EMEventBus))
void	release() Stops the playback and releases all resources attached to this EMVideoView.
void	removeExoPlayerListener(ExoPlayerListener listener) Removes the specified listener for the ExoPlayer.
void	reset() Stops the current video 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 video progress to the specified location.
void	setBus(EMEventBus bus) Sets the bus to use for dispatching Events that correspond to the callbacks listed in EMVideoViewControlsCallback
void	setDefaultControlsEnabled(boolean enabled) Enables and disables the media control overlay for the video view
void	setFastForwardButtonEnabled(boolean enabled) Sets the button state for the Fast Forward button on the default controls; see setDefaultControlsEnabled(boolean).
void	setFastForwardButtonRemoved(boolean removed) Adds or removes the Fast Forward button.
void	setFastForwardImageResource(int resourceId) Sets the state list drawable resource id to use for the Fast Forward button.
void	setNextButtonEnabled(boolean enabled) Sets the button state for the Next button on the default controls; see setDefaultControlsEnabled(boolean).
void	setNextButtonRemoved(boolean removed) Adds or removes the Next button.
void	setNextImageResource(int resourceId) Sets the state list drawable resource id to use for the Next button.
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	setOnTouchListener(OnTouchListener listener)
void	setPlayPauseImages(int playResourceId, int pauseResourceId) Sets the resource id's to use for the PlayPause button.
void	setPositionOffset(int offset) Sets the amount of time to change the return value from getCurrentPosition().
void	setPreviewImage(Bitmap bitmap) Sets an image that will be visible only when the video is loading.
void	setPreviewImage(Drawable drawable) Sets an image that will be visible only when the video is loading.
void	setPreviewImage(Uri uri) Sets an image that will be visible only when the video is loading.
void	setPreviousButtonEnabled(boolean enabled) Sets the button state for the Previous button on the default controls; see setDefaultControlsEnabled(boolean).
void	setPreviousButtonRemoved(boolean removed) Adds or removes the Previous button.
void	setPreviousImageResource(int resourceId) Sets the state list drawable resource id to use for the Previous button.
void	setProgressPollDelay(int milliSeconds) Sets the delay to use when notifying of progress.
void	setReleaseOnDetachFromWindow(boolean releaseOnDetach) WARNING: Use of this method may cause memory leaks.
void	setRewindButtonEnabled(boolean enabled) Sets the button state for the Rewind button on the default controls; see setDefaultControlsEnabled(boolean).
void	setRewindButtonRemoved(boolean removed) Adds or removes the Rewind button.
void	setRewindImageResource(int resourceId) Sets the state list drawable resource id to use for the Rewind button.
void	setShutterColor(int color) Sets the color for the video shutters (the black bars above and below the video)
void	setVideoPath(java.lang.String path) Sets the path to the video.
void	setVideoURI(Uri uri) Sets the Uri location for the video to play.
void	setVideoURI(Uri uri, MediaUtil.MediaType defaultMediaType) Sets the Uri location for the video to play
void	setVideoViewControlsCallback(EMVideoViewControlsCallback callback) Sets the EMVideoViewControlsCallback to be used.
boolean	setVolume(float volume) Sets the volume level for devices that support the ExoPlayer (JellyBean or greater).
void	showDefaultControls() Requests the DefaultControls to become visible.
void	start() Starts the playback for the video specified in #setVideoURI(android.net.Uri) or setVideoPath(String).
void	startProgressPoll() Starts the progress poll.
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 a video is currently in playback then the playback will be stopped and the progressPoll will be stopped (see startProgressPoll())
void	stopProgressPoll() Stops the progress poll (see startProgressPoll())
void	suspend() If a video is currently in playback then the playback will be suspended and and the progressPoll will be stopped (see startProgressPoll())

Methods inherited from class java.lang.Object

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

Field Detail

defaultControls

protected DefaultControls defaultControls

pollRepeater

protected Repeater pollRepeater

Constructor Detail

EMVideoView

public EMVideoView(Context context)

EMVideoView

public EMVideoView(Context context,
                   AttributeSet attrs)

EMVideoView

public EMVideoView(Context context,
                   AttributeSet attrs,
                   int defStyleAttr)

EMVideoView

public EMVideoView(Context context,
                   AttributeSet attrs,
                   int defStyleAttr,
                   int defStyleRes)

Method Detail

onDetachedFromWindow

protected void onDetachedFromWindow()

setOnTouchListener

public void setOnTouchListener(OnTouchListener listener)

onAudioCapabilitiesChanged

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

Specified by:

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

setReleaseOnDetachFromWindow

public void setReleaseOnDetachFromWindow(boolean releaseOnDetach)

WARNING: Use of this method may cause memory leaks.

Enables or disables the automatic release when the EMVideoView is detached from the window. Normally this is expected to release all resources used by calling release(). If releaseOnDetach is disabled then release() will need to be manually called.

Parameters:

releaseOnDetach - False to disable the automatic release in onDetachedFromWindow()

release

public void release()

Stops the playback and releases all resources attached to this EMVideoView. This should not be called manually unless setReleaseOnDetachFromWindow(boolean) has been set.

getUserAgent

public java.lang.String getUserAgent()

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

Returns:

The String user agent for the EMVideoView

setPreviewImage

public void setPreviewImage(Drawable drawable)

Sets an image that will be visible only when the video is loading.

Parameters:

drawable - The drawable to use for the preview image

setPreviewImage

public void setPreviewImage(Bitmap bitmap)

Sets an image that will be visible only when the video is loading.

Parameters:

bitmap - The bitmap to use for the preview image

setPreviewImage

public void setPreviewImage(Uri uri)

Sets an image that will be visible only when the video is loading.

Parameters:

uri - The Uri pointing to the preview image

getPreviewImageView

public ImageView getPreviewImageView()

Gets the preview ImageView for use with image loading libraries.

Returns:

the preview ImageView

setShutterColor

public void setShutterColor(int color)

Sets the color for the video shutters (the black bars above and below the video)

Parameters:

color - The color

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 that correspond to the callbacks listed in EMVideoViewControlsCallback

Parameters:

bus - The EventBus to dispatch events on

startProgressPoll

public void startProgressPoll(EMEventBus bus)

Starts the progress poll. If you have already called setBus(EMEventBus) then you should use the startProgressPoll() method instead.

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

startProgressPoll

public void startProgressPoll()

Starts the progress poll. This should be called after you have set the bus with setBus(EMEventBus) or previously called startProgressPoll(EMEventBus), otherwise you won't get notified of progress changes

stopProgressPoll

public void stopProgressPoll()

Stops the progress poll (see startProgressPoll())

setDefaultControlsEnabled

public void setDefaultControlsEnabled(boolean enabled)

Enables and disables the media control overlay for the video view

Parameters:

enabled - Weather the default video controls are enabled (default: false)

showDefaultControls

public void showDefaultControls()

Requests the DefaultControls to become visible. This should only be called after setDefaultControlsEnabled(boolean).

setPreviousButtonEnabled

public void setPreviousButtonEnabled(boolean enabled)

Sets the button state for the Previous button on the default controls; see setDefaultControlsEnabled(boolean). setDefaultControlsEnabled(boolean) must be called prior to this.

This will just change the images specified with setPreviousImageResource(int), or use the defaults if they haven't been set, and block any click events.

This method will NOT re-add buttons that have previously been removed with setPreviousButtonRemoved(boolean).

Parameters:

enabled - If the Previous button is enabled [default: false]

setNextButtonEnabled

public void setNextButtonEnabled(boolean enabled)

Sets the button state for the Next button on the default controls; see setDefaultControlsEnabled(boolean). setDefaultControlsEnabled(boolean) must be called prior to this.

This will just change the images specified with setNextImageResource(int), or use the defaults if they haven't been set, and block any click events.

This method will NOT re-add buttons that have previously been removed with setNextButtonRemoved(boolean).

Parameters:

enabled - If the Next button is enabled [default: false]

setRewindButtonEnabled

public void setRewindButtonEnabled(boolean enabled)

Sets the button state for the Rewind button on the default controls; see setDefaultControlsEnabled(boolean). setDefaultControlsEnabled(boolean) must be called prior to this.

This will just change the images specified with setRewindImageResource(int), or use the defaults if they haven't been set, and block any click events.

This method will NOT re-add buttons that have previously been removed with setRewindButtonRemoved(boolean).

Parameters:

enabled - If the Rewind button is enabled [default: false]

setFastForwardButtonEnabled

public void setFastForwardButtonEnabled(boolean enabled)

Sets the button state for the Fast Forward button on the default controls; see setDefaultControlsEnabled(boolean). setDefaultControlsEnabled(boolean) must be called prior to this.

This will just change the images specified with setFastForwardImageResource(int), or use the defaults if they haven't been set, and block any click events.

This method will NOT re-add buttons that have previously been removed with setFastForwardButtonRemoved(boolean).

Parameters:

enabled - If the Fast Forward button is enabled [default: false]

setVideoViewControlsCallback

public void setVideoViewControlsCallback(EMVideoViewControlsCallback callback)

Sets the EMVideoViewControlsCallback to be used. setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

callback - The EMVideoViewControlsCallback to use

setPlayPauseImages

public void setPlayPauseImages(@DrawableRes
                               int playResourceId,
                               @DrawableRes
                               int pauseResourceId)

Sets the resource id's to use for the PlayPause button. setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

playResourceId - The resourceId or 0

pauseResourceId - The resourceId or 0

setPreviousImageResource

public void setPreviousImageResource(@DrawableRes
                                     int resourceId)

Sets the state list drawable resource id to use for the Previous button. setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

resourceId - The resourceId or 0

setNextImageResource

public void setNextImageResource(@DrawableRes
                                 int resourceId)

Sets the state list drawable resource id to use for the Next button. setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

resourceId - The resourceId or 0

setRewindImageResource

public void setRewindImageResource(@DrawableRes
                                   int resourceId)

Sets the state list drawable resource id to use for the Rewind button. setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

resourceId - The resourceId or 0

setFastForwardImageResource

public void setFastForwardImageResource(@DrawableRes
                                        int resourceId)

Sets the state list drawable resource id to use for the Fast Forward button. setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

resourceId - The resourceId or 0

setPreviousButtonRemoved

public void setPreviousButtonRemoved(boolean removed)

Adds or removes the Previous button. This will change the visibility of the button, if you want to change the enabled/disabled images see setPreviousButtonEnabled(boolean) setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

removed - If the Previous button should be removed [default: true]

setNextButtonRemoved

public void setNextButtonRemoved(boolean removed)

Adds or removes the Next button. This will change the visibility of the button, if you want to change the enabled/disabled images see setNextButtonEnabled(boolean) setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

removed - If the Next button should be removed [default: true]

setRewindButtonRemoved

public void setRewindButtonRemoved(boolean removed)

Adds or removes the Rewind button. This will change the visibility of the button, if you want to change the enabled/disabled images see setRewindButtonEnabled(boolean) setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

removed - If the Rewind button should be removed [default: false]

setFastForwardButtonRemoved

public void setFastForwardButtonRemoved(boolean removed)

Adds or removes the Fast Forward button. This will change the visibility of the button, if you want to change the enabled/disabled images see setFastForwardButtonEnabled(boolean) setDefaultControlsEnabled(boolean) must be called prior to this.

Parameters:

removed - If the Fast Forward button should be removed [default: false]

setVideoURI

public void setVideoURI(Uri uri)

Sets the Uri location for the video to play. If the media format cannot be determine MP4 will be assumed. You can also manually specify the media format with setVideoURI(Uri, MediaUtil.MediaType)

Parameters:

uri - The video's Uri

setVideoURI

public void setVideoURI(Uri uri,
                        MediaUtil.MediaType defaultMediaType)

Sets the Uri location for the video to play

Parameters:

uri - The video's Uri

defaultMediaType - The MediaType to use when auto-detection fails

setVideoPath

public void setVideoPath(java.lang.String path)

Sets the path to the video. This path can be a web address (e.g. http://) or an absolute local path (e.g. file://)

Parameters:

path - The path to the video

getVideoUri

public Uri getVideoUri()

Retrieves the current Video URI. If this hasn't been set with #setVideoURI(android.net.Uri) or setVideoPath(String) then null will be returned.

Returns:

The current video URI or null

setVolume

public boolean setVolume(float volume)

Sets the volume level for devices that support the ExoPlayer (JellyBean or greater).

Parameters:

volume - The volume range [0.0 - 1.0]

Returns:

True if the volume was set

reset

public void reset()

Stops the current video 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 video progress to the specified location.

Parameters:

milliSeconds - The time to move the playback to

isPlaying

public boolean isPlaying()

Returns if a video is currently in playback

Returns:

True if a video is playing

start

public void start()

Starts the playback for the video specified in #setVideoURI(android.net.Uri) or setVideoPath(String). This should be called after the VideoView is correctly prepared (see #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener))

pause

public void pause()

If a video is currently in playback, it will be paused and the progressPoll will be stopped (see startProgressPoll(EMEventBus))

stopPlayback

public void stopPlayback()

If a video is currently in playback then the playback will be stopped and the progressPoll will be stopped (see startProgressPoll())

suspend

public void suspend()

If a video is currently in playback then the playback will be suspended and and the progressPoll will be stopped (see startProgressPoll())

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 video. If a video is not currently prepared or buffering the value will be 0. This should only be called after the video 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