Timeline.Period (ExoPlayer library)

java.lang.Object
- com.google.android.exoplayer2.Timeline.Period

Enclosing class:

Timeline
```
public static final class Timeline.Period
extends Object
```
Holds information about a period in a Timeline. A period defines a single logical piece of media, for example a media file. It may also define groups of ads inserted into the media, along with information about whether those ads have been loaded and played.
The figure below shows some of the information defined by a period, as well as how this information relates to a corresponding Timeline.Window in the timeline.

Field Summary

Fields
Modifier and Type	Field	Description
`long`	`durationUs`	The duration of this period in microseconds, or `C.TIME_UNSET` if unknown.
`Object`	`id`	An identifier for the period.
`Object`	`uid`	A unique identifier for the period.
`int`	`windowIndex`	The index of the window to which this period belongs.

Constructor Summary

Constructors
Constructor Description

Period()
Creates a new instance with no ad playback state.

Constructors
Constructor	Description
`Period()`	Creates a new instance with no ad playback state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`int`	`getAdCountInAdGroup(int adGroupIndex)`	Returns the number of ads in the ad group at index `adGroupIndex`, or `C.LENGTH_UNSET` if not yet known.
`long`	`getAdDurationUs(int adGroupIndex, int adIndexInAdGroup)`	Returns the duration of the ad at index `adIndexInAdGroup` in the ad group at `adGroupIndex`, in microseconds, or `C.TIME_UNSET` if not yet known.
`int`	`getAdGroupCount()`	Returns the number of ad groups in the period.
`int`	`getAdGroupIndexAfterPositionUs(long positionUs)`	Returns the index of the next ad group after `positionUs` in the period that has ads remaining to be played.
`int`	`getAdGroupIndexForPositionUs(long positionUs)`	Returns the index of the ad group at or before `positionUs` in the period, if that ad group is unplayed.
`long`	`getAdGroupTimeUs(int adGroupIndex)`	Returns the time of the ad group at index `adGroupIndex` in the period, in microseconds.
`long`	`getAdResumePositionUs()`	Returns the position offset in the first unplayed ad at which to begin playback, in microseconds.
`Object`	`getAdsId()`	Returns the opaque identifier for ads played with this period, or `null` if unset.
`long`	`getDurationMs()`	Returns the duration of the period in milliseconds, or `C.TIME_UNSET` if unknown.
`long`	`getDurationUs()`	Returns the duration of this period in microseconds, or `C.TIME_UNSET` if unknown.
`int`	`getFirstAdIndexToPlay(int adGroupIndex)`	Returns the index of the first ad in the specified ad group that should be played, or the number of ads in the ad group if no ads should be played.
`int`	`getNextAdIndexToPlay(int adGroupIndex, int lastPlayedAdIndex)`	Returns the index of the next ad in the specified ad group that should be played after playing `adIndexInAdGroup`, or the number of ads in the ad group if no later ads should be played.
`long`	`getPositionInWindowMs()`	Returns the position of the start of this period relative to the start of the window to which it belongs, in milliseconds.
`long`	`getPositionInWindowUs()`	Returns the position of the start of this period relative to the start of the window to which it belongs, in microseconds.
`int`	`hashCode()`
`boolean`	`hasPlayedAdGroup(int adGroupIndex)`	Returns whether the ad group at index `adGroupIndex` has been played.
`Timeline.Period`	`set(Object id, Object uid, int windowIndex, long durationUs, long positionInWindowUs)`	Sets the data held by this period.
`Timeline.Period`	`set(Object id, Object uid, int windowIndex, long durationUs, long positionInWindowUs, AdPlaybackState adPlaybackState)`	Sets the data held by this period.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
@Nullable
public Object id
```
    An identifier for the period. Not necessarily unique. May be null if the ids of the period are not required.
  - uid
```
@Nullable
public Object uid
```
    A unique identifier for the period. May be null if the ids of the period are not required.
  - windowIndex
```
public int windowIndex
```
    The index of the window to which this period belongs.
  - durationUs
```
public long durationUs
```
    The duration of this period in microseconds, or C.TIME_UNSET if unknown.
- Constructor Detail
  - Period
```
public Period()
```
    Creates a new instance with no ad playback state.
- Method Detail
  - set
```
public Timeline.Period set(@Nullable
                           Object id,
                           @Nullable
                           Object uid,
                           int windowIndex,
                           long durationUs,
                           long positionInWindowUs)
```
    Sets the data held by this period.
    
    Parameters:
    
    id - An identifier for the period. Not necessarily unique. May be null if the ids of the period are not required.
    
    uid - A unique identifier for the period. May be null if the ids of the period are not required.
    
    windowIndex - The index of the window to which this period belongs.
    
    durationUs - The duration of this period in microseconds, or C.TIME_UNSET if unknown.
    
    positionInWindowUs - The position of the start of this period relative to the start of the window to which it belongs, in milliseconds. May be negative if the start of the period is not within the window.
    
    Returns:
    
    This period, for convenience.
  - set
```
public Timeline.Period set(@Nullable
                           Object id,
                           @Nullable
                           Object uid,
                           int windowIndex,
                           long durationUs,
                           long positionInWindowUs,
                           AdPlaybackState adPlaybackState)
