com.google.googlemediaframeworkdemo.demo.adplayer

Class ImaPlayer

java.lang.Object

com.google.googlemediaframeworkdemo.demo.adplayer.ImaPlayer

public class ImaPlayer
extends java.lang.Object

The ImaPlayer is responsible for displaying both videos and ads. This is accomplished using two video players. The content player displays the user's video. When an ad is requested, the ad video player is overlaid on the content video player. When the ad is complete, the ad video player is destroyed and the content video player is displayed again.

Constructor Summary

Constructors

Constructor and Description
ImaPlayer(android.app.Activity activity, android.widget.FrameLayout container, Video video)
ImaPlayer(android.app.Activity activity, android.widget.FrameLayout container, Video video, java.lang.String videoTitle)
ImaPlayer(android.app.Activity activity, android.widget.FrameLayout container, Video video, java.lang.String videoTitle, com.google.ads.interactivemedia.v3.api.ImaSdkSettings sdkSettings, java.lang.String adTagUrl)
ImaPlayer(android.app.Activity activity, android.widget.FrameLayout container, Video video, java.lang.String videoTitle, com.google.ads.interactivemedia.v3.api.ImaSdkSettings sdkSettings, java.lang.String adTagUrl, PlaybackControlLayer.FullscreenCallback fullscreenCallback)
ImaPlayer(android.app.Activity activity, android.widget.FrameLayout container, Video video, java.lang.String videoTitle, java.lang.String adTagUrl)

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	pause() Pause video playback.
void	play() Resume video playback.
void	release() When you are finished using this ImaPlayer, make sure to call this method.
void	setChromeColor(int color) Sets the color of the top chrome, bottom chrome, and background.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImaPlayer

public ImaPlayer(android.app.Activity activity,
         android.widget.FrameLayout container,
         Video video,
         java.lang.String videoTitle,
         com.google.ads.interactivemedia.v3.api.ImaSdkSettings sdkSettings,
         java.lang.String adTagUrl,
         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).

sdkSettings - The settings that should be used to configure the IMA SDK.

adTagUrl - The URL containing the VAST document of the ad.

fullscreenCallback - The callback that should be triggered when the player enters or leaves fullscreen.

ImaPlayer

public ImaPlayer(android.app.Activity activity,
         android.widget.FrameLayout container,
         Video video,
         java.lang.String videoTitle,
         com.google.ads.interactivemedia.v3.api.ImaSdkSettings sdkSettings,
         java.lang.String adTagUrl)

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).

sdkSettings - The settings that should be used to configure the IMA SDK.

adTagUrl - The URL containing the VAST document of the ad.

ImaPlayer

public ImaPlayer(android.app.Activity activity,
         android.widget.FrameLayout container,
         Video video,
         java.lang.String videoTitle,
         java.lang.String adTagUrl)

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).

adTagUrl - The URL containing the VAST document of the ad.

ImaPlayer

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

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).

ImaPlayer

public ImaPlayer(android.app.Activity activity,
         android.widget.FrameLayout container,
         Video video)

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.

Method Detail

pause

public void pause()

Pause video playback.

play

public void play()

Resume video playback.

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.

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).

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).

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.

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.

release

public void release()

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