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

Class AdPlaybackState

  • All Implemented Interfaces:
    Bundleable
    @Deprecated
public final class AdPlaybackState
extends Object
implements Bundleable
    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.

    • 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 NONE
        Deprecated.
        Ad playback state with no ads.

      • adsId

        @Nullable
public final Object 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.

    • Constructor Detail

      • AdPlaybackState

        public AdPlaybackState​(Object 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

      • 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 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 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 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 withAvailableAdUri​(@IntRange(from=0L)
                                          int adGroupIndex,
                                          @IntRange(from=0L)
                                          int adIndexInAdGroup,
                                          Uri 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.

      • withPlayedAd

        @CheckResult
public AdPlaybackState 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 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 withLastAdRemoved​(@IntRange(from=0L)
                                         int adGroupIndex)
        Deprecated.
        Returns an instance with the last ad of the given ad group removed.

      • withAdLoadError

        @CheckResult
public AdPlaybackState 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 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 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 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 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 withContentDurationUs​(long contentDurationUs)
        Deprecated.
        Returns an instance with the specified content duration, in microseconds.

      • withRemovedAdGroupCount

        @CheckResult
public AdPlaybackState 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 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 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.

      • withResetAdGroup

        @CheckResult
public AdPlaybackState 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 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 fromAdPlaybackState​(Object adsId,
                                                  AdPlaybackState 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 o)
        Deprecated.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Deprecated.
        Overrides:
        hashCode in class Object

      • toBundle

        public Bundle 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