com.google.android.libraries.mediaframework.layeredvideo

Class SimpleVideoPlayer

java.lang.Object

com.google.android.libraries.mediaframework.layeredvideo.SimpleVideoPlayer

public class SimpleVideoPlayer
extends java.lang.Object

A video player which includes subtitle support and a customizable UI for playback control.

NOTE: If you want to get a video player up and running with minimal effort, just instantiate this class and call play();

Constructor Summary

Constructors

Constructor and Description
SimpleVideoPlayer(android.app.Activity activity, android.widget.FrameLayout container, Video video, java.lang.String videoTitle, boolean autoplay)
SimpleVideoPlayer(android.app.Activity activity, android.widget.FrameLayout container, Video video, java.lang.String videoTitle, boolean autoplay, int startPostitionMs, PlaybackControlLayer.FullscreenCallback fullscreenCallback)

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionButton(android.graphics.drawable.Drawable icon, java.lang.String contentDescription, android.view.View.OnClickListener onClickListener) Creates a button to put in the top right of the video player.
void	addPlaybackListener(ExoplayerWrapper.PlaybackListener listener) Set a listener which reacts to state changes, video size changes, and errors.
void	disableSeeking() Hides the seek bar thumb and prevents the user from seeking to different time points in the video.
void	enableSeeking() Makes the seek bar thumb visible and allows the user to seek to different time points in the video.
int	getCurrentPosition() Returns the current playback position in milliseconds.
int	getDuration() Returns the duration of the track in milliseconds or ExoPlayer.UNKNOWN_TIME if the duration is unknown.
void	hide() Fades the playback control layer out and then removes it from the LayerManager's container.
void	hideTopChrome() Hides the top chrome (which displays the logo, title, and action buttons).
boolean	isFullscreen() Returns whether the player is currently in fullscreen mode.
void	moveSurfaceToBackground() When mutliple surface layers are used (ex.
void	moveSurfaceToForeground() When mutliple surface layers are used (ex.
void	pause() Pause video playback.
void	play() Resume video playback.
void	release() When you are finished using this SimpleVideoPlayer, make sure to call this method.
void	setChromeColor(int color) Sets the color of the top chrome, bottom chrome, and background.
void	setFullscreen(boolean shouldBeFullscreen) Make the player enter or leave fullscreen mode.
void	setFullscreenCallback(PlaybackControlLayer.FullscreenCallback fullscreenCallback) Set the callback which will be called when the player enters and leaves fullscreen mode.
void	setLogoImage(android.graphics.drawable.Drawable logo) Set the logo with appears in the left of the top chrome.
void	setPlaybackControlColor(int color) Sets the color of the buttons and seek bar.
void	setPlayCallback(PlaybackControlLayer.PlayCallback playCallback) Set the callback which will be called when the player plays video.
void	setSeekbarColor(int color) Sets the color of the seekbar.
void	setTextColor(int color) Sets the color of the text views
void	setVideoTitle(java.lang.String title) Set the title of the video in the left of the top chrome (to the right of the logo).
boolean	shouldBePlaying() Returns whether the player should be playing (based on whether the user has tapped pause or play).
void	show() Add the playback control layer back to the container.
void	showTopChrome() Shows the top chrome (which displays the logo, title, and action buttons).

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleVideoPlayer

public SimpleVideoPlayer(android.app.Activity activity,
                 android.widget.FrameLayout container,
                 Video video,
                 java.lang.String videoTitle,
                 boolean autoplay)

Parameters:

activity - The activity that will contain the video player.

container - The FrameLayout which will contain the video player.

video - The video that should be played.

videoTitle - The title of the video (displayed on the left of the top chrome).

autoplay - Whether the video should start playing immediately.

SimpleVideoPlayer

public SimpleVideoPlayer(android.app.Activity activity,
                 android.widget.FrameLayout container,
                 Video video,
                 java.lang.String videoTitle,
                 boolean autoplay,
                 int startPostitionMs,
                 PlaybackControlLayer.FullscreenCallback fullscreenCallback)

Parameters:

activity - The activity that will contain the video player.

container - The FrameLayout which will contain the video player.

video - The video that should be played.

videoTitle - The title of the video (displayed on the left of the top chrome).

autoplay - Whether the video should start playing immediately.

fullscreenCallback - The callback which gets triggered when the player enters or leaves fullscreen mode.

Method Detail

addActionButton

public void addActionButton(android.graphics.drawable.Drawable icon,
                   java.lang.String contentDescription,
                   android.view.View.OnClickListener onClickListener)

Creates a button to put in the top right of the video player.

Parameters:

icon - The image of the action (ex. trash can).

contentDescription - The text description this action. This is used in case the action buttons do not fit in the video player. If so, an overflow button will appear and, when clicked, it will display a list of the content descriptions for each action.

onClickListener - The handler for when the action is triggered.

addPlaybackListener

public void addPlaybackListener(ExoplayerWrapper.PlaybackListener listener)

Set a listener which reacts to state changes, video size changes, and errors.

Parameters:

listener - Listens to playback events.

disableSeeking

public void disableSeeking()

Hides the seek bar thumb and prevents the user from seeking to different time points in the video.

enableSeeking

public void enableSeeking()

Makes the seek bar thumb visible and allows the user to seek to different time points in the video.

getCurrentPosition

public int getCurrentPosition()

Returns the current playback position in milliseconds.

getDuration

public int getDuration()

Returns the duration of the track in milliseconds or ExoPlayer.UNKNOWN_TIME if the duration is unknown.

hide

public void hide()

Fades the playback control layer out and then removes it from the LayerManager's container.

hideTopChrome

public void hideTopChrome()

Hides the top chrome (which displays the logo, title, and action buttons).

isFullscreen

public boolean isFullscreen()

Returns whether the player is currently in fullscreen mode.

setFullscreen

public void setFullscreen(boolean shouldBeFullscreen)

Make the player enter or leave fullscreen mode.

Parameters:

shouldBeFullscreen - If true, the player is put into fullscreen mode. If false, the player leaves fullscreen mode.

moveSurfaceToBackground

public void moveSurfaceToBackground()

When mutliple surface layers are used (ex. in the case of ad playback), one layer must be overlaid on top of another. This method sends this player's surface layer to the background so that other surface layers can be overlaid on top of it.

moveSurfaceToForeground

public void moveSurfaceToForeground()

When mutliple surface layers are used (ex. in the case of ad playback), one layer must be overlaid on top of another. This method sends this player's surface layer to the foreground so that it is overlaid on top of all layers which are in the background.

pause

public void pause()

Pause video playback.

play

public void play()

Resume video playback.

setChromeColor

public void setChromeColor(int color)

Sets the color of the top chrome, bottom chrome, and background.

Parameters:

color - a color derived from the @{link Color} class (ex. Color.RED).

setFullscreenCallback

public void setFullscreenCallback(PlaybackControlLayer.FullscreenCallback fullscreenCallback)

Set the callback which will be called when the player enters and leaves fullscreen mode.

Parameters:

fullscreenCallback - The callback should hide other views in the activity when the player enters fullscreen mode and show other views when the player leaves fullscreen mode.

setPlayCallback

public void setPlayCallback(PlaybackControlLayer.PlayCallback playCallback)

Set the callback which will be called when the player plays video.

Parameters:

playCallback - The callback.

setLogoImage

public void setLogoImage(android.graphics.drawable.Drawable logo)

Set the logo with appears in the left of the top chrome.

Parameters:

logo - The drawable which will be the logo.

setPlaybackControlColor

public void setPlaybackControlColor(int color)

Sets the color of the buttons and seek bar.

Parameters:

color - a color derived from the @{link Color} class (ex. Color.RED).

setSeekbarColor

public void setSeekbarColor(int color)

Sets the color of the seekbar.

Parameters:

color - a color derived from the @{link Color} class (ex. Color.RED).

setTextColor

public void setTextColor(int color)

Sets the color of the text views

Parameters:

color - a color derived from the @{link Color} class (ex. Color.RED).

setVideoTitle

public void setVideoTitle(java.lang.String title)

Set the title of the video in the left of the top chrome (to the right of the logo).

Parameters:

title - The video title. If it is too long, it will be ellipsized.

shouldBePlaying

public boolean shouldBePlaying()

Returns whether the player should be playing (based on whether the user has tapped pause or play). This can be used by other classes to look at the playback control layer's play/pause state and force the player to play or pause accordingly.

show

public void show()

Add the playback control layer back to the container. It will disappear when the user taps the screen.

showTopChrome

public void showTopChrome()

Shows the top chrome (which displays the logo, title, and action buttons).

release

public void release()

When you are finished using this SimpleVideoPlayer, make sure to call this method.