Timeline.Window

Kotlin |Java

public final class Timeline.Window

Holds information about a window in a Timeline. A window usually corresponds to one playlist item and defines a region of media currently available for playback along with additional information such as whether seeking is supported within the window. The figure below shows some of the information defined by a window, as well as how this information relates to corresponding Periods in the timeline.

Information defined by a timeline window

Summary

Constants
`static final Object`	`SINGLE_WINDOW_UID` A `uid` for a window that must be used for single-window `Timelines`.

Public fields
`long`	`@UnstableApi defaultPositionUs` The default position relative to the start of the window at which to begin playback, in microseconds.
`long`	`@UnstableApi durationUs` The duration of this window in microseconds, or `TIME_UNSET` if unknown.
`long`	`elapsedRealtimeEpochOffsetMs` The offset between `elapsedRealtime` and the time since the Unix epoch according to the clock of the media origin server, or `TIME_UNSET` if unknown or not applicable.
`int`	`firstPeriodIndex` The index of the first period that belongs to this window.
`boolean`	`isDynamic` Whether this window may change when the timeline is updated.
`boolean`	`isPlaceholder` Whether this window contains placeholder information because the real information has yet to be loaded.
`boolean`	`isSeekable` Whether it's possible to seek within this window.
`int`	`lastPeriodIndex` The index of the last period that belongs to this window.
`@Nullable MediaItem.LiveConfiguration`	`liveConfiguration` The `MediaItem.LiveConfiguration` that is used or null if `isLive` returns false.
`@Nullable Object`	`manifest` The manifest of the window.
`MediaItem`	`mediaItem` The `MediaItem` associated to the window.
`long`	`@UnstableApi positionInFirstPeriodUs` The position of the start of this window relative to the start of the first period belonging to it, in microseconds.
`long`	`presentationStartTimeMs` The start time of the presentation to which this window belongs in milliseconds since the Unix epoch, or `TIME_UNSET` if unknown or not applicable.
`@Nullable Object`	`@UnstableApi tag` This field is deprecated. Use `mediaItem` instead.
`Object`	`uid` A unique identifier for the window.
`long`	`windowStartTimeMs` The window's start time in milliseconds since the Unix epoch, or `TIME_UNSET` if unknown or not applicable.

Public constructors
`Window()` Creates window.

Public methods
`boolean`	`equals(@Nullable Object obj)`
`static Timeline.Window`	`@UnstableApi fromBundle(Bundle bundle)` Restores a `Window` from a `Bundle`.
`long`	`getCurrentUnixTimeMs()` Returns the current time in milliseconds since the Unix epoch.
`long`	`getDefaultPositionMs()` Returns the default position relative to the start of the window at which to begin playback, in milliseconds.
`long`	`getDefaultPositionUs()` Returns the default position relative to the start of the window at which to begin playback, in microseconds.
`long`	`getDurationMs()` Returns the duration of the window in milliseconds, or `TIME_UNSET` if unknown.
`long`	`getDurationUs()` Returns the duration of this window in microseconds, or `TIME_UNSET` if unknown.
`long`	`getPositionInFirstPeriodMs()` Returns the position of the start of this window relative to the start of the first period belonging to it, in milliseconds.
`long`	`getPositionInFirstPeriodUs()` Returns the position of the start of this window relative to the start of the first period belonging to it, in microseconds.
`int`	`hashCode()`
`boolean`	`isLive()` Returns whether this is a live stream.
`Timeline.Window`	@CanIgnoreReturnValue @UnstableApi set( Object uid, @Nullable MediaItem mediaItem, @Nullable Object manifest, long presentationStartTimeMs, long windowStartTimeMs, long elapsedRealtimeEpochOffsetMs, boolean isSeekable, boolean isDynamic, @Nullable MediaItem.LiveConfiguration liveConfiguration, long defaultPositionUs, long durationUs, int firstPeriodIndex, int lastPeriodIndex, long positionInFirstPeriodUs ) Sets the data held by this window.
`Bundle`	`@UnstableApi toBundle()` Returns a `Bundle` representing the information stored in this object.

Constants

SINGLE_WINDOW_UID

public static final Object SINGLE_WINDOW_UID

A uid for a window that must be used for single-window Timelines.

Public fields

defaultPositionUs

@UnstableApi
public long defaultPositionUs

The default position relative to the start of the window at which to begin playback, in microseconds. May be TIME_UNSET if and only if the window was populated with a non-zero default position projection, and if the specified projection cannot be performed whilst remaining within the bounds of the window.

durationUs

@UnstableApi
public long durationUs

