Skip to content

SDK / exoplayer

Go to a project
Commit 9666fbdd by ibaker Committed by Christos Tsilopoulos
Options

Add MediaItem.LiveConfiguration.Builder 

PiperOrigin-RevId: 397748657
parent 47b82cdc
Inline Side-by-side
Showing with 184 additions and 88 deletions
library/common/src/main/java/com/google/android/exoplayer2/MediaItem.java
...@@ -81,11 +81,9 @@ public final class MediaItem implements Bundleable { ...@@ -81,11 +81,9 @@ public final class MediaItem implements Bundleable {
@Nullable private AdsConfiguration adsConfiguration; @Nullable private AdsConfiguration adsConfiguration;
@Nullable private Object tag; @Nullable private Object tag;
@Nullable private MediaMetadata mediaMetadata; @Nullable private MediaMetadata mediaMetadata;
private long liveTargetOffsetMs; // TODO: Change this to LiveConfiguration once all the deprecated individual setters
private long liveMinOffsetMs; // are removed.
private long liveMaxOffsetMs; private LiveConfiguration.Builder liveConfiguration;
private float liveMinPlaybackSpeed;
private float liveMaxPlaybackSpeed;
/** Creates a builder. */ /** Creates a builder. */
@SuppressWarnings("deprecation") // Temporarily uses DrmConfiguration.Builder() constructor. @SuppressWarnings("deprecation") // Temporarily uses DrmConfiguration.Builder() constructor.
...@@ -94,11 +92,7 @@ public final class MediaItem implements Bundleable { ...@@ -94,11 +92,7 @@ public final class MediaItem implements Bundleable {
drmConfiguration = new DrmConfiguration.Builder(); drmConfiguration = new DrmConfiguration.Builder();
streamKeys = Collections.emptyList(); streamKeys = Collections.emptyList();
subtitles = Collections.emptyList(); subtitles = Collections.emptyList();
liveTargetOffsetMs = C.TIME_UNSET; liveConfiguration = new LiveConfiguration.Builder();
liveMinOffsetMs = C.TIME_UNSET;
liveMaxOffsetMs = C.TIME_UNSET;
liveMinPlaybackSpeed = C.RATE_UNSET;
liveMaxPlaybackSpeed = C.RATE_UNSET;
} }
private Builder(MediaItem mediaItem) { private Builder(MediaItem mediaItem) {
...@@ -110,11 +104,7 @@ public final class MediaItem implements Bundleable { ...@@ -110,11 +104,7 @@ public final class MediaItem implements Bundleable {
clipStartsAtKeyFrame = mediaItem.clippingProperties.startsAtKeyFrame; clipStartsAtKeyFrame = mediaItem.clippingProperties.startsAtKeyFrame;
mediaId = mediaItem.mediaId; mediaId = mediaItem.mediaId;
mediaMetadata = mediaItem.mediaMetadata; mediaMetadata = mediaItem.mediaMetadata;
liveTargetOffsetMs = mediaItem.liveConfiguration.targetOffsetMs; liveConfiguration = mediaItem.liveConfiguration.buildUpon();
liveMinOffsetMs = mediaItem.liveConfiguration.minOffsetMs;
liveMaxOffsetMs = mediaItem.liveConfiguration.maxOffsetMs;
liveMinPlaybackSpeed = mediaItem.liveConfiguration.minPlaybackSpeed;
liveMaxPlaybackSpeed = mediaItem.liveConfiguration.maxPlaybackSpeed;
@Nullable PlaybackProperties playbackProperties = mediaItem.playbackProperties; @Nullable PlaybackProperties playbackProperties = mediaItem.playbackProperties;
if (playbackProperties != null) { if (playbackProperties != null) {
customCacheKey = playbackProperties.customCacheKey; customCacheKey = playbackProperties.customCacheKey;
...@@ -419,68 +409,59 @@ public final class MediaItem implements Bundleable { ...@@ -419,68 +409,59 @@ public final class MediaItem implements Bundleable {
return this; return this;
} }
/** Sets the {@link LiveConfiguration}. Defaults to {@link LiveConfiguration#UNSET}. */
public Builder setLiveConfiguration(LiveConfiguration liveConfiguration) {
this.liveConfiguration = liveConfiguration.buildUpon();
return this;
}
/** /**
* Sets the optional target offset from the live edge for live streams, in milliseconds. * @deprecated Use {@link #setLiveConfiguration(LiveConfiguration)} and {@link
* * LiveConfiguration.Builder#setTargetOffsetMs(long)}.
* <p>See {@code Player#getCurrentLiveOffset()}.
*
* @param liveTargetOffsetMs The target offset, in milliseconds, or {@link C#TIME_UNSET} to use
* the media-defined default.
*/ */
@Deprecated
public Builder setLiveTargetOffsetMs(long liveTargetOffsetMs) { public Builder setLiveTargetOffsetMs(long liveTargetOffsetMs) {
this.liveTargetOffsetMs = liveTargetOffsetMs; liveConfiguration.setTargetOffsetMs(liveTargetOffsetMs);
return this; return this;
} }
/** /**
* Sets the optional minimum offset from the live edge for live streams, in milliseconds. * @deprecated Use {@link #setLiveConfiguration(LiveConfiguration)} and {@link
* * LiveConfiguration.Builder#setMinOffsetMs(long)}.
* <p>See {@code Player#getCurrentLiveOffset()}.
*
* @param liveMinOffsetMs The minimum allowed offset, in milliseconds, or {@link C#TIME_UNSET}
* to use the media-defined default.
*/ */
@Deprecated
public Builder setLiveMinOffsetMs(long liveMinOffsetMs) { public Builder setLiveMinOffsetMs(long liveMinOffsetMs) {
this.liveMinOffsetMs = liveMinOffsetMs; liveConfiguration.setMinOffsetMs(liveMinOffsetMs);
return this; return this;
} }
/** /**
* Sets the optional maximum offset from the live edge for live streams, in milliseconds. * @deprecated Use {@link #setLiveConfiguration(LiveConfiguration)} and {@link
* * LiveConfiguration.Builder#setMaxOffsetMs(long)}.
* <p>See {@code Player#getCurrentLiveOffset()}.
*
* @param liveMaxOffsetMs The maximum allowed offset, in milliseconds, or {@link C#TIME_UNSET}
* to use the media-defined default.
*/ */
@Deprecated
public Builder setLiveMaxOffsetMs(long liveMaxOffsetMs) { public Builder setLiveMaxOffsetMs(long liveMaxOffsetMs) {
this.liveMaxOffsetMs = liveMaxOffsetMs; liveConfiguration.setMaxOffsetMs(liveMaxOffsetMs);
return this; return this;
} }
/** /**
* Sets the optional minimum playback speed for live stream speed adjustment. * @deprecated Use {@link #setLiveConfiguration(LiveConfiguration)} and {@link
* * LiveConfiguration.Builder#setMinPlaybackSpeed(float)}.
* <p>This value is ignored for other stream types.
*
* @param minPlaybackSpeed The minimum factor by which playback can be sped up for live streams,
* or {@link C#RATE_UNSET} to use the media-defined default.
*/ */
@Deprecated
public Builder setLiveMinPlaybackSpeed(float minPlaybackSpeed) { public Builder setLiveMinPlaybackSpeed(float minPlaybackSpeed) {
this.liveMinPlaybackSpeed = minPlaybackSpeed; liveConfiguration.setMinPlaybackSpeed(minPlaybackSpeed);
return this; return this;
} }
/** /**
* Sets the optional maximum playback speed for live stream speed adjustment. * @deprecated Use {@link #setLiveConfiguration(LiveConfiguration)} and {@link
* * LiveConfiguration.Builder#setMaxPlaybackSpeed(float)}.
* <p>This value is ignored for other stream types.
*
* @param maxPlaybackSpeed The maximum factor by which playback can be sped up for live streams,
* or {@link C#RATE_UNSET} to use the media-defined default.
*/ */
@Deprecated
public Builder setLiveMaxPlaybackSpeed(float maxPlaybackSpeed) { public Builder setLiveMaxPlaybackSpeed(float maxPlaybackSpeed) {
this.liveMaxPlaybackSpeed = maxPlaybackSpeed; liveConfiguration.setMaxPlaybackSpeed(maxPlaybackSpeed);
return this; return this;
} }
...@@ -529,12 +510,7 @@ public final class MediaItem implements Bundleable { ...@@ -529,12 +510,7 @@ public final class MediaItem implements Bundleable {
clipRelativeToDefaultPosition, clipRelativeToDefaultPosition,
clipStartsAtKeyFrame), clipStartsAtKeyFrame),
playbackProperties, playbackProperties,
new LiveConfiguration( liveConfiguration.build(),
liveTargetOffsetMs,
liveMinOffsetMs,
liveMaxOffsetMs,
liveMinPlaybackSpeed,
liveMaxPlaybackSpeed),
mediaMetadata != null ? mediaMetadata : MediaMetadata.EMPTY); mediaMetadata != null ? mediaMetadata : MediaMetadata.EMPTY);
} }
} }
...@@ -971,14 +947,98 @@ public final class MediaItem implements Bundleable { ...@@ -971,14 +947,98 @@ public final class MediaItem implements Bundleable {
/** Live playback configuration. */ /** Live playback configuration. */
public static final class LiveConfiguration implements Bundleable { public static final class LiveConfiguration implements Bundleable {
/** A live playback configuration with unset values. */ /** Builder for {@link LiveConfiguration} instances. */
public static final LiveConfiguration UNSET = public static final class Builder {
new LiveConfiguration( private long targetOffsetMs;
/* targetLiveOffsetMs= */ C.TIME_UNSET, private long minOffsetMs;
/* minLiveOffsetMs= */ C.TIME_UNSET, private long maxOffsetMs;
/* maxLiveOffsetMs= */ C.TIME_UNSET, private float minPlaybackSpeed;
/* minPlaybackSpeed= */ C.RATE_UNSET, private float maxPlaybackSpeed;
/* maxPlaybackSpeed= */ C.RATE_UNSET);
/** Constructs an instance. */
public Builder() {
this.targetOffsetMs = C.TIME_UNSET;
this.minOffsetMs = C.TIME_UNSET;
this.maxOffsetMs = C.TIME_UNSET;
this.minPlaybackSpeed = C.RATE_UNSET;
this.maxPlaybackSpeed = C.RATE_UNSET;
}
private Builder(LiveConfiguration liveConfiguration) {
this.targetOffsetMs = liveConfiguration.targetOffsetMs;
this.minOffsetMs = liveConfiguration.minOffsetMs;
this.maxOffsetMs = liveConfiguration.maxOffsetMs;
this.minPlaybackSpeed = liveConfiguration.minPlaybackSpeed;
this.maxPlaybackSpeed = liveConfiguration.maxPlaybackSpeed;
}
/**
* Sets the target live offset, in milliseconds.
*
* <p>See {@code Player#getCurrentLiveOffset()}.
*
* <p>Defaults to {@link C#TIME_UNSET}, indicating the media-defined default will be used.
*/
public Builder setTargetOffsetMs(long targetOffsetMs) {
this.targetOffsetMs = targetOffsetMs;
return this;
}
/**
* Sets the minimum allowed live offset, in milliseconds.
*
* <p>See {@code Player#getCurrentLiveOffset()}.
*
* <p>Defaults to {@link C#TIME_UNSET}, indicating the media-defined default will be used.
*/
public Builder setMinOffsetMs(long minOffsetMs) {
this.minOffsetMs = minOffsetMs;
return this;
}
/**
* Sets the maximum allowed live offset, in milliseconds.
*
* <p>See {@code Player#getCurrentLiveOffset()}.
*
* <p>Defaults to {@link C#TIME_UNSET}, indicating the media-defined default will be used.
*/
public Builder setMaxOffsetMs(long maxOffsetMs) {
this.maxOffsetMs = maxOffsetMs;
return this;
}
/**
* Sets the minimum playback speed.
*
* <p>Defaults to {@link C#RATE_UNSET}, indicating the media-defined default will be used.
*/
public Builder setMinPlaybackSpeed(float minPlaybackSpeed) {
this.minPlaybackSpeed = minPlaybackSpeed;
return this;
}
/**
* Sets the maximum playback speed.
*
* <p>Defaults to {@link C#RATE_UNSET}, indicating the media-defined default will be used.
*/
public Builder setMaxPlaybackSpeed(float maxPlaybackSpeed) {
this.maxPlaybackSpeed = maxPlaybackSpeed;
return this;
}
/** Creates a {@link LiveConfiguration} with the values from this builder. */
public LiveConfiguration build() {
return new LiveConfiguration(this);
}
}
/**
* A live playback configuration with unset values, meaning media-defined default values will be
* used.
*/
public static final LiveConfiguration UNSET = new LiveConfiguration.Builder().build();
/** /**
* Target offset from the live edge, in milliseconds, or {@link C#TIME_UNSET} to use the * Target offset from the live edge, in milliseconds, or {@link C#TIME_UNSET} to use the
...@@ -1010,20 +1070,18 @@ public final class MediaItem implements Bundleable { ...@@ -1010,20 +1070,18 @@ public final class MediaItem implements Bundleable {
*/ */
public final float maxPlaybackSpeed; public final float maxPlaybackSpeed;
/** @SuppressWarnings("deprecation") // Using the deprecated constructor while it exists.
* Creates a live playback configuration. private LiveConfiguration(Builder builder) {
* this(
* @param targetOffsetMs Target live offset, in milliseconds, or {@link C#TIME_UNSET} to use the builder.targetOffsetMs,
* media-defined default. builder.minOffsetMs,
* @param minOffsetMs The minimum allowed live offset, in milliseconds, or {@link C#TIME_UNSET} builder.maxOffsetMs,
* to use the media-defined default. builder.minPlaybackSpeed,
* @param maxOffsetMs The maximum allowed live offset, in milliseconds, or {@link C#TIME_UNSET} builder.maxPlaybackSpeed);
* to use the media-defined default. }
* @param minPlaybackSpeed Minimum playback speed, or {@link C#RATE_UNSET} to use the
* media-defined default. /** @deprecated Use {@link Builder} instead. */
* @param maxPlaybackSpeed Maximum playback speed, or {@link C#RATE_UNSET} to use the @Deprecated
* media-defined default.
*/
public LiveConfiguration( public LiveConfiguration(
long targetOffsetMs, long targetOffsetMs,
long minOffsetMs, long minOffsetMs,
...@@ -1037,6 +1095,11 @@ public final class MediaItem implements Bundleable { ...@@ -1037,6 +1095,11 @@ public final class MediaItem implements Bundleable {
this.maxPlaybackSpeed = maxPlaybackSpeed; this.maxPlaybackSpeed = maxPlaybackSpeed;
} }
/** Returns a {@link Builder} initialized with the values of this instance. */
public Builder buildUpon() {
return new Builder(this);
}
@Override @Override
public boolean equals(@Nullable Object obj) { public boolean equals(@Nullable Object obj) {
if (this == obj) { if (this == obj) {
......
library/common/src/test/java/com/google/android/exoplayer2/MediaItemTest.java
...@@ -424,6 +424,29 @@ public class MediaItemTest { ...@@ -424,6 +424,29 @@ public class MediaItemTest {
} }
@Test @Test
public void builderSetLiveConfiguration() {
MediaItem mediaItem =
new MediaItem.Builder()
.setUri(URI_STRING)
.setLiveConfiguration(
new MediaItem.LiveConfiguration.Builder()
.setTargetOffsetMs(10_000)
.setMinOffsetMs(20_000)
.setMaxOffsetMs(30_000)
.setMinPlaybackSpeed(0.5f)
.setMaxPlaybackSpeed(2f)
.build())
.build();
assertThat(mediaItem.liveConfiguration.targetOffsetMs).isEqualTo(10_000);
assertThat(mediaItem.liveConfiguration.minOffsetMs).isEqualTo(20_000);
assertThat(mediaItem.liveConfiguration.maxOffsetMs).isEqualTo(30_000);
assertThat(mediaItem.liveConfiguration.minPlaybackSpeed).isEqualTo(0.5f);
assertThat(mediaItem.liveConfiguration.maxPlaybackSpeed).isEqualTo(2f);
}
@Test
@SuppressWarnings("deprecation") // Tests deprecated setter
public void builderSetLiveTargetOffsetMs_setsLiveTargetOffsetMs() { public void builderSetLiveTargetOffsetMs_setsLiveTargetOffsetMs() {
MediaItem mediaItem = MediaItem mediaItem =
new MediaItem.Builder().setUri(URI_STRING).setLiveTargetOffsetMs(10_000).build(); new MediaItem.Builder().setUri(URI_STRING).setLiveTargetOffsetMs(10_000).build();
...@@ -432,6 +455,7 @@ public class MediaItemTest { ...@@ -432,6 +455,7 @@ public class MediaItemTest {
} }
@Test @Test
@SuppressWarnings("deprecation") // Tests deprecated setter
public void builderSetMinLivePlaybackSpeed_setsMinLivePlaybackSpeed() { public void builderSetMinLivePlaybackSpeed_setsMinLivePlaybackSpeed() {
MediaItem mediaItem = MediaItem mediaItem =
new MediaItem.Builder().setUri(URI_STRING).setLiveMinPlaybackSpeed(.9f).build(); new MediaItem.Builder().setUri(URI_STRING).setLiveMinPlaybackSpeed(.9f).build();
...@@ -440,6 +464,7 @@ public class MediaItemTest { ...@@ -440,6 +464,7 @@ public class MediaItemTest {
} }
@Test @Test
@SuppressWarnings("deprecation") // Tests deprecated setter
public void builderSetMaxLivePlaybackSpeed_setsMaxLivePlaybackSpeed() { public void builderSetMaxLivePlaybackSpeed_setsMaxLivePlaybackSpeed() {
MediaItem mediaItem = MediaItem mediaItem =
new MediaItem.Builder().setUri(URI_STRING).setLiveMaxPlaybackSpeed(1.1f).build(); new MediaItem.Builder().setUri(URI_STRING).setLiveMaxPlaybackSpeed(1.1f).build();
...@@ -448,6 +473,7 @@ public class MediaItemTest { ...@@ -448,6 +473,7 @@ public class MediaItemTest {
} }
@Test @Test
@SuppressWarnings("deprecation") // Tests deprecated setter
public void builderSetMinLiveOffset_setsMinLiveOffset() { public void builderSetMinLiveOffset_setsMinLiveOffset() {
MediaItem mediaItem = MediaItem mediaItem =
new MediaItem.Builder().setUri(URI_STRING).setLiveMinOffsetMs(1234).build(); new MediaItem.Builder().setUri(URI_STRING).setLiveMinOffsetMs(1234).build();
...@@ -456,6 +482,7 @@ public class MediaItemTest { ...@@ -456,6 +482,7 @@ public class MediaItemTest {
} }
@Test @Test
@SuppressWarnings("deprecation") // Tests deprecated setter
public void builderSetMaxLiveOffset_setsMaxLiveOffset() { public void builderSetMaxLiveOffset_setsMaxLiveOffset() {
MediaItem mediaItem = MediaItem mediaItem =
new MediaItem.Builder().setUri(URI_STRING).setLiveMaxOffsetMs(1234).build(); new MediaItem.Builder().setUri(URI_STRING).setLiveMaxOffsetMs(1234).build();
...@@ -538,11 +565,14 @@ public class MediaItemTest { ...@@ -538,11 +565,14 @@ public class MediaItemTest {
.setMimeType(MimeTypes.APPLICATION_MP4) .setMimeType(MimeTypes.APPLICATION_MP4)
.setUri(URI_STRING) .setUri(URI_STRING)
.setStreamKeys(ImmutableList.of(new StreamKey(1, 0, 0))) .setStreamKeys(ImmutableList.of(new StreamKey(1, 0, 0)))
.setLiveTargetOffsetMs(20_000) .setLiveConfiguration(
.setLiveMinPlaybackSpeed(.9f) new MediaItem.LiveConfiguration.Builder()
.setLiveMaxPlaybackSpeed(1.1f) .setTargetOffsetMs(20_000)
.setLiveMinOffsetMs(2222) .setMinPlaybackSpeed(.9f)
.setLiveMaxOffsetMs(4444) .setMaxPlaybackSpeed(1.1f)
.setMinOffsetMs(2222)
.setMaxOffsetMs(4444)
.build())
.setSubtitles( .setSubtitles(
ImmutableList.of( ImmutableList.of(
new MediaItem.Subtitle( new MediaItem.Subtitle(
...@@ -565,11 +595,14 @@ public class MediaItemTest { ...@@ -565,11 +595,14 @@ public class MediaItemTest {
MediaItem mediaItem = MediaItem mediaItem =
new MediaItem.Builder() new MediaItem.Builder()
.setMediaId("mediaId") .setMediaId("mediaId")
.setLiveTargetOffsetMs(20_000) .setLiveConfiguration(
.setLiveMinOffsetMs(2_222) new MediaItem.LiveConfiguration.Builder()
.setLiveMaxOffsetMs(4_444) .setTargetOffsetMs(20_000)
.setLiveMinPlaybackSpeed(.9f) .setMinOffsetMs(2_222)
.setLiveMaxPlaybackSpeed(1.1f) .setMaxOffsetMs(4_444)
.setMinPlaybackSpeed(.9f)
.setMaxPlaybackSpeed(1.1f)
.build())
.setMediaMetadata(new MediaMetadata.Builder().setTitle("title").build()) .setMediaMetadata(new MediaMetadata.Builder().setTitle("title").build())
.setClipStartPositionMs(100) .setClipStartPositionMs(100)
.setClipEndPositionMs(1_000) .setClipEndPositionMs(1_000)
......
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