```
    Sets the data held by this period.
    
    Parameters:
    
    id - An identifier for the period. Not necessarily unique. May be null if the ids of the period are not required.
    
    uid - A unique identifier for the period. May be null if the ids of the period are not required.
    
    windowIndex - The index of the window to which this period belongs.
    
    durationUs - The duration of this period in microseconds, or C.TIME_UNSET if unknown.
    
    positionInWindowUs - The position of the start of this period relative to the start of the window to which it belongs, in milliseconds. May be negative if the start of the period is not within the window.
    
    adPlaybackState - The state of the period's ads, or AdPlaybackState.NONE if there are no ads.
    
    Returns:
    
    This period, for convenience.
  - getDurationMs
```
public long getDurationMs()
```
    Returns the duration of the period in milliseconds, or C.TIME_UNSET if unknown.
  - getDurationUs
```
public long getDurationUs()
```
    Returns the duration of this period in microseconds, or C.TIME_UNSET if unknown.
  - getPositionInWindowMs
```
public long getPositionInWindowMs()
```
    Returns the position of the start of this period relative to the start of the window to which it belongs, in milliseconds. May be negative if the start of the period is not within the window.
  - getPositionInWindowUs
```
public long getPositionInWindowUs()
```
    Returns the position of the start of this period relative to the start of the window to which it belongs, in microseconds. May be negative if the start of the period is not within the window.
  - getAdsId
```
@Nullable
public Object getAdsId()
```
    Returns the opaque identifier for ads played with this period, or null if unset.
  - getAdGroupCount
```
public int getAdGroupCount()
```
    Returns the number of ad groups in the period.
  - getAdGroupTimeUs
```
public long getAdGroupTimeUs(int adGroupIndex)
```
    Returns the time of the ad group at index adGroupIndex in the period, in microseconds.
    
    Parameters:
    
    adGroupIndex - The ad group index.
    
    Returns:
    
    The time of the ad group at the index relative to the start of the enclosing Timeline.Period, in microseconds, or C.TIME_END_OF_SOURCE for a post-roll ad group.
  - getFirstAdIndexToPlay
```
public int getFirstAdIndexToPlay(int adGroupIndex)
```
    Returns the index of the first ad in the specified ad group that should be played, or the number of ads in the ad group if no ads should be played.
    
    Parameters:
    
    adGroupIndex - The ad group index.
    
    Returns:
    
    The index of the first ad that should be played, or the number of ads in the ad group if no ads should be played.
  - getNextAdIndexToPlay
```
public int getNextAdIndexToPlay(int adGroupIndex,
                                int lastPlayedAdIndex)
```
    Returns the index of the next ad in the specified ad group that should be played after playing adIndexInAdGroup, or the number of ads in the ad group if no later ads should be played.
    
    Parameters:
    
    adGroupIndex - The ad group index.
    
    lastPlayedAdIndex - The last played ad index in the ad group.
    
    Returns:
    
    The index of the next ad that should be played, or the number of ads in the ad group if the ad group does not have any ads remaining to play.
  - hasPlayedAdGroup
```
public boolean hasPlayedAdGroup(int adGroupIndex)
```
    Returns whether the ad group at index adGroupIndex has been played.
    
    Parameters:
    
    adGroupIndex - The ad group index.
    
    Returns:
    
    Whether the ad group at index adGroupIndex has been played.
  - getAdGroupIndexForPositionUs
```
public int getAdGroupIndexForPositionUs(long positionUs)
```
    Returns the index of the ad group at or before positionUs in the period, if that ad group is unplayed. 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.
    
    Returns:
    
    The index of the ad group, or C.INDEX_UNSET.
  - getAdGroupIndexAfterPositionUs
```
public int getAdGroupIndexAfterPositionUs(long positionUs)
```
    Returns the index of the next ad group after positionUs in the period that has ads remaining to 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.
    
    Returns:
    
    The index of the ad group, or C.INDEX_UNSET.
  - getAdCountInAdGroup
```
public int getAdCountInAdGroup(int adGroupIndex)
```
    Returns the number of ads in the ad group at index adGroupIndex, or C.LENGTH_UNSET if not yet known.
    
    Parameters:
    
    adGroupIndex - The ad group index.
    
    Returns:
    
    The number of ads in the ad group, or C.LENGTH_UNSET if not yet known.
  - getAdDurationUs
```
public long getAdDurationUs(int adGroupIndex,
                            int adIndexInAdGroup)
```
    Returns the duration of the ad at index adIndexInAdGroup in the ad group at adGroupIndex, in microseconds, or C.TIME_UNSET if not yet known.
    
    Parameters:
    
    adGroupIndex - The ad group index.
    
    adIndexInAdGroup - The ad index in the ad group.
    
    Returns:
    
    The duration of the ad, or C.TIME_UNSET if not yet known.
  - getAdResumePositionUs
```
public long getAdResumePositionUs()
```
    Returns the position offset in the first unplayed ad at which to begin playback, in microseconds.
  - equals
```
public boolean equals(@Nullable
                      Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Timeline.Period

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

uid

windowIndex

durationUs

Constructor Detail

Period

Method Detail

set

set

getDurationMs

getDurationUs

getPositionInWindowMs

getPositionInWindowUs

getAdsId

getAdGroupCount

getAdGroupTimeUs

getFirstAdIndexToPlay

getNextAdIndexToPlay

hasPlayedAdGroup

getAdGroupIndexForPositionUs

getAdGroupIndexAfterPositionUs

getAdCountInAdGroup

getAdDurationUs

getAdResumePositionUs

equals

hashCode