Back to project page google-media-framework-android.
The source code is released under:
Apache License
If you think the Android project google-media-framework-android listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
/** Copyright 2014 Google Inc. All rights reserved. //from w ww .j av a 2 s. c o m Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package com.google.googlemediaframeworkdemo.demo.adplayer; import android.app.Activity; import android.graphics.Color; import android.graphics.drawable.Drawable; import android.net.Uri; import android.util.Log; import android.view.View; import android.view.ViewGroup; import android.widget.FrameLayout; import android.widget.Toast; import com.google.ads.interactivemedia.v3.api.AdDisplayContainer; import com.google.ads.interactivemedia.v3.api.AdErrorEvent; import com.google.ads.interactivemedia.v3.api.AdEvent; import com.google.ads.interactivemedia.v3.api.AdsLoader; import com.google.ads.interactivemedia.v3.api.AdsManager; import com.google.ads.interactivemedia.v3.api.AdsManagerLoadedEvent; import com.google.ads.interactivemedia.v3.api.AdsRequest; import com.google.ads.interactivemedia.v3.api.ImaSdkFactory; import com.google.ads.interactivemedia.v3.api.ImaSdkSettings; import com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer; import com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate; import com.google.android.exoplayer.ExoPlayer; import com.google.android.libraries.mediaframework.exoplayerextensions.ExoplayerWrapper; import com.google.android.libraries.mediaframework.exoplayerextensions.Video; import com.google.android.libraries.mediaframework.layeredvideo.PlaybackControlLayer; import com.google.android.libraries.mediaframework.layeredvideo.SimpleVideoPlayer; import com.google.android.libraries.mediaframework.layeredvideo.Util; import java.util.ArrayList; import java.util.List; /** * 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. */ public class ImaPlayer { /** * The activity that is displaying this video player. */ private Activity activity; /** * Url of the ad. */ private Uri adTagUrl; /** * Plays the ad. */ private SimpleVideoPlayer adPlayer; /** * The layout that contains the ad player. */ private FrameLayout adPlayerContainer; /** * Used by the IMA SDK to overlay controls (i.e. skip ad) over the ad player. */ private FrameLayout adUiContainer; /** * Responsible for requesting the ad and creating the * {@link com.google.ads.interactivemedia.v3.api.AdsManager} */ private AdsLoader adsLoader; /** * Responsible for containing listeners for processing the elements of the ad. */ private AdsManager adsManager; /** * These callbacks are notified when the video is played and when it ends. The IMA SDK uses this * to poll for video progress and when to stop the ad. */ private List<VideoAdPlayer.VideoAdPlayerCallback> callbacks; /** * Contains the content player and the ad frame layout. */ private FrameLayout container; /** * Plays the content (i.e. the actual video). */ private SimpleVideoPlayer contentPlayer; /** * The callback that is triggered when fullscreen mode is entered or closed. */ private PlaybackControlLayer.FullscreenCallback fullscreenCallback; /** * Last recorded progress in ad playback. Occasionally the ad pauses when it needs to buffer (and * progress stops), so it must be resumed. We detect this situation by noting if the difference * "current progress" - "last recorded progress" = 0. If this occurs, then we can pause the * video and replay it. This causes the ad to continue playback again. */ private VideoProgressUpdate oldVpu; /** * This is the layout of the container before fullscreen mode has been entered. * When we leave fullscreen mode, we restore the layout of the container to this layout. */ private ViewGroup.LayoutParams originalContainerLayoutParams; /** * Notifies callbacks when the ad finishes. */ private final ExoplayerWrapper.PlaybackListener adPlaybackListener = new ExoplayerWrapper.PlaybackListener() { /** * We don't respond to errors. * @param e The error. */ @Override public void onError(Exception e) { } /** * We notify all callbacks when the ad ends. * @param playWhenReady Whether the video should play as soon as it is loaded. * @param playbackState The state of the Exoplayer instance. */ @Override public void onStateChanged(boolean playWhenReady, int playbackState) { if (playbackState == ExoPlayer.STATE_ENDED) { for (VideoAdPlayer.VideoAdPlayerCallback callback : callbacks) { callback.onEnded(); } } } /** * We don't respond to size changes. * @param width The new width of the player. * @param height The new height of the player. */ @Override public void onVideoSizeChanged(int width, int height) { } }; /** * Listener for the content player */ private final ExoplayerWrapper.PlaybackListener contentPlaybackListener = new ExoplayerWrapper.PlaybackListener() { /** * We don't respond to errors. * @param e The error. */ @Override public void onError(Exception e) { } /** * We notify the adLoader when the content has ended so it knows to play postroll ads. * @param playWhenReady Whether the video should play as soon as it is loaded. * @param playbackState The state of the Exoplayer instance. */ @Override public void onStateChanged(boolean playWhenReady, int playbackState) { if (playbackState == ExoPlayer.STATE_ENDED) { adsLoader.contentComplete(); } } /** * We don't respond to size changes. * @param width The new width of the player. * @param height The new height of the player. */ @Override public void onVideoSizeChanged(int width, int height) { } }; /** * Sets up ads manager, responds to ad errors, and handles ad state changes. */ private class AdListener implements AdErrorEvent.AdErrorListener, AdsLoader.AdsLoadedListener, AdEvent.AdEventListener { @Override public void onAdError(AdErrorEvent adErrorEvent) { // If there is an error in ad playback, log the error and resume the content. Log.d(this.getClass().getSimpleName(), adErrorEvent.getError().getMessage()); // Display a toast message indicating the error. // You should remove this line of code for your production app. Toast.makeText(activity, adErrorEvent.getError().getMessage(), Toast.LENGTH_SHORT).show(); resumeContent(); } @Override public void onAdEvent(AdEvent event) { switch (event.getType()) { case LOADED: adsManager.start(); break; case CONTENT_PAUSE_REQUESTED: pauseContent(); break; case CONTENT_RESUME_REQUESTED: resumeContent(); break; default: break; } } @Override public void onAdsManagerLoaded(AdsManagerLoadedEvent adsManagerLoadedEvent) { adsManager = adsManagerLoadedEvent.getAdsManager(); adsManager.addAdErrorListener(this); adsManager.addAdEventListener(this); adsManager.init(); } } /** * Handles loading, playing, retrieving progress, pausing, resuming, and stopping ad. */ private final VideoAdPlayer videoAdPlayer = new VideoAdPlayer() { @Override public void playAd() { hideContentPlayer(); } @Override public void loadAd(String mediaUri) { adTagUrl = Uri.parse(mediaUri); createAdPlayer(); } @Override public void stopAd() { destroyAdPlayer(); showContentPlayer(); } @Override public void pauseAd() { if (adPlayer != null){ adPlayer.pause(); } } @Override public void resumeAd() { if(adPlayer != null) { adPlayer.play(); } } @Override public void addCallback(VideoAdPlayerCallback videoAdPlayerCallback) { callbacks.add(videoAdPlayerCallback); } @Override public void removeCallback(VideoAdPlayerCallback videoAdPlayerCallback) { callbacks.remove(videoAdPlayerCallback); } /** * Reports progress in ad player or content player (whichever is currently playing). * * NOTE: When the ad is buffering, the video is paused. However, when the buffering is * complete, the ad is resumed. So, as a workaround, we will attempt to resume the ad, by * calling the start method, whenever we detect that the ad is buffering. If the ad is done * buffering, the start method will resume playback. If the ad has not finished buffering, * then the start method will be ignored. */ @Override public VideoProgressUpdate getProgress() { VideoProgressUpdate vpu; if (adPlayer == null && contentPlayer == null) { // If neither player is available, indicate that the time is not ready. vpu = VideoProgressUpdate.VIDEO_TIME_NOT_READY; } else if (adPlayer != null) { // If an ad is playing, report the progress of the ad player. vpu = new VideoProgressUpdate(adPlayer.getCurrentPosition(), adPlayer.getDuration()); } else { // If the cotntent is playing, report the progress of the content player. vpu = new VideoProgressUpdate(contentPlayer.getCurrentPosition(), contentPlayer.getDuration()); } if (oldVpu == null) { oldVpu = vpu; } else if ((!vpu.equals(VideoProgressUpdate.VIDEO_TIME_NOT_READY)) && vpu.getCurrentTime() == oldVpu.getCurrentTime()) { // TODO(hsubrama): Find better method for detecting ad pause and resuming ad playback. // Resume the ad player if it has paused due to buffering. if (adPlayer != null && adPlayer.shouldBePlaying()) { adPlayer.pause(); adPlayer.play(); } } oldVpu = vpu; return vpu; } }; /** * @param activity The activity that will contain the video player. * @param container The {@link FrameLayout} which will contain the video player. * @param video The video that should be played. * @param videoTitle The title of the video (displayed on the left of the top chrome). * @param sdkSettings The settings that should be used to configure the IMA SDK. * @param adTagUrl The URL containing the VAST document of the ad. * @param fullscreenCallback The callback that should be triggered when the player enters or * leaves fullscreen. */ public ImaPlayer(Activity activity, FrameLayout container, Video video, String videoTitle, ImaSdkSettings sdkSettings, String adTagUrl, PlaybackControlLayer.FullscreenCallback fullscreenCallback) { this.activity = activity; this.container = container; if (adTagUrl != null) { this.adTagUrl = Uri.parse(adTagUrl); } adsLoader = ImaSdkFactory.getInstance().createAdsLoader(activity, sdkSettings); AdListener adListener = new AdListener(); adsLoader.addAdErrorListener(adListener); adsLoader.addAdsLoadedListener(adListener); callbacks = new ArrayList<VideoAdPlayer.VideoAdPlayerCallback>(); boolean autoplay = false; contentPlayer = new SimpleVideoPlayer(activity, container, video, videoTitle, autoplay); contentPlayer.addPlaybackListener(contentPlaybackListener); // Move the content player's surface layer to the background so that the ad player's surface // layer can be overlaid on top of it during ad playback. contentPlayer.moveSurfaceToBackground(); // Create the ad adDisplayContainer UI which will be used by the IMA SDK to overlay ad controls. adUiContainer = new FrameLayout(activity); container.addView(adUiContainer); adUiContainer.setLayoutParams(Util.getLayoutParamsBasedOnParent( adUiContainer, ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT)); this.originalContainerLayoutParams = container.getLayoutParams(); setFullscreenCallback(fullscreenCallback); } /** * @param activity The activity that will contain the video player. * @param container The {@link FrameLayout} which will contain the video player. * @param video The video that should be played. * @param videoTitle The title of the video (displayed on the left of the top chrome). * @param sdkSettings The settings that should be used to configure the IMA SDK. * @param adTagUrl The URL containing the VAST document of the ad. */ public ImaPlayer(Activity activity, FrameLayout container, Video video, String videoTitle, ImaSdkSettings sdkSettings, String adTagUrl) { this(activity, container, video, videoTitle, sdkSettings, adTagUrl, null); } /** * @param activity The activity that will contain the video player. * @param container The {@link FrameLayout} which will contain the video player. * @param video The video that should be played. * @param videoTitle The title of the video (displayed on the left of the top chrome). * @param adTagUrl The URL containing the VAST document of the ad. */ public ImaPlayer(Activity activity, FrameLayout container, Video video, String videoTitle, String adTagUrl) { this(activity, container, video, videoTitle, ImaSdkFactory.getInstance().createImaSdkSettings(), adTagUrl); } /** * @param activity The activity that will contain the video player. * @param container The {@link FrameLayout} which will contain the video player. * @param video The video that should be played. * @param videoTitle The title of the video (displayed on the left of the top chrome). */ public ImaPlayer(Activity activity, FrameLayout container, Video video, String videoTitle) { this(activity, container, video, videoTitle, ImaSdkFactory.getInstance().createImaSdkSettings(), null); } /** * @param activity The activity that will contain the video player. * @param container The {@link FrameLayout} which will contain the video player. * @param video The video that should be played. */ public ImaPlayer(Activity activity, FrameLayout container, Video video) { this(activity, container, video, "", ImaSdkFactory.getInstance().createImaSdkSettings(), null); } /** * Pause video playback. */ public void pause() { if (adPlayer != null) { adPlayer.pause(); } contentPlayer.pause(); } /** * Resume video playback. */ public void play() { if (adTagUrl != null) { requestAd(); } else { contentPlayer.play(); } } /** * Set the logo with appears in the left of the top chrome. * @param logo The drawable which will be the logo. */ public void setLogoImage(Drawable logo) { contentPlayer.setLogoImage(logo); } /** * Sets the color of the top chrome, bottom chrome, and background. * @param color a color derived from the @{link Color} class * (ex. {@link android.graphics.Color#RED}). */ public void setChromeColor(int color) { contentPlayer.setChromeColor(color); } /** * Sets the color of the buttons and seek bar. * @param color a color derived from the @{link Color} class * (ex. {@link android.graphics.Color#RED}). */ public void setPlaybackControlColor(int color) { contentPlayer.setPlaybackControlColor(color); } /** * Creates a button to put in the top right of the video player. * * @param icon The image of the action (ex. trash can). * @param 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. * @param onClickListener The handler for when the action is triggered. */ public void addActionButton(Drawable icon, String contentDescription, View.OnClickListener onClickListener) { contentPlayer.addActionButton(icon, contentDescription, onClickListener); } /** * Set the callback which will be called when the player enters and leaves fullscreen mode. * @param 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. */ public void setFullscreenCallback( final PlaybackControlLayer.FullscreenCallback fullscreenCallback) { this.fullscreenCallback = new PlaybackControlLayer.FullscreenCallback() { @Override public void onGoToFullscreen() { fullscreenCallback.onGoToFullscreen(); container.setLayoutParams(Util.getLayoutParamsBasedOnParent( container, ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT )); } @Override public void onReturnFromFullscreen() { fullscreenCallback.onReturnFromFullscreen(); container.setLayoutParams(originalContainerLayoutParams); } }; if (adPlayer != null) { adPlayer.setFullscreenCallback(fullscreenCallback); } else { contentPlayer.setFullscreenCallback(fullscreenCallback); } } /** * When you are finished using this {@link ImaPlayer}, make sure to call this method. */ public void release() { if (adPlayer != null) { adPlayer.release(); } adsLoader.contentComplete(); contentPlayer.release(); } /** * Create a {@link SimpleVideoPlayer} to play an ad and display it. */ private void createAdPlayer(){ // Kill any existing ad player. destroyAdPlayer(); // Add the ad frame layout to the adDisplayContainer that contains all the content player. adPlayerContainer = new FrameLayout(activity); container.addView(adPlayerContainer); adPlayerContainer.setLayoutParams(Util.getLayoutParamsBasedOnParent( adPlayerContainer, ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT )); // Ensure tha the ad ui adDisplayContainer is the topmost view. container.removeView(adUiContainer); container.addView(adUiContainer); Video adVideo = new Video(adTagUrl.toString(), Video.VideoType.MP4); adPlayer = new SimpleVideoPlayer(activity, adPlayerContainer, adVideo, "", true, 0, fullscreenCallback); adPlayer.addPlaybackListener(adPlaybackListener); // Move the ad player's surface layer to the foreground so that it is overlaid on the content // player's surface layer (which is in the background). adPlayer.moveSurfaceToForeground(); adPlayer.play(); adPlayer.disableSeeking(); adPlayer.setSeekbarColor(Color.YELLOW); adPlayer.hideTopChrome(); adPlayer.setFullscreen(contentPlayer.isFullscreen()); // Notify the callbacks that the ad has begun playing. for (VideoAdPlayer.VideoAdPlayerCallback callback : callbacks) { callback.onPlay(); } } /** * Destroy the {@link SimpleVideoPlayer} responsible for playing the ad and rmeove it. */ private void destroyAdPlayer(){ if(adPlayerContainer != null){ container.removeView(adPlayerContainer); } if (adUiContainer != null) { container.removeView(adUiContainer); } if(adPlayer != null){ contentPlayer.setFullscreen(adPlayer.isFullscreen()); adPlayer.release(); } adPlayerContainer = null; adPlayer = null; setFullscreenCallback(fullscreenCallback); } /** * Pause and hide the content player. */ private void hideContentPlayer(){ contentPlayer.pause(); contentPlayer.hide(); } /** * Show the content player and start playing again. */ private void showContentPlayer(){ contentPlayer.show(); contentPlayer.play(); } /** * Pause the content player and notify the ad callbacks that the content has paused. */ private void pauseContent(){ hideContentPlayer(); for (VideoAdPlayer.VideoAdPlayerCallback callback : callbacks) { callback.onPause(); } } /** * Resume the content and notify the ad callbacks that the content has resumed. */ private void resumeContent(){ destroyAdPlayer(); showContentPlayer(); for (VideoAdPlayer.VideoAdPlayerCallback callback : callbacks) { callback.onResume(); } } /** * Create an ads request which will request the VAST document with the given ad tag URL. * @param tagUrl URL pointing to a VAST document of an ad. * @return a request for the VAST document. */ private AdsRequest buildAdsRequest(String tagUrl) { AdDisplayContainer adDisplayContainer = ImaSdkFactory.getInstance().createAdDisplayContainer(); adDisplayContainer.setPlayer(videoAdPlayer); adDisplayContainer.setAdContainer(adUiContainer); AdsRequest request = ImaSdkFactory.getInstance().createAdsRequest(); request.setAdTagUrl(tagUrl); request.setAdDisplayContainer(adDisplayContainer); return request; } /** * Make the ads loader request an ad with the ad tag URL which this {@link ImaPlayer} was * created with */ private void requestAd() { adsLoader.requestAds(buildAdsRequest(adTagUrl.toString())); } }