# ForwardingTimeline

Artifact: [androidx.media3:media3-exoplayer](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/exoplayer/source/ForwardingTimeline.java+class:androidx.media3.exoplayer.source.ForwardingTimeline)

*** ** * ** ***


```
@UnstableApi
abstract class ForwardingTimeline : Timeline
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.media3.common.Timeline](https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline) ||
|   | ↳ | [androidx.media3.exoplayer.source.ForwardingTimeline](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline) |

Known direct subclasses [AdTimeline](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ads/AdTimeline), [FakeMediaSource.InitialTimeline](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeMediaSource.InitialTimeline), [TimelineWithUpdatedMediaItem](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/TimelineWithUpdatedMediaItem)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ads/AdTimeline` | A custom `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline` for sources that have `https://developer.android.com/reference/kotlin/androidx/media3/common/AdPlaybackState` split among multiple periods. |
| `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeMediaSource.InitialTimeline` | A forwarding timeline to provide an initial timeline for fake multi window sources. |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/TimelineWithUpdatedMediaItem` | A `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline` that overrides the `https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem`. |

*** ** * ** ***

An overridable `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline` implementation forwarding methods to another timeline.

The following methods call through to `super` instead of the `timeline` delegate:

- `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getPeriodByUid(java.lang.Object,androidx.media3.common.Timeline.Period)`
- `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#equals(java.lang.Object)`
- `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#hashCode()`

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#ForwardingTimeline(androidx.media3.common.Timeline)(timeline: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline!)` |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#equals(java.lang.Object)(obj: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getFirstWindowIndex(boolean)(shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Returns the index of the first window in the playback order depending on whether shuffling is enabled. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getIndexOfPeriod(java.lang.Object)(uid: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!)` Returns the index of the period identified by its unique `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period#uid()`, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if the period is not in the timeline. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getLastWindowIndex(boolean)(shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Returns the index of the last window in the playback order depending on whether shuffling is enabled. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getNextWindowIndex(int,int,boolean)( windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, @https://developer.android.com/reference/kotlin/androidx/media3/common/Player.RepeatMode repeatMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Returns the index of the window after the window at index `windowIndex` depending on the `repeatMode` and whether shuffling is enabled. |
| `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getPeriod(int,androidx.media3.common.Timeline.Period,boolean)(periodIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!, setIds: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` with data for the period at the specified index. |
| `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getPeriodByUid(java.lang.Object,androidx.media3.common.Timeline.Period)(periodUid: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!, period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!)` Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` with data for the period with the specified unique identifier. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getPeriodCount()()` Returns the number of periods in the timeline. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getPreviousWindowIndex(int,int,boolean)( windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, @https://developer.android.com/reference/kotlin/androidx/media3/common/Player.RepeatMode repeatMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Returns the index of the window before the window at index `windowIndex` depending on the `repeatMode` and whether shuffling is enabled. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getUidOfPeriod(int)(periodIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns the unique id of the period identified by its index in the timeline. |
| `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getWindow(int,androidx.media3.common.Timeline.Window,long)( windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!, defaultPositionProjectionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html )` Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window` with data for the window at the specified index. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#getWindowCount()()` Returns the number of windows in the timeline. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#hashCode()()` |

| ### Protected properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/ForwardingTimeline#timeline()` |

### Inherited Constants

From [androidx.media3.common.Timeline](https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline) `const https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline!` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#EMPTY()`

An empty timeline.

### Inherited functions

From [androidx.media3.common.Timeline](https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline) `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#copyWithSingleWindow(int)(windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Returns a copy of this timeline containing just the single specified `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window`.
`java-static https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
[fromBundle](https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#fromBundle(android.os.Bundle))(bundle: https://developer.android.com/reference/android/os/Bundle.html!)`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#fromBundle(android.os.Bundle,int)` instead.

<br />

`java-static https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#fromBundle(android.os.Bundle,int)(bundle: https://developer.android.com/reference/android/os/Bundle.html!, interfaceVersion: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Restores a `Timeline` from a `https://developer.android.com/reference/android/os/Bundle.html`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getNextPeriodIndex(int,androidx.media3.common.Timeline.Period,androidx.media3.common.Timeline.Window,int,boolean)(
periodIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!,
window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!,
@https://developer.android.com/reference/kotlin/androidx/media3/common/Player.RepeatMode repeatMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html
)`

Returns the index of the period after the period at index `periodIndex` depending on the `repeatMode` and whether shuffling is enabled.
`https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriod(int,androidx.media3.common.Timeline.Period)(periodIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!)`

Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` with data for the period at the specified index.
`https://developer.android.com/reference/android/util/Pair.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html!>!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
@https://checkerframework.org/api/com/google/errorprone/annotations/InlineMe.html(replacement = "this.getPeriodPositionUs(window, period, windowIndex, windowPositionUs)")
[getPeriodPosition](https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriodPosition(androidx.media3.common.Timeline.Window,androidx.media3.common.Timeline.Period,int,long))(
window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!,
period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!,
windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
windowPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html
)`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriodPositionUs(androidx.media3.common.Timeline.Window,androidx.media3.common.Timeline.Period,int,long)` instead.

<br />

`https://developer.android.com/reference/android/util/Pair.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html!>?` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
@https://checkerframework.org/api/com/google/errorprone/annotations/InlineMe.html(replacement = "this.getPeriodPositionUs("
+ "window, period, windowIndex, windowPositionUs, defaultPositionProjectionUs)")
[getPeriodPosition](https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriodPosition(androidx.media3.common.Timeline.Window,androidx.media3.common.Timeline.Period,int,long,long))(
window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!,
period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!,
windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
windowPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html,
defaultPositionProjectionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html
)`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriodPositionUs(androidx.media3.common.Timeline.Window,androidx.media3.common.Timeline.Period,int,long,long)` instead.

<br />

`https://developer.android.com/reference/android/util/Pair.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html!>!` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriodPositionUs(androidx.media3.common.Timeline.Window,androidx.media3.common.Timeline.Period,int,long)(
window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!,
period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!,
windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
windowPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html
)`

Calls `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriodPositionUs(androidx.media3.common.Timeline.Window,androidx.media3.common.Timeline.Period,int,long)` with a zero default position projection.
`https://developer.android.com/reference/android/util/Pair.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html!>?` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getPeriodPositionUs(androidx.media3.common.Timeline.Window,androidx.media3.common.Timeline.Period,int,long,long)(
window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!,
period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!,
windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
windowPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html,
defaultPositionProjectionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html
)`

Converts `(windowIndex, windowPositionUs)` to the corresponding `(periodUid,
periodPositionUs)`.
`https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#getWindow(int,androidx.media3.common.Timeline.Window)(windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!)`

Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window` with data for the window at the specified index.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#isEmpty()()`

Returns whether the timeline is empty.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#isLastPeriod(int,androidx.media3.common.Timeline.Period,androidx.media3.common.Timeline.Window,int,boolean)(
periodIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!,
window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!,
@https://developer.android.com/reference/kotlin/androidx/media3/common/Player.RepeatMode repeatMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html,
shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html
)`

Returns whether the given period is the last period of the timeline depending on the `
repeatMode` and whether shuffling is enabled.
`https://developer.android.com/reference/android/os/Bundle.html!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
[toBundle](https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#toBundle())()`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#toBundle(int)` instead.

<br />

`https://developer.android.com/reference/android/os/Bundle.html!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline#toBundle(int)(interfaceVersion: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Returns a `https://developer.android.com/reference/android/os/Bundle.html` representing the information stored in this object.

## Public constructors

### ForwardingTimeline

```
ForwardingTimeline(timeline: Timeline!)
```

## Public functions

### equals

```
fun equals(obj: Any?): Boolean
```

### getFirstWindowIndex

```
fun getFirstWindowIndex(shuffleModeEnabled: Boolean): Int
```

Returns the index of the first window in the playback order depending on whether shuffling is enabled.

| Parameters |
|---|---|
| `shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether shuffling is enabled. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the first window in the playback order, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if the timeline is empty. |

### getIndexOfPeriod

```
fun getIndexOfPeriod(uid: Any!): Int
```

Returns the index of the period identified by its unique `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period#uid()`, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if the period is not in the timeline.

| Parameters |
|---|---|
| `uid: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!` | A unique identifier for a period. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the period, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if the period was not found. |

### getLastWindowIndex

```
fun getLastWindowIndex(shuffleModeEnabled: Boolean): Int
```

Returns the index of the last window in the playback order depending on whether shuffling is enabled.

| Parameters |
|---|---|
| `shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether shuffling is enabled. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the last window in the playback order, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if the timeline is empty. |

### getNextWindowIndex

```
fun getNextWindowIndex(
    windowIndex: Int,
    @Player.RepeatMode repeatMode: Int,
    shuffleModeEnabled: Boolean
): Int
```

Returns the index of the window after the window at index `windowIndex` depending on the `repeatMode` and whether shuffling is enabled.

| Parameters |
|---|---|
| `windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Index of a window in the timeline. |
| `@https://developer.android.com/reference/kotlin/androidx/media3/common/Player.RepeatMode repeatMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | A repeat mode. |
| `shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether shuffling is enabled. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the next window, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if this is the last window. |

### getPeriod

```
fun getPeriod(periodIndex: Int, period: Timeline.Period!, setIds: Boolean): Timeline.Period!
```

Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` with data for the period at the specified index.

| Parameters |
|---|---|
| `periodIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the period. |
| `period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!` | The `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` to populate. Must not be null. |
| `setIds: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period#id()` and `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period#uid()` should be populated. If false, the fields will be set to null. The caller should pass false for efficiency reasons unless the fields are required. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!` | The populated `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period`, for convenience. |

### getPeriodByUid

```
fun getPeriodByUid(periodUid: Any!, period: Timeline.Period!): Timeline.Period!
```

Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` with data for the period with the specified unique identifier.

| Parameters |
|---|---|
| `periodUid: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!` | The unique identifier of the period. |
| `period: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!` | The `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` to populate. Must not be null. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period!` | The populated `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period`, for convenience. |

### getPeriodCount

```
fun getPeriodCount(): Int
```

Returns the number of periods in the timeline.

### getPreviousWindowIndex

```
fun getPreviousWindowIndex(
    windowIndex: Int,
    @Player.RepeatMode repeatMode: Int,
    shuffleModeEnabled: Boolean
): Int
```

Returns the index of the window before the window at index `windowIndex` depending on the `repeatMode` and whether shuffling is enabled.

| Parameters |
|---|---|
| `windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Index of a window in the timeline. |
| `@https://developer.android.com/reference/kotlin/androidx/media3/common/Player.RepeatMode repeatMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | A repeat mode. |
| `shuffleModeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether shuffling is enabled. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the previous window, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if this is the first window. |

### getUidOfPeriod

```
fun getUidOfPeriod(periodIndex: Int): Any!
```

Returns the unique id of the period identified by its index in the timeline.

| Parameters |
|---|---|
| `periodIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the period. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!` | The unique id of the period. |

### getWindow

```
fun getWindow(
    windowIndex: Int,
    window: Timeline.Window!,
    defaultPositionProjectionUs: Long
): Timeline.Window!
```

Populates a `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window` with data for the window at the specified index.

| Parameters |
|---|---|
| `windowIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the window. |
| `window: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!` | The `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window` to populate. Must not be null. |
| `defaultPositionProjectionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | A duration into the future that the populated window's default start position should be projected. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window!` | The populated `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Window`, for convenience. |

### getWindowCount

```
fun getWindowCount(): Int
```

Returns the number of windows in the timeline.

### hashCode

```
fun hashCode(): Int
```

## Protected properties

### timeline

```
protected val timeline: Timeline!
```