Skip to content

SDK / exoplayer

Go to a project
Commit 8200fe5a by Oliver Woodman
Options

Merge branch 'customize-ads-rendering-settings-more' of… 

Merge branch 'customize-ads-rendering-settings-more' of https://github.com/ogaclejapan/ExoPlayer into ogaclejapan-customize-ads-rendering-settings-more
parent 22ee6761
Inline Side-by-side
Showing with 54 additions and 2 deletions
extensions/ima/src/main/java/com/google/android/exoplayer2/ext/ima/ImaAdsLoader.java
...@@ -40,6 +40,7 @@ import com.google.ads.interactivemedia.v3.api.AdsRequest; ...@@ -40,6 +40,7 @@ import com.google.ads.interactivemedia.v3.api.AdsRequest;
import com.google.ads.interactivemedia.v3.api.CompanionAdSlot; import com.google.ads.interactivemedia.v3.api.CompanionAdSlot;
import com.google.ads.interactivemedia.v3.api.ImaSdkFactory; import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
import com.google.ads.interactivemedia.v3.api.ImaSdkSettings; import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
import com.google.ads.interactivemedia.v3.api.UiElement;
import com.google.ads.interactivemedia.v3.api.player.ContentProgressProvider; import com.google.ads.interactivemedia.v3.api.player.ContentProgressProvider;
import com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer; import com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer;
import com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate; import com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate;
...@@ -67,8 +68,10 @@ import java.util.ArrayList; ...@@ -67,8 +68,10 @@ import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set;
/** Loads ads using the IMA SDK. All methods are called on the main thread. */ /** Loads ads using the IMA SDK. All methods are called on the main thread. */
public final class ImaAdsLoader public final class ImaAdsLoader
...@@ -91,8 +94,10 @@ public final class ImaAdsLoader ...@@ -91,8 +94,10 @@ public final class ImaAdsLoader
private @Nullable ImaSdkSettings imaSdkSettings; private @Nullable ImaSdkSettings imaSdkSettings;
private @Nullable AdEventListener adEventListener; private @Nullable AdEventListener adEventListener;
private @Nullable Set<UiElement> adUiElements;
private int vastLoadTimeoutMs; private int vastLoadTimeoutMs;
private int mediaLoadTimeoutMs; private int mediaLoadTimeoutMs;
private int mediaBitrate;
private boolean focusSkipButtonWhenAvailable; private boolean focusSkipButtonWhenAvailable;
private ImaFactory imaFactory; private ImaFactory imaFactory;
...@@ -105,6 +110,7 @@ public final class ImaAdsLoader ...@@ -105,6 +110,7 @@ public final class ImaAdsLoader
this.context = Assertions.checkNotNull(context); this.context = Assertions.checkNotNull(context);
vastLoadTimeoutMs = TIMEOUT_UNSET; vastLoadTimeoutMs = TIMEOUT_UNSET;
mediaLoadTimeoutMs = TIMEOUT_UNSET; mediaLoadTimeoutMs = TIMEOUT_UNSET;
mediaBitrate = BITRATE_UNSET;
focusSkipButtonWhenAvailable = true; focusSkipButtonWhenAvailable = true;
imaFactory = new DefaultImaFactory(); imaFactory = new DefaultImaFactory();
} }
...@@ -136,6 +142,18 @@ public final class ImaAdsLoader ...@@ -136,6 +142,18 @@ public final class ImaAdsLoader
} }
/** /**
* Sets the ad UI elements to be rendered by the IMA SDK.
*
* @param adUiElements The ad UI elements to be rendered by the IMA SDK.
* @return This builder, for convenience.
* @see AdsRenderingSettings#setUiElements(Set)
*/
public Builder setAdUiElements(Set<UiElement> adUiElements) {
this.adUiElements = new HashSet<>(Assertions.checkNotNull(adUiElements));
return this;
}
/**
* Sets the VAST load timeout, in milliseconds. * Sets the VAST load timeout, in milliseconds.
* *
* @param vastLoadTimeoutMs The VAST load timeout, in milliseconds. * @param vastLoadTimeoutMs The VAST load timeout, in milliseconds.
...@@ -143,7 +161,7 @@ public final class ImaAdsLoader ...@@ -143,7 +161,7 @@ public final class ImaAdsLoader
* @see AdsRequest#setVastLoadTimeout(float) * @see AdsRequest#setVastLoadTimeout(float)
*/ */
public Builder setVastLoadTimeoutMs(int vastLoadTimeoutMs) { public Builder setVastLoadTimeoutMs(int vastLoadTimeoutMs) {
Assertions.checkArgument(vastLoadTimeoutMs >= 0); Assertions.checkArgument(vastLoadTimeoutMs > 0);
this.vastLoadTimeoutMs = vastLoadTimeoutMs; this.vastLoadTimeoutMs = vastLoadTimeoutMs;
return this; return this;
} }
...@@ -156,12 +174,25 @@ public final class ImaAdsLoader ...@@ -156,12 +174,25 @@ public final class ImaAdsLoader
* @see AdsRenderingSettings#setLoadVideoTimeout(int) * @see AdsRenderingSettings#setLoadVideoTimeout(int)
*/ */
public Builder setMediaLoadTimeoutMs(int mediaLoadTimeoutMs) { public Builder setMediaLoadTimeoutMs(int mediaLoadTimeoutMs) {
Assertions.checkArgument(mediaLoadTimeoutMs >= 0); Assertions.checkArgument(mediaLoadTimeoutMs > 0);
this.mediaLoadTimeoutMs = mediaLoadTimeoutMs; this.mediaLoadTimeoutMs = mediaLoadTimeoutMs;
return this; return this;
} }
/** /**
* Sets the media maximum recommended bitrate for ads, in bps.
*
* @param bitrate The media maximum recommended bitrate for ads, in bps.
* @return This builder, for convenience.
* @see AdsRenderingSettings#setBitrateKbps(int)
*/
public Builder setMaxMediaBitrate(int bitrate) {
Assertions.checkArgument(bitrate > 0);
this.mediaBitrate = bitrate;
return this;
}
/**
* Sets whether to focus the skip button (when available) on Android TV devices. The default * Sets whether to focus the skip button (when available) on Android TV devices. The default
* setting is {@code true}. * setting is {@code true}.
* *
...@@ -197,7 +228,9 @@ public final class ImaAdsLoader ...@@ -197,7 +228,9 @@ public final class ImaAdsLoader
null, null,
vastLoadTimeoutMs, vastLoadTimeoutMs,
mediaLoadTimeoutMs, mediaLoadTimeoutMs,
mediaBitrate,
focusSkipButtonWhenAvailable, focusSkipButtonWhenAvailable,
adUiElements,
adEventListener, adEventListener,
imaFactory); imaFactory);
} }
...@@ -217,7 +250,9 @@ public final class ImaAdsLoader ...@@ -217,7 +250,9 @@ public final class ImaAdsLoader
adsResponse, adsResponse,
vastLoadTimeoutMs, vastLoadTimeoutMs,
mediaLoadTimeoutMs, mediaLoadTimeoutMs,
mediaBitrate,
focusSkipButtonWhenAvailable, focusSkipButtonWhenAvailable,
adUiElements,
adEventListener, adEventListener,
imaFactory); imaFactory);
} }
...@@ -247,6 +282,7 @@ public final class ImaAdsLoader ...@@ -247,6 +282,7 @@ public final class ImaAdsLoader
private static final long MAXIMUM_PRELOAD_DURATION_MS = 8000; private static final long MAXIMUM_PRELOAD_DURATION_MS = 8000;
private static final int TIMEOUT_UNSET = -1; private static final int TIMEOUT_UNSET = -1;
private static final int BITRATE_UNSET = -1;
/** The state of ad playback. */ /** The state of ad playback. */
@Documented @Documented
...@@ -271,6 +307,8 @@ public final class ImaAdsLoader ...@@ -271,6 +307,8 @@ public final class ImaAdsLoader
private final int vastLoadTimeoutMs; private final int vastLoadTimeoutMs;
private final int mediaLoadTimeoutMs; private final int mediaLoadTimeoutMs;
private final boolean focusSkipButtonWhenAvailable; private final boolean focusSkipButtonWhenAvailable;
private final int mediaBitrate;
private final @Nullable Set<UiElement> adUiElements;
private final @Nullable AdEventListener adEventListener; private final @Nullable AdEventListener adEventListener;
private final ImaFactory imaFactory; private final ImaFactory imaFactory;
private final Timeline.Period period; private final Timeline.Period period;
...@@ -357,7 +395,9 @@ public final class ImaAdsLoader ...@@ -357,7 +395,9 @@ public final class ImaAdsLoader
/* adsResponse= */ null, /* adsResponse= */ null,
/* vastLoadTimeoutMs= */ TIMEOUT_UNSET, /* vastLoadTimeoutMs= */ TIMEOUT_UNSET,
/* mediaLoadTimeoutMs= */ TIMEOUT_UNSET, /* mediaLoadTimeoutMs= */ TIMEOUT_UNSET,
/* mediaBitrate= */ BITRATE_UNSET,
/* focusSkipButtonWhenAvailable= */ true, /* focusSkipButtonWhenAvailable= */ true,
/* adUiElements= */ null,
/* adEventListener= */ null, /* adEventListener= */ null,
/* imaFactory= */ new DefaultImaFactory()); /* imaFactory= */ new DefaultImaFactory());
} }
...@@ -382,7 +422,9 @@ public final class ImaAdsLoader ...@@ -382,7 +422,9 @@ public final class ImaAdsLoader
/* adsResponse= */ null, /* adsResponse= */ null,
/* vastLoadTimeoutMs= */ TIMEOUT_UNSET, /* vastLoadTimeoutMs= */ TIMEOUT_UNSET,
/* mediaLoadTimeoutMs= */ TIMEOUT_UNSET, /* mediaLoadTimeoutMs= */ TIMEOUT_UNSET,
/* mediaBitrate= */ BITRATE_UNSET,
/* focusSkipButtonWhenAvailable= */ true, /* focusSkipButtonWhenAvailable= */ true,
/* adUiElements= */ null,
/* adEventListener= */ null, /* adEventListener= */ null,
/* imaFactory= */ new DefaultImaFactory()); /* imaFactory= */ new DefaultImaFactory());
} }
...@@ -394,7 +436,9 @@ public final class ImaAdsLoader ...@@ -394,7 +436,9 @@ public final class ImaAdsLoader
@Nullable String adsResponse, @Nullable String adsResponse,
int vastLoadTimeoutMs, int vastLoadTimeoutMs,
int mediaLoadTimeoutMs, int mediaLoadTimeoutMs,
int mediaBitrate,
boolean focusSkipButtonWhenAvailable, boolean focusSkipButtonWhenAvailable,
@Nullable Set<UiElement> adUiElements,
@Nullable AdEventListener adEventListener, @Nullable AdEventListener adEventListener,
ImaFactory imaFactory) { ImaFactory imaFactory) {
Assertions.checkArgument(adTagUri != null || adsResponse != null); Assertions.checkArgument(adTagUri != null || adsResponse != null);
...@@ -402,7 +446,9 @@ public final class ImaAdsLoader ...@@ -402,7 +446,9 @@ public final class ImaAdsLoader
this.adsResponse = adsResponse; this.adsResponse = adsResponse;
this.vastLoadTimeoutMs = vastLoadTimeoutMs; this.vastLoadTimeoutMs = vastLoadTimeoutMs;
this.mediaLoadTimeoutMs = mediaLoadTimeoutMs; this.mediaLoadTimeoutMs = mediaLoadTimeoutMs;
this.mediaBitrate = mediaBitrate;
this.focusSkipButtonWhenAvailable = focusSkipButtonWhenAvailable; this.focusSkipButtonWhenAvailable = focusSkipButtonWhenAvailable;
this.adUiElements = adUiElements;
this.adEventListener = adEventListener; this.adEventListener = adEventListener;
this.imaFactory = imaFactory; this.imaFactory = imaFactory;
if (imaSdkSettings == null) { if (imaSdkSettings == null) {
...@@ -949,7 +995,13 @@ public final class ImaAdsLoader ...@@ -949,7 +995,13 @@ public final class ImaAdsLoader
if (mediaLoadTimeoutMs != TIMEOUT_UNSET) { if (mediaLoadTimeoutMs != TIMEOUT_UNSET) {
adsRenderingSettings.setLoadVideoTimeout(mediaLoadTimeoutMs); adsRenderingSettings.setLoadVideoTimeout(mediaLoadTimeoutMs);
} }
if (mediaBitrate != BITRATE_UNSET) {
adsRenderingSettings.setBitrateKbps(mediaBitrate / 1000);
}
adsRenderingSettings.setFocusSkipButtonWhenAvailable(focusSkipButtonWhenAvailable); adsRenderingSettings.setFocusSkipButtonWhenAvailable(focusSkipButtonWhenAvailable);
if (adUiElements != null) {
adsRenderingSettings.setUiElements(adUiElements);
}
// Set up the ad playback state, skipping ads based on the start position as required. // Set up the ad playback state, skipping ads based on the start position as required.
long[] adGroupTimesUs = getAdGroupTimesUs(adsManager.getAdCuePoints()); long[] adGroupTimesUs = getAdGroupTimesUs(adsManager.getAdCuePoints());
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment