AdPlaybackState (ExoPlayer library) - Exoplayer

Package com.google.android.exoplayer2.source.ads

Class AdPlaybackState

java.lang.Object
- com.google.android.exoplayer2.source.ads.AdPlaybackState
All Implemented Interfaces:Bundleable

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classAdPlaybackStateextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")implements[Bundleable](../../Bundleable.html "interface in com.google.android.exoplayer2")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

Represents ad group times and information on the state and URIs of ads within each ad group.

Instances are immutable. Call the with* methods to get new instances that have the required changes.

Nested Class Summary

Nested Classes | Modifier and Type | Class | Description | | --- | --- | --- | | static class | AdPlaybackState.AdGroup | Deprecated.

Represents a group of ads, with information about their states. | | static interface | AdPlaybackState.AdState | Deprecated.

Represents the state of an ad in an ad group. |

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.Bundleable

Bundleable.Creator<T extends Bundleable>

Field Summary

Fields | Modifier and Type | Field | Description | | --- | --- | --- | | static int | AD_STATE_AVAILABLE | Deprecated.

State for an ad that has a URL but has not yet been played. | | static int | AD_STATE_ERROR | Deprecated.

State for an ad that could not be loaded. | | static int | AD_STATE_PLAYED | Deprecated.

State for an ad that was played in full. | | static int | AD_STATE_SKIPPED | Deprecated.

State for an ad that was skipped. | | static int | AD_STATE_UNAVAILABLE | Deprecated.

State for an ad that does not yet have a URL. | | int | adGroupCount | Deprecated.

The number of ad groups. | | long | adResumePositionUs | Deprecated.

The position offset in the first unplayed ad at which to begin playback, in microseconds. | | Object | adsId | Deprecated.

The opaque identifier for ads with which this instance is associated, or null if unset. | | long | contentDurationUs | Deprecated.

The duration of the content period in microseconds, if known. | | static Bundleable.Creator<AdPlaybackState> | CREATOR | Deprecated.

Object that can restore AdPlaybackState from a Bundle. | | static AdPlaybackState | NONE | Deprecated.

Ad playback state with no ads. | | int | removedAdGroupCount | Deprecated.

The number of ad groups that have been removed. |

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | AdPlaybackState(Object adsId, long... adGroupTimesUs) | Deprecated.

Creates a new ad playback state with the specified ad group times. |

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | boolean | endsWithLivePostrollPlaceHolder() | Deprecated.

Returns a copy of the ad playback state with the given ads ID. | | AdPlaybackState.AdGroup | getAdGroup(int adGroupIndex) | Deprecated.

Returns the specified AdPlaybackState.AdGroup. | | int | getAdGroupIndexAfterPositionUs(long positionUs, long periodDurationUs) | Deprecated.

Returns the index of the next ad group after positionUs that should be played. | | int | getAdGroupIndexForPositionUs(long positionUs, long periodDurationUs) | Deprecated.

Returns whether the specified ad has been marked as in AD_STATE_ERROR. | | boolean | isLivePostrollPlaceholder(int adGroupIndex) | Deprecated.

Whether the AdPlaybackState.AdGroup at the given ad group index is a live postroll placeholder. | | Bundle | toBundle() | Deprecated.

Returns an instance with the number of ads in adGroupIndex resolved to adCount. | | AdPlaybackState | withAdDurationsUs(int adGroupIndex, long... adDurationsUs) | Deprecated.

Returns an instance with the specified ad durations, in microseconds, in the specified ad group. | | AdPlaybackState | withAdDurationsUs(long[][] adDurationUs) | Deprecated.

Returns an instance with the specified ad durations, in microseconds. | | AdPlaybackState | withAdGroupTimeUs(int adGroupIndex, long adGroupTimeUs) | Deprecated.

Returns an instance with the specified ad group time. | | AdPlaybackState | withAdLoadError(int adGroupIndex, int adIndexInAdGroup) | Deprecated.

Returns an instance with the specified ad marked as having a load error. | | AdPlaybackState | withAdResumePositionUs(long adResumePositionUs) | Deprecated.

Returns an instance with the specified ad resume position, in microseconds, relative to the start of the current ad. | | AdPlaybackState | withAvailableAd(int adGroupIndex, int adIndexInAdGroup) | Deprecated.

Returns an instance with the specified ad marked as available. | | AdPlaybackState | withAvailableAdUri(int adGroupIndex, int adIndexInAdGroup, Uri uri) | Deprecated.

Returns an instance with the specified ad URI and the ad marked as available. | | AdPlaybackState | withContentDurationUs(long contentDurationUs) | Deprecated.

Returns an instance with the specified content duration, in microseconds. | | AdPlaybackState | withContentResumeOffsetUs(int adGroupIndex, long contentResumeOffsetUs) | Deprecated.

