loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add MediaItem.AdsConfiguration.Builder

Browse Source 
PiperOrigin-RevId: 397718885
This commit is contained in:
ibaker 2021-09-20 12:37:45 +01:00 committed by Christos Tsilopoulos
parent 46d97bdd39
commit 47b82cdc45
2 changed files with 107 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
library/common/src/main/java/com/google/android/exoplayer2/MediaItem.java
View File

@ -78,8 +78,7 @@ public final class MediaItem implements Bundleable {
private List<StreamKey> streamKeys;
@Nullable private String customCacheKey;
private List<Subtitle> subtitles;
@Nullable private Uri adTagUri;
@Nullable private Object adsId;
@Nullable private AdsConfiguration adsConfiguration;
@Nullable private Object tag;
@Nullable private MediaMetadata mediaMetadata;
private long liveTargetOffsetMs;
@ -128,11 +127,7 @@ public final class MediaItem implements Bundleable {
playbackProperties.drmConfiguration != null
? playbackProperties.drmConfiguration.buildUpon()
: new DrmConfiguration.Builder();
@Nullable AdsConfiguration adsConfiguration = playbackProperties.adsConfiguration;
if (adsConfiguration != null) {
adTagUri = adsConfiguration.adTagUri;
adsId = adsConfiguration.adsId;
}
adsConfiguration = playbackProperties.adsConfiguration;
}
}
@ -384,54 +379,43 @@ public final class MediaItem implements Bundleable {
}
/**
* Sets the optional ad tag {@link Uri}.
*
* <p>Media items in the playlist with the same ad tag URI, media ID and ads loader will share
* the same ad playback state. To resume ad playback when recreating the playlist on returning
* from the background, pass media items with the same ad tag URIs and media IDs to the player.
* Sets the optional {@link AdsConfiguration}.
*
* <p>This method should only be called if {@link #setUri} is passed a non-null value.
*
* @param adTagUri The ad tag URI to load.
*/
public Builder setAdsConfiguration(@Nullable AdsConfiguration adsConfiguration) {
this.adsConfiguration = adsConfiguration;
return this;
}
/**
* @deprecated Use {@link #setAdsConfiguration(AdsConfiguration)}, parse the {@code adTagUri}
* with {@link Uri#parse(String)} and pass the result to {@link
* AdsConfiguration.Builder#Builder(Uri)} instead.
*/
@Deprecated
public Builder setAdTagUri(@Nullable String adTagUri) {
return setAdTagUri(adTagUri != null ? Uri.parse(adTagUri) : null);
}
/**
* Sets the optional ad tag {@link Uri}.
*
* <p>Media items in the playlist with the same ad tag URI, media ID and ads loader will share
* the same ad playback state. To resume ad playback when recreating the playlist on returning
* from the background, pass media items with the same ad tag URIs and media IDs to the player.
*
* <p>This method should only be called if {@link #setUri} is passed a non-null value.
*
* @param adTagUri The ad tag URI to load.
* @deprecated Use {@link #setAdsConfiguration(AdsConfiguration)} and pass the {@code adTagUri}
* to {@link AdsConfiguration.Builder#Builder(Uri)} instead.
*/
@Deprecated
public Builder setAdTagUri(@Nullable Uri adTagUri) {
return setAdTagUri(adTagUri, /* adsId= */ null);
}
/**
* Sets the optional ad tag {@link Uri} and ads identifier.
*
* <p>Media items in the playlist that have the same ads identifier and ads loader share the
* same ad playback state. To resume ad playback when recreating the playlist on returning from
* the background, pass the same ads IDs to the player.
*
* <p>This method should only be called if {@link #setUri} is passed a non-null value.
*
* @param adTagUri The ad tag URI to load.
* @param adsId An opaque identifier for ad playback state associated with this item. Ad loading
* and playback state is shared among all media items that have the same ads ID (by {@link
* Object#equals(Object) equality}) and ads loader, so it is important to pass the same
* identifiers when constructing playlist items each time the player returns to the
* foreground.
* @deprecated Use {@link #setAdsConfiguration(AdsConfiguration)}, pass the {@code adTagUri} to
* {@link AdsConfiguration.Builder#Builder(Uri)} and the {@code adsId} to {@link
* AdsConfiguration.Builder#setAdsId(Object)} instead.
*/
@Deprecated
public Builder setAdTagUri(@Nullable Uri adTagUri, @Nullable Object adsId) {
this.adTagUri = adTagUri;
this.adsId = adsId;
this.adsConfiguration =
adTagUri != null ? new AdsConfiguration.Builder(adTagUri).setAdsId(adsId).build() : null;
return this;
}
@ -530,7 +514,7 @@ public final class MediaItem implements Bundleable {
uri,
mimeType,
drmConfiguration.uuid != null ? drmConfiguration.build() : null,
adTagUri != null ? new AdsConfiguration(adTagUri, adsId) : null,
adsConfiguration,
streamKeys,
customCacheKey,
subtitles,
@ -813,28 +797,65 @@ public final class MediaItem implements Bundleable {
/** Configuration for playing back linear ads with a media item. */
public static final class AdsConfiguration {
/** Builder for {@link AdsConfiguration} instances. */
public static final class Builder {
private Uri adTagUri;
@Nullable private Object adsId;
/**
* Constructs a new instance.
*
* @param adTagUri The ad tag URI to load.
*/
public Builder(Uri adTagUri) {
this.adTagUri = adTagUri;
}
/** Sets the ad tag URI to load. */
public Builder setAdTagUri(Uri adTagUri) {
this.adTagUri = adTagUri;
return this;
}
/**
* Sets the ads identifier.
*
* <p>See details on {@link AdsConfiguration#adsId} for how the ads identifier is used and how
* it's calculated if not explicitly set.
*/
public Builder setAdsId(@Nullable Object adsId) {
this.adsId = adsId;
return this;
}
public AdsConfiguration build() {
return new AdsConfiguration(this);
}
}
/** The ad tag URI to load. */
public final Uri adTagUri;
/**
* An opaque identifier for ad playback state associated with this item, or {@code null} if the
* combination of the {@link MediaItem.Builder#setMediaId(String) media ID} and {@link #adTagUri
* ad tag URI} should be used as the ads identifier.
*
* <p>Media items in the playlist that have the same ads identifier and ads loader share the
* same ad playback state. To resume ad playback when recreating the playlist on returning from
* the background, pass the same ads identifiers to the player.
*/
@Nullable public final Object adsId;
/**
* Creates an ads configuration with the given ad tag URI and ads identifier.
*
* @param adTagUri The ad tag URI to load.
* @param adsId An opaque identifier for ad playback state associated with this item. Ad loading
* and playback state is shared among all media items that have the same ads ID (by {@link
* Object#equals(Object) equality}) and ads loader, so it is important to pass the same
* identifiers when constructing playlist items each time the player returns to the
* foreground.
*/
private AdsConfiguration(Uri adTagUri, @Nullable Object adsId) {
this.adTagUri = adTagUri;
this.adsId = adsId;
private AdsConfiguration(Builder builder) {
this.adTagUri = builder.adTagUri;
this.adsId = builder.adsId;
}
/** Returns a {@link Builder} initialized with the values of this instance. */
public Builder buildUpon() {
return new Builder(adTagUri).setAdsId(adsId);
}
@Override

34
library/common/src/test/java/com/google/android/exoplayer2/MediaItemTest.java
View File

@ -361,6 +361,36 @@ public class MediaItemTest {
}
@Test
public void builderSetAdsConfiguration_justUri() {
Uri adTagUri = Uri.parse(URI_STRING + "/ad");
MediaItem mediaItem =
new MediaItem.Builder()
.setUri(URI_STRING)
.setAdsConfiguration(new MediaItem.AdsConfiguration.Builder(adTagUri).build())
.build();
assertThat(mediaItem.playbackProperties.adsConfiguration.adTagUri).isEqualTo(adTagUri);
assertThat(mediaItem.playbackProperties.adsConfiguration.adsId).isNull();
}
@Test
public void builderSetAdsConfiguration_withAdsId() {
Uri adTagUri = Uri.parse(URI_STRING + "/ad");
Object adsId = new Object();
MediaItem mediaItem =
new MediaItem.Builder()
.setUri(URI_STRING)
.setAdsConfiguration(
new MediaItem.AdsConfiguration.Builder(adTagUri).setAdsId(adsId).build())
.build();
assertThat(mediaItem.playbackProperties.adsConfiguration.adTagUri).isEqualTo(adTagUri);
assertThat(mediaItem.playbackProperties.adsConfiguration.adsId).isEqualTo(adsId);
}
@Test
@SuppressWarnings("deprecation") // Testing deprecated setter
public void builderSetAdTagUri_setsAdTagUri() {
Uri adTagUri = Uri.parse(URI_STRING + "/ad");
@ -371,6 +401,7 @@ public class MediaItemTest {
}
@Test
@SuppressWarnings("deprecation") // Testing deprecated setter
public void builderSetAdTagUriAndAdsId_setsAdsConfiguration() {
Uri adTagUri = Uri.parse(URI_STRING + "/ad");
Object adsId = new Object();
@ -484,7 +515,8 @@ public class MediaItemTest {
public void buildUpon_wholeObjectSetters_equalsToOriginal() {
MediaItem mediaItem =
new MediaItem.Builder()
.setAdTagUri(URI_STRING)
.setAdsConfiguration(
new MediaItem.AdsConfiguration.Builder(Uri.parse(URI_STRING)).build())
.setClipEndPositionMs(1000)
.setClipRelativeToDefaultPosition(true)
.setClipRelativeToLiveWindow(true)