MaskingMediaSource.PlaceholderTimeline

Artifact: androidx.media3:media3-exoplayer

View Source

---

Kotlin |Java

@VisibleForTesting
class MaskingMediaSource.PlaceholderTimeline : Timeline

kotlin.Any
↳	androidx.media3.common.Timeline
	↳	androidx.media3.exoplayer.source.MaskingMediaSource.PlaceholderTimeline

---

A timeline with one dynamic window with a period of indeterminate duration.

Summary

Public constructors
PlaceholderTimeline(mediaItem: MediaItem!) Creates a new instance with the given media item.

Public functions
Int	getIndexOfPeriod(uid: Any!) Returns the index of the period identified by its unique uid, or INDEX_UNSET if the period is not in the timeline.
Timeline.Period!	getPeriod(periodIndex: Int, period: Timeline.Period!, setIds: Boolean) Populates a Period with data for the period at the specified index.
Int	getPeriodCount() Returns the number of periods in the timeline.
Any!	getUidOfPeriod(periodIndex: Int) Returns the unique id of the period identified by its index in the timeline.
Timeline.Window!	getWindow(     windowIndex: Int,     window: Timeline.Window!,     defaultPositionProjectionUs: Long ) Populates a Window with data for the window at the specified index.
Int	getWindowCount() Returns the number of windows in the timeline.

Inherited Constants
From androidx.media3.common.Timeline const Timeline! EMPTY An empty timeline.

Inherited functions

From androidx.media3.common.Timeline Timeline! @UnstableApi copyWithSingleWindow(windowIndex: Int) Returns a copy of this timeline containing just the single specified Window. Boolean equals(obj: Any?) java-static Timeline! @UnstableApi fromBundle(bundle: Bundle!) Restores a Timeline from a Bundle. Int getFirstWindowIndex(shuffleModeEnabled: Boolean) Returns the index of the first window in the playback order depending on whether shuffling is enabled. Int getLastWindowIndex(shuffleModeEnabled: Boolean) Returns the index of the last window in the playback order depending on whether shuffling is enabled. Int getNextPeriodIndex(     periodIndex: Int,     period: Timeline.Period!,     window: Timeline.Window!,     @Player.RepeatMode repeatMode: Int,     shuffleModeEnabled: Boolean ) Returns the index of the period after the period at index periodIndex depending on the repeatMode and whether shuffling is enabled. Int getNextWindowIndex(     windowIndex: Int,     @Player.RepeatMode repeatMode: Int,     shuffleModeEnabled: Boolean ) Returns the index of the window after the window at index windowIndex depending on the repeatMode and whether shuffling is enabled. Timeline.Period! getPeriod(periodIndex: Int, period: Timeline.Period!) Populates a Period with data for the period at the specified index. Timeline.Period! getPeriodByUid(periodUid: Any!, period: Timeline.Period!) Populates a Period with data for the period with the specified unique identifier. Pair<Any!, Long!>! @UnstableApi @InlineMe(replacement = "this.getPeriodPositionUs(window, period, windowIndex, windowPositionUs)") getPeriodPosition(     window: Timeline.Window!,     period: Timeline.Period!,     windowIndex: Int,     windowPositionUs: Long ) This function is deprecated. Use getPeriodPositionUs instead. Pair<Any!, Long!>? @UnstableApi @InlineMe(replacement = "this.getPeriodPositionUs(" + "window, period, windowIndex, windowPositionUs, defaultPositionProjectionUs)") getPeriodPosition(     window: Timeline.Window!,     period: Timeline.Period!,     windowIndex: Int,     windowPositionUs: Long,     defaultPositionProjectionUs: Long ) This function is deprecated. Use getPeriodPositionUs instead. Pair<Any!, Long!>! getPeriodPositionUs(     window: Timeline.Window!,     period: Timeline.Period!,     windowIndex: Int,     windowPositionUs: Long ) Calls getPeriodPositionUs with a zero default position projection. Pair<Any!, Long!>? getPeriodPositionUs(     window: Timeline.Window!,     period: Timeline.Period!,     windowIndex: Int,     windowPositionUs: Long,     defaultPositionProjectionUs: Long ) Converts (windowIndex, windowPositionUs) to the corresponding (periodUid, periodPositionUs). Int getPreviousWindowIndex(     windowIndex: Int,     @Player.RepeatMode repeatMode: Int,     shuffleModeEnabled: Boolean ) Returns the index of the window before the window at index windowIndex depending on the repeatMode and whether shuffling is enabled. Timeline.Window! getWindow(windowIndex: Int, window: Timeline.Window!) Populates a Window with data for the window at the specified index. Int hashCode() Boolean isEmpty() Returns whether the timeline is empty. Boolean isLastPeriod(     periodIndex: Int,     period: Timeline.Period!,     window: Timeline.Window!,     @Player.RepeatMode repeatMode: Int,     shuffleModeEnabled: Boolean ) Returns whether the given period is the last period of the timeline depending on the repeatMode and whether shuffling is enabled. Bundle! @UnstableApi toBundle() Returns a Bundle representing the information stored in this object.

Public constructors

PlaceholderTimeline

PlaceholderTimeline(mediaItem: MediaItem!)

Creates a new instance with the given media item.

Public functions

getIndexOfPeriod

fun getIndexOfPeriod(uid: Any!): Int

Returns the index of the period identified by its unique uid, or INDEX_UNSET if the period is not in the timeline.

Parameters
uid: Any!	A unique identifier for a period.

Returns
Int	The index of the period, or INDEX_UNSET if the period was not found.

getPeriod

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

Populates a Period with data for the period at the specified index.

Parameters
periodIndex: Int	The index of the period.
period: Timeline.Period!	The Period to populate. Must not be null.
setIds: Boolean	Whether id and 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
Timeline.Period!	The populated Period, for convenience.

getPeriodCount

fun getPeriodCount(): Int

Returns the number of periods in the timeline.

getUidOfPeriod

fun getUidOfPeriod(periodIndex: Int): Any!

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

Parameters
periodIndex: Int	The index of the period.

Returns
Any!	The unique id of the period.

getWindow

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

Populates a Window with data for the window at the specified index.

Parameters
windowIndex: Int	The index of the window.
window: Timeline.Window!	The Window to populate. Must not be null.
defaultPositionProjectionUs: Long	A duration into the future that the populated window's default start position should be projected.

Returns
Timeline.Window!	The populated Window, for convenience.

getWindowCount

fun getWindowCount(): Int

Returns the number of windows in the timeline.