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 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 copy(): AdPlaybackState!

Returns an new instance that is a safe deep copy of this instance in case an immutable object is used for adsId.

fun endsWithLivePostrollPlaceHolder(): Boolean

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

Note: That either server-side or client-side inserted placeholders are considered. Use endsWithLivePostrollPlaceHolder if you want to test for one or the other only.

fun endsWithLivePostrollPlaceHolder(isServerSideInserted: Boolean): Boolean

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

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 getAdIndexOfAdId(adGroupIndex: Int, adId: String!): Int

Returns the index of the ad with the given ad ID in the given ad group, or INDEX_UNSET if the ad ID can't be found.

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

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

Note: That either server-side or client-side inserted placeholders return true. Use isLivePostrollPlaceholder if you want to test for one or the other only.

fun isLivePostrollPlaceholder(
    adGroupIndex: Int,
    isServerSideInserted: Boolean
): Boolean

Returns whether the AdGroup at the given ad group index is a live postroll placeholder and either server or client-side inserted.

fun toBundle(): Bundle!

Returns a Bundle representing the information stored in this object.

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

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.

The number of arrays of durations (adDurations.length) must always be equal to adGroupCount. This is required even on an instance created with withRemovedAdGroupCount. The array of durations at the index of a removed ad group can be null or empty.

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 withAdId(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int,
    adId: String!
): AdPlaybackState!

Returns an instance with the specified ad ID for the given ad.

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 withAdSkipInfo(
    adGroupIndex: @IntRange(from = 0) Int,
    adIndexInAdGroup: @IntRange(from = 0) Int,
    skipInfo: AdPlaybackState.SkipInfo!
): AdPlaybackState!

Returns an instance with the specified SkipInfo for the given ad.

fun withAdsId(adsId: Any!): AdPlaybackState!

Returns an instance with the specified value for adsId.

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 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(isServerSideInserted: Boolean): AdPlaybackState!

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

Adding such a placeholder is only required for periods of 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 and 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 withRemovedAdGroupCountBefore(timeUs: Long): AdPlaybackState!

Returns an instance with ad groups removed until and excluding the first post roll ad group or the first ad group with timeUs larger than the given time, in microseconds.

Any ad group with timeUs set to TIME_END_OF_SOURCE is considered a post roll ad group.

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.