The duration of this window in microseconds, or TIME_UNSET if unknown.

elapsedRealtimeEpochOffsetMs

public long elapsedRealtimeEpochOffsetMs

The offset between elapsedRealtime and the time since the Unix epoch according to the clock of the media origin server, or TIME_UNSET if unknown or not applicable.

Note that the current Unix time can be retrieved using getCurrentUnixTimeMs and is calculated as SystemClock.elapsedRealtime() + elapsedRealtimeEpochOffsetMs.

firstPeriodIndex

public int firstPeriodIndex

The index of the first period that belongs to this window.

isDynamic

public boolean isDynamic

Whether this window may change when the timeline is updated.

isPlaceholder

public boolean isPlaceholder

Whether this window contains placeholder information because the real information has yet to be loaded.

isSeekable

public boolean isSeekable

Whether it's possible to seek within this window.

lastPeriodIndex

public int lastPeriodIndex

The index of the last period that belongs to this window.

liveConfiguration

public @Nullable MediaItem.LiveConfiguration liveConfiguration

The MediaItem.LiveConfiguration that is used or null if isLive returns false.

manifest

public @Nullable Object manifest

The manifest of the window. May be null.

mediaItem

public MediaItem mediaItem

The MediaItem associated to the window. Not necessarily unique.

positionInFirstPeriodUs

@UnstableApi
public long positionInFirstPeriodUs

The position of the start of this window relative to the start of the first period belonging to it, in microseconds.

presentationStartTimeMs

public long presentationStartTimeMs

The start time of the presentation to which this window belongs in milliseconds since the Unix epoch, or TIME_UNSET if unknown or not applicable. For informational purposes only.

tag

@UnstableApi
public @Nullable Object tag

uid

public Object uid

A unique identifier for the window. Single-window Timelines must use SINGLE_WINDOW_UID.

windowStartTimeMs

public long windowStartTimeMs

The window's start time in milliseconds since the Unix epoch, or TIME_UNSET if unknown or not applicable.

Public constructors

Window

public Window()

Creates window.

Public methods

equals

public boolean equals(@Nullable Object obj)

fromBundle

@UnstableApi
public static Timeline.Window fromBundle(Bundle bundle)

Restores a Window from a Bundle.

getCurrentUnixTimeMs

public long getCurrentUnixTimeMs()

Returns the current time in milliseconds since the Unix epoch.

This method applies known corrections made available by the media such that this time corresponds to the clock of the media origin server.

getDefaultPositionMs

public long getDefaultPositionMs()

Returns the default position relative to the start of the window at which to begin playback, in milliseconds. May be TIME_UNSET if and only if the window was populated with a non-zero default position projection, and if the specified projection cannot be performed whilst remaining within the bounds of the window.

getDefaultPositionUs

public long getDefaultPositionUs()

Returns the default position relative to the start of the window at which to begin playback, in microseconds. May be TIME_UNSET if and only if the window was populated with a non-zero default position projection, and if the specified projection cannot be performed whilst remaining within the bounds of the window.

getDurationMs

public long getDurationMs()

Returns the duration of the window in milliseconds, or TIME_UNSET if unknown.

getDurationUs

public long getDurationUs()

Returns the duration of this window in microseconds, or TIME_UNSET if unknown.

getPositionInFirstPeriodMs

public long getPositionInFirstPeriodMs()

Returns the position of the start of this window relative to the start of the first period belonging to it, in milliseconds.

getPositionInFirstPeriodUs

public long getPositionInFirstPeriodUs()

Returns the position of the start of this window relative to the start of the first period belonging to it, in microseconds.

hashCode

public int hashCode()

isLive

public boolean isLive()

Returns whether this is a live stream.

set

@CanIgnoreReturnValue
@UnstableApi
public Timeline.Window set(
    Object uid,
    @Nullable MediaItem mediaItem,
    @Nullable Object manifest,
    long presentationStartTimeMs,
    long windowStartTimeMs,
    long elapsedRealtimeEpochOffsetMs,
    boolean isSeekable,
    boolean isDynamic,
    @Nullable MediaItem.LiveConfiguration liveConfiguration,
    long defaultPositionUs,
    long durationUs,
    int firstPeriodIndex,
    int lastPeriodIndex,
    long positionInFirstPeriodUs
)

Sets the data held by this window.

toBundle

@UnstableApi
public Bundle toBundle()

Returns a Bundle representing the information stored in this object.

It omits the uid and manifest fields. The uid of an instance restored by fromBundle will be a fake Object and the manifest of the instance will be null.