Returns an instance with the specified AdPlaybackState.AdGroup.contentResumeOffsetUs, in microseconds, for the specified ad group. | | AdPlaybackState | withIsServerSideInserted(int adGroupIndex, boolean isServerSideInserted) | Deprecated.

Returns an instance with the specified value for AdPlaybackState.AdGroup.isServerSideInserted in the specified ad group. | | AdPlaybackState | withLastAdRemoved(int adGroupIndex) | Deprecated.

Returns an instance with the last ad of the given ad group removed. | | AdPlaybackState | withLivePostrollPlaceholderAppended() | Deprecated.

Appends a live postroll placeholder ad group to the ad playback state. | | AdPlaybackState | withNewAdGroup(int adGroupIndex, long adGroupTimeUs) | Deprecated.

Returns an instance with a new ad group. | | AdPlaybackState | withOriginalAdCount(int adGroupIndex, int originalAdCount) | Deprecated.

Returns an instance with the specified value for AdPlaybackState.AdGroup.originalCount in the specified ad group. | | AdPlaybackState | withPlayedAd(int adGroupIndex, int adIndexInAdGroup) | Deprecated.

Returns an instance with the specified ad marked as played. | | AdPlaybackState | withRemovedAdGroupCount(int removedAdGroupCount) | Deprecated.

Returns an instance with the specified number of removed ad groups. | | AdPlaybackState | withResetAdGroup(int adGroupIndex) | Deprecated.

Returns an instance with all ads in the specified ad group reset from final states (played, skipped, error) to either available or unavailable, which allows to play them again. | | AdPlaybackState | withSkippedAd(int adGroupIndex, int adIndexInAdGroup) | Deprecated.

Returns an instance with the specified ad marked as skipped. | | AdPlaybackState | withSkippedAdGroup(int adGroupIndex) | Deprecated.

Returns an instance with all ads in the specified ad group skipped (except for those already marked as played or in the error state). |

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AD_STATE_UNAVAILABLE

public static final int AD_STATE_UNAVAILABLE

Deprecated.

State for an ad that does not yet have a URL. See Also:Constant Field Values

AD_STATE_AVAILABLE

public static final int AD_STATE_AVAILABLE

Deprecated.

State for an ad that has a URL but has not yet been played. See Also:Constant Field Values

AD_STATE_SKIPPED

public static final int AD_STATE_SKIPPED

Deprecated.

State for an ad that was skipped. See Also:Constant Field Values

AD_STATE_PLAYED

public static final int AD_STATE_PLAYED

Deprecated.

State for an ad that was played in full. See Also:Constant Field Values

AD_STATE_ERROR

public static final int AD_STATE_ERROR

Deprecated.

State for an ad that could not be loaded. See Also:Constant Field Values

NONE

public static final[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")NONE

Deprecated.

Ad playback state with no ads.

adsId

@Nullable
public final[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")adsId

Deprecated.

The opaque identifier for ads with which this instance is associated, or null if unset.

adGroupCount

public final int adGroupCount

Deprecated.

The number of ad groups.

adResumePositionUs

public final long adResumePositionUs

Deprecated.

The position offset in the first unplayed ad at which to begin playback, in microseconds.

contentDurationUs

public final long contentDurationUs

Deprecated.

The duration of the content period in microseconds, if known. C.TIME_UNSET otherwise.

removedAdGroupCount

public final int removedAdGroupCount

Deprecated.

The number of ad groups that have been removed. Ad groups with indices between 0 (inclusive) and removedAdGroupCount (exclusive) will be empty and must not be modified by any of the with* methods.

CREATOR

public static final[Bundleable.Creator](../../Bundleable.Creator.html "interface in com.google.android.exoplayer2")<[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")> CREATOR

Deprecated.

Object that can restore AdPlaybackState from a Bundle.

The adsId of restored instances will always be null.

Constructor Detail

AdPlaybackState

public AdPlaybackState([Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")adsId,
                       long... adGroupTimesUs)

Deprecated.

Creates a new ad playback state with the specified ad group times. Parameters:adsId - The opaque identifier for ads with which this instance is associated.adGroupTimesUs - The times of ad groups in microseconds, relative to the start of the Timeline.Period they belong to. A final element with the value C.TIME_END_OF_SOURCE indicates that there is a postroll ad.

Method Detail

getAdGroup

public[AdPlaybackState.AdGroup](AdPlaybackState.AdGroup.html "class in com.google.android.exoplayer2.source.ads")getAdGroup(@IntRange(from=0L)
                                          int adGroupIndex)

Deprecated.

Returns the specified AdPlaybackState.AdGroup.

getAdGroupIndexForPositionUs

public int getAdGroupIndexForPositionUs(long positionUs,
                                        long periodDurationUs)

Deprecated.

Returns the index of the ad group at or before positionUs that should be played before the content at positionUs. Returns C.INDEX_UNSET if the ad group at or before positionUs has no ads remaining to be played, or if there is no such ad group. Parameters:positionUs - The period position at or before which to find an ad group, in microseconds, or C.TIME_END_OF_SOURCE for the end of the stream (in which case the index of any unplayed postroll ad group will be returned).periodDurationUs - The duration of the containing timeline period, in microseconds, or C.TIME_UNSET if not known.Returns:The index of the ad group, or C.INDEX_UNSET.

getAdGroupIndexAfterPositionUs

public int getAdGroupIndexAfterPositionUs(long positionUs,
                                          long periodDurationUs)

Deprecated.

Returns the index of the next ad group after positionUs that should be played. Returns C.INDEX_UNSET if there is no such ad group. Parameters:positionUs - The period position after which to find an ad group, in microseconds, or C.TIME_END_OF_SOURCE for the end of the stream (in which case there can be no ad group after the position).periodDurationUs - The duration of the containing timeline period, in microseconds, or C.TIME_UNSET if not known.Returns:The index of the ad group, or C.INDEX_UNSET.

isAdInErrorState

public boolean isAdInErrorState(@IntRange(from=0L)
                                int adGroupIndex,
                                @IntRange(from=0L)
                                int adIndexInAdGroup)

Deprecated.

Returns whether the specified ad has been marked as in AD_STATE_ERROR.

withAdGroupTimeUs

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAdGroupTimeUs(@IntRange(from=0L)
                                         int adGroupIndex,
                                         long adGroupTimeUs)

Deprecated.

Returns an instance with the specified ad group time. Parameters:adGroupIndex - The index of the ad group.adGroupTimeUs - The new ad group time, in microseconds, or C.TIME_END_OF_SOURCE to indicate a postroll ad.Returns:The updated ad playback state.

withNewAdGroup

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withNewAdGroup(@IntRange(from=0L)
                                      int adGroupIndex,
                                      long adGroupTimeUs)

Deprecated.

Returns an instance with a new ad group. Parameters:adGroupIndex - The insertion index of the new group.adGroupTimeUs - The ad group time, in microseconds, or C.TIME_END_OF_SOURCE to indicate a postroll ad.Returns:The updated ad playback state.

withAdCount

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAdCount(@IntRange(from=0L)
                                   int adGroupIndex,
                                   @IntRange(from=1L)
                                   int adCount)

Deprecated.

Returns an instance with the number of ads in adGroupIndex resolved to adCount. The ad count must be greater than zero.

withAvailableAdUri

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAvailableAdUri(@IntRange(from=0L)
                                          int adGroupIndex,
                                          @IntRange(from=0L)
                                          int adIndexInAdGroup,[Uri](https://developer.android.com/reference/android/net/Uri.html "class or interface in android.net")uri)

Deprecated.

Returns an instance with the specified ad URI and the ad marked as available. Throws:IllegalStateException - If Uri.EMPTY is passed as argument for a client-side inserted ad group.

withAvailableAd

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAvailableAd(@IntRange(from=0L)
                                       int adGroupIndex,
                                       @IntRange(from=0L)
                                       int adIndexInAdGroup)

Deprecated.

Returns an instance with the specified ad marked as available.

Must not be called with client side inserted ad groups. Client side inserted ads should use withAvailableAdUri(int, int, android.net.Uri).

Throws:IllegalStateException - in case this methods is called on an ad group that is not server side inserted.

withPlayedAd

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withPlayedAd(@IntRange(from=0L)
                                    int adGroupIndex,
                                    @IntRange(from=0L)
                                    int adIndexInAdGroup)

Deprecated.

Returns an instance with the specified ad marked as played.

withSkippedAd

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withSkippedAd(@IntRange(from=0L)
                                     int adGroupIndex,
                                     @IntRange(from=0L)
                                     int adIndexInAdGroup)

Deprecated.

Returns an instance with the specified ad marked as skipped.

withLastAdRemoved

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withLastAdRemoved(@IntRange(from=0L)
                                         int adGroupIndex)

Deprecated.

Returns an instance with the last ad of the given ad group removed.

withAdLoadError

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAdLoadError(@IntRange(from=0L)
                                       int adGroupIndex,
                                       @IntRange(from=0L)
                                       int adIndexInAdGroup)

Deprecated.

Returns an instance with the specified ad marked as having a load error.

withSkippedAdGroup

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withSkippedAdGroup(@IntRange(from=0L)
                                          int adGroupIndex)

Deprecated.

Returns an instance with all ads in the specified ad group skipped (except for those already marked as played or in the error state).

withAdDurationsUs

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAdDurationsUs(long[][] adDurationUs)

Deprecated.

Returns an instance with the specified ad durations, in microseconds.

Must only be used if removedAdGroupCount is 0.

withAdDurationsUs

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAdDurationsUs(@IntRange(from=0L)
                                         int adGroupIndex,
                                         long... adDurationsUs)

Deprecated.

Returns an instance with the specified ad durations, in microseconds, in the specified ad group.

withAdResumePositionUs

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withAdResumePositionUs(long adResumePositionUs)

Deprecated.

Returns an instance with the specified ad resume position, in microseconds, relative to the start of the current ad.

withContentDurationUs

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withContentDurationUs(long contentDurationUs)

Deprecated.

Returns an instance with the specified content duration, in microseconds.

withRemovedAdGroupCount

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withRemovedAdGroupCount(@IntRange(from=0L)
                                               int removedAdGroupCount)

Deprecated.

Returns an instance with the specified number of removed ad groups.

Ad groups with indices between 0 (inclusive) and removedAdGroupCount (exclusive) will be empty and must not be modified by any of the with* methods.

withContentResumeOffsetUs

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withContentResumeOffsetUs(@IntRange(from=0L)
                                                 int adGroupIndex,
                                                 long contentResumeOffsetUs)

Deprecated.

Returns an instance with the specified AdPlaybackState.AdGroup.contentResumeOffsetUs, in microseconds, for the specified ad group.

withOriginalAdCount

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withOriginalAdCount(@IntRange(from=0L)
                                           int adGroupIndex,
                                           int originalAdCount)

Deprecated.

Returns an instance with the specified value for AdPlaybackState.AdGroup.originalCount in the specified ad group.

withIsServerSideInserted

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withIsServerSideInserted(@IntRange(from=0L)
                                                int adGroupIndex,
                                                boolean isServerSideInserted)

Deprecated.

Returns an instance with the specified value for AdPlaybackState.AdGroup.isServerSideInserted in the specified ad group.

withResetAdGroup

@CheckResult
public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withResetAdGroup(@IntRange(from=0L)
                                        int adGroupIndex)

Deprecated.

Returns an instance with all ads in the specified ad group reset from final states (played, skipped, error) to either available or unavailable, which allows to play them again.

withLivePostrollPlaceholderAppended

public[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")withLivePostrollPlaceholderAppended()

Deprecated.

Appends a live postroll placeholder ad group to the ad playback state.

Adding such a placeholder is only required for periods of server side ad insertion live streams.

When building the media period queue, it sets MediaPeriodId.nextAdGroupIndex of a content period to the index of the placeholder. However, the placeholder will not produce a period in the media period queue. This only happens when an actual ad group is inserted at the given nextAdGroupIndex. In this case the newly inserted ad group will be used to insert an ad period into the media period queue following the content period with the given MediaPeriodId.nextAdGroupIndex.

See endsWithLivePostrollPlaceHolder() also.

Returns:The new ad playback state instance ending with a live postroll placeholder.

endsWithLivePostrollPlaceHolder

public boolean endsWithLivePostrollPlaceHolder()

Deprecated.

Returns whether the last ad group is a live postroll placeholder as inserted by withLivePostrollPlaceholderAppended(). Returns:Whether the ad playback state ends with a live postroll placeholder.

isLivePostrollPlaceholder

public boolean isLivePostrollPlaceholder(int adGroupIndex)

Deprecated.

Whether the AdPlaybackState.AdGroup at the given ad group index is a live postroll placeholder. Parameters:adGroupIndex - The ad group index.Returns:True if the ad group at the given index is a live postroll placeholder, false if not.

fromAdPlaybackState

public static[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")fromAdPlaybackState([Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")adsId,[AdPlaybackState](AdPlaybackState.html "class in com.google.android.exoplayer2.source.ads")adPlaybackState)

Deprecated.

Returns a copy of the ad playback state with the given ads ID. Parameters:adsId - The new ads ID.adPlaybackState - The ad playback state to copy.Returns:The new ad playback state.

equals

public boolean equals(@Nullable[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")o)

Deprecated. Overrides:equals in class Object

hashCode

public int hashCode()

Deprecated. Overrides:hashCode in class Object

toString

public[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")toString()

Deprecated. Overrides:toString in class Object

toBundle

public[Bundle](https://developer.android.com/reference/android/os/Bundle.html "class or interface in android.os")toBundle()

Deprecated.

Returns a Bundle representing the information stored in this object.

It omits the adsId field so the adsId of instances restored by CREATOR will always be null.

Specified by:toBundle in interface Bundleable