AdPlaybackState.AdGroup

AdGroup(timeUs: Long)

Creates a new ad group with an unspecified number of ads.

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

Restores a AdGroup from a Bundle.

fun getFirstAdIndexToPlay(): Int

Returns the index of the first ad in the ad group that should be played, or count if no ads should be played.

fun getNextAdIndexToPlay(lastPlayedAdIndex: @IntRange(from = "-1") Int): Int

Returns the index of the next ad in the ad group that should be played after playing lastPlayedAdIndex, or count if no later ads should be played. If no ads have been played, pass -1 to get the index of the first ad to play.

Note: Server side inserted ads are always considered playable.

fun hasUnplayedAds(): Boolean

Returns whether the ad group has at least one ad that is neither played, skipped, nor failed.

fun shouldPlayAdGroup(): Boolean

Returns whether the ad group has at least one ad that should be played.

fun withAdCount(count: Int): AdPlaybackState.AdGroup!

Returns a new instance with the ad count set to count.

fun withAdDurationsUs(durationsUs: LongArray!): AdPlaybackState.AdGroup!

Returns a new instance with the specified ad durations, in microseconds.

fun withAdMediaItem(mediaItem: MediaItem!, index: @IntRange(from = 0) Int): AdPlaybackState.AdGroup!

Returns a new instance with the specified MediaItem set for the specified ad, and the ad marked as AD_STATE_AVAILABLE.

fun withAdState(
    @AdPlaybackState.AdState state: Int,
    index: @IntRange(from = 0) Int
): AdPlaybackState.AdGroup!

Returns a new instance with the specified ad set to the specified state. The ad specified must currently either be in AD_STATE_UNAVAILABLE or AD_STATE_AVAILABLE.

This instance's ad count may be unknown, in which case index must be less than the ad count specified later. Otherwise, index must be less than the current ad count.

fun withAllAdsReset(): AdPlaybackState.AdGroup!

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

fun withAllAdsSkipped(): AdPlaybackState.AdGroup!

Returns an instance with all unavailable and available ads marked as skipped. If the ad count hasn't been set, it will be set to zero.

fun withContentResumeOffsetUs(contentResumeOffsetUs: Long): AdPlaybackState.AdGroup!

Returns an instance with the specified contentResumeOffsetUs.

fun withIsServerSideInserted(isServerSideInserted: Boolean): AdPlaybackState.AdGroup!

Returns an instance with the specified value for isServerSideInserted.

fun withLastAdRemoved(): AdPlaybackState.AdGroup!

Removes the last ad from the ad group.

fun withOriginalAdCount(originalCount: Int): AdPlaybackState.AdGroup!

Returns an instance with the specified value for originalCount.

fun withTimeUs(timeUs: Long): AdPlaybackState.AdGroup!

Returns a new instance with the timeUs set to the specified value.

val contentResumeOffsetUs: Long

The offset in microseconds which should be added to the content stream when resuming playback after the ad group.

val count: Int

The number of ads in the ad group, or LENGTH_UNSET if unknown.

val durationsUs: LongArray<Long>!

The durations of each ad in the ad group, in microseconds.

val isServerSideInserted: Boolean

Whether this ad group is server-side inserted and part of the content stream.

@NullableType
val mediaItems: Array<@NullableType MediaItem!>!

The MediaItem instances for each ad in the ad group, or null if not yet known.

val originalCount: Int

The original number of ads in the ad group in case the ad group is only partially available, or LENGTH_UNSET if unknown. An ad can be partially available when a server side inserted ad live stream is joined while an ad is already playing and some ad information is missing.

@AdPlaybackState.AdState
val states: IntArray<Int>!

The state of each ad in the ad group.

val timeUs: Long

The time of the ad group in the Timeline.Period, in microseconds, or TIME_END_OF_SOURCE to indicate a postroll ad.