AdPlaybackState.AdGroup

public final long contentResumeOffsetUs

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

public final int count

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

public final long[] durationsUs

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

@NullableType
public final String[] ids

The optional IDs of the ads.

public final boolean isPlaceholder

Whether this is an ignorable placeholder that must not be attempted to be played.

public final boolean isServerSideInserted

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

@NullableType
public final MediaItem[] mediaItems

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

public final int originalCount

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.

@NullableType
public final AdPlaybackState.SkipInfo[] skipInfos

The skip information for each ad in the ad group.

@AdPlaybackState.AdState
public final int[] states

The state of each ad in the ad group.

public final long timeUs

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

public AdGroup(long timeUs)

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

public AdPlaybackState.AdGroup copy()

Returns a safe copy with all array fields copied into the new instance as new arrays.

public static AdPlaybackState.AdGroup fromBundle(Bundle bundle, int interfaceVersion)

Restores a AdGroup from a Bundle.

public int getFirstAdIndexToPlay()

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

public int getIndexOfAdId(String adId)

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

public int getNextAdIndexToPlay(@IntRange(from = "-1") int lastPlayedAdIndex)

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.

public boolean hasUnplayedAds()

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

public boolean isLivePostrollPlaceholder()

Returns whether this is a placeholder ad group. It can be server-side inserted or not. Use isLivePostrollPlaceholder if you want to differentiate.

public boolean isLivePostrollPlaceholder(boolean isServerSideInserted)

Returns whether this is a is a placeholder ad group.

public boolean shouldPlayAdGroup()

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

public Bundle toBundle(int interfaceVersion)

Write this ad playback state to a Bundle.

public AdPlaybackState.AdGroup withAdCount(int count)

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

public AdPlaybackState.AdGroup withAdDurationsUs(long[] durationsUs)

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

public AdPlaybackState.AdGroup withAdId(String adId, @IntRange(from = 0) int index)

Returns a new instance with the specified ID for the given ad index.

public AdPlaybackState.AdGroup withAdMediaItem(MediaItem mediaItem, @IntRange(from = 0) int index)

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

public AdPlaybackState.AdGroup withAdSkipInfo(
    AdPlaybackState.SkipInfo skipInfo,
    @IntRange(from = 0) int index
)

Returns a new instance with the specified SkipInfo for the given ad index.

public AdPlaybackState.AdGroup withAdState(
    @AdPlaybackState.AdState int state,
    @IntRange(from = 0) int index
)

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.

public AdPlaybackState.AdGroup withAllAdsReset()

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

public AdPlaybackState.AdGroup withAllAdsSkipped()

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.

public AdPlaybackState.AdGroup withAllAdsUnavailable()

Returns an instance with all ads made unavailable.

The state of each ad is set to AD_STATE_UNAVAILABLE, durations are reset to TIME_UNSET and the media item is set to null. The contentResumeOffsetUs is reset to 0 accordingly.

public AdPlaybackState.AdGroup withContentResumeOffsetUs(long contentResumeOffsetUs)

Returns an instance with the specified contentResumeOffsetUs.

public AdPlaybackState.AdGroup withIsServerSideInserted(boolean isServerSideInserted)

Returns an instance with the specified value for isServerSideInserted.

public AdPlaybackState.AdGroup withOriginalAdCount(int originalCount)

Returns an instance with the specified value for originalCount.

public AdPlaybackState.AdGroup withRemovedAdsAfterIndex(int adIndexInAdGroup)

Returns an instance with ads after adIndexInAdGroup removed.

If contentResumeOffsetUs has a non-zero value its value is reset to the safe sum of the remaining durations.

public AdPlaybackState.AdGroup withTimeUs(long timeUs)

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