AdPlaybackState

const val AD_STATE_AVAILABLE = 1: Int

State for an ad that has a URL but has not yet been played.

const val AD_STATE_ERROR = 4: Int

State for an ad that could not be loaded.

const val AD_STATE_PLAYED = 3: Int

State for an ad that was played in full.

const val AD_STATE_SKIPPED = 2: Int

State for an ad that was skipped.

const val AD_STATE_UNAVAILABLE = 0: Int

State for an ad that does not yet have a URL.

const val CREATOR: Bundleable.Creator<AdPlaybackState!>!

Object that can restore AdPlaybackState from a Bundle.

The adsId of restored instances will always be null.

const val NONE: AdPlaybackState!

Ad playback state with no ads.

AdPlaybackState(adsId: Any!, adGroupTimesUs: LongArray!)

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

fun endsWithLivePostrollPlaceHolder(): Boolean

Returns whether the last ad group is a live postroll placeholder as inserted by withLivePostrollPlaceholderAppended.

fun equals(o: Any?): Boolean

java-static fun fromAdPlaybackState(adsId: Any!, adPlaybackState: AdPlaybackState!): AdPlaybackState!

Returns a copy of the ad playback state with the given ads ID.

java-static fun fromBundle(bundle: Bundle!): AdPlaybackState!

Restores a AdPlaybackState from a Bundle.

fun getAdGroup(adGroupIndex: @IntRange(from = 0) Int): AdPlaybackState.AdGroup!

Returns the specified AdGroup.

fun getAdGroupIndexAfterPositionUs(positionUs: Long, periodDurationUs: Long): Int

Returns the index of the next ad group after positionUs that should be played. Returns INDEX_UNSET if there is no such ad group.

fun getAdGroupIndexForPositionUs(positionUs: Long, periodDurationUs: Long): Int

Returns the index of the ad group at or before positionUs that should be played before the content at positionUs. Returns 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.

fun hashCode(): Int

fun isAdInErrorState(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int
): Boolean

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

fun isLivePostrollPlaceholder(adGroupIndex: Int): Boolean

Whether the AdGroup at the given ad group index is a live postroll placeholder.

fun toBundle(): Bundle!

Returns a representing the information stored in this object.

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

fun toString(): String!

fun withAdCount(
    adGroupIndex: @IntRange(from = 0) Int,
    adCount: @IntRange(from = 1) Int
): AdPlaybackState!

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

fun withAdDurationsUs(adDurationUs: Array<LongArray!>!): AdPlaybackState!

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

Must only be used if removedAdGroupCount is 0.

fun withAdDurationsUs(
    adGroupIndex: @IntRange(from = 0) Int,
    adDurationsUs: LongArray!
): AdPlaybackState!

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

fun withAdGroupTimeUs(adGroupIndex: @IntRange(from = 0) Int, adGroupTimeUs: Long): AdPlaybackState!

Returns an instance with the specified ad group time.

fun withAdLoadError(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int
): AdPlaybackState!

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

fun withAdResumePositionUs(adResumePositionUs: Long): AdPlaybackState!

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

fun withAvailableAd(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int
): AdPlaybackState!

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 withAvailableAdMediaItem.

fun withAvailableAdMediaItem(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int,
    mediaItem: MediaItem!
): AdPlaybackState!

Returns an instance with the specified ad MediaItem and the ad marked as available.

fun withAvailableAdUri(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int,
    uri: Uri!
): AdPlaybackState!

fun withContentDurationUs(contentDurationUs: Long): AdPlaybackState!

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

fun withContentResumeOffsetUs(
    adGroupIndex: @IntRange(from = 0) Int,
    contentResumeOffsetUs: Long
): AdPlaybackState!

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

fun withIsServerSideInserted(
    adGroupIndex: @IntRange(from = 0) Int,
    isServerSideInserted: Boolean
): AdPlaybackState!

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

fun withLastAdRemoved(adGroupIndex: @IntRange(from = 0) Int): AdPlaybackState!

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

fun withLivePostrollPlaceholderAppended(): AdPlaybackState!

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. A player is not expected to play this placeholder. It is only used to indicate that another ad group with this ad group index will be inserted in the future.

See endsWithLivePostrollPlaceHolder also.

fun withNewAdGroup(adGroupIndex: @IntRange(from = 0) Int, adGroupTimeUs: Long): AdPlaybackState!

Returns an instance with a new ad group.

fun withOriginalAdCount(
    adGroupIndex: @IntRange(from = 0) Int,
    originalAdCount: Int
): AdPlaybackState!

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

fun withPlayedAd(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int
): AdPlaybackState!

Returns an instance with the specified ad marked as played.

fun withRemovedAdGroupCount(removedAdGroupCount: @IntRange(from = 0) Int): AdPlaybackState!

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.

fun withResetAdGroup(adGroupIndex: @IntRange(from = 0) Int): AdPlaybackState!

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.

fun withSkippedAd(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int
): AdPlaybackState!

Returns an instance with the specified ad marked as skipped.

fun withSkippedAdGroup(adGroupIndex: @IntRange(from = 0) Int): AdPlaybackState!

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

val adGroupCount: Int

The number of ad groups.

val adResumePositionUs: Long

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

val adsId: Any?

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

val contentDurationUs: Long

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

val removedAdGroupCount: Int

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.