com.google.android.exoplayer2.source

Class MediaSource.MediaPeriodId

java.lang.Object

com.google.android.exoplayer2.source.MediaSource.MediaPeriodId

Enclosing interface:

MediaSource

public static final class MediaSource.MediaPeriodId
extends java.lang.Object

Identifier for a MediaPeriod.

Field Summary

Fields

Modifier and Type	Field and Description
int	adGroupIndex If the media period is in an ad group, the index of the ad group in the period.
int	adIndexInAdGroup If the media period is in an ad group, the index of the ad in its ad group in the period.
long	endPositionUs The end position of the media to play within the media period, in microseconds, or C.TIME_END_OF_SOURCE if the end position is the end of the media period.
java.lang.Object	periodUid The unique id of the timeline period.
long	windowSequenceNumber The sequence number of the window in the buffered sequence of windows this media period is part of.

Constructor Summary

Constructors

Constructor and Description
MediaPeriodId(java.lang.Object periodUid) Creates a media period identifier for a dummy period which is not part of a buffered sequence of windows.
MediaPeriodId(java.lang.Object periodUid, int adGroupIndex, int adIndexInAdGroup, long windowSequenceNumber) Creates a media period identifier that identifies an ad within an ad group at the specified timeline period.
MediaPeriodId(java.lang.Object periodUid, long windowSequenceNumber) Creates a media period identifier for the specified period in the timeline.
MediaPeriodId(java.lang.Object periodUid, long windowSequenceNumber, long endPositionUs) Creates a media period identifier for the specified clipped period in the timeline.

Method Summary

Modifier and Type	Method and Description
MediaSource.MediaPeriodId	copyWithPeriodUid(java.lang.Object newPeriodUid) Returns a copy of this period identifier but with newPeriodUid as its period uid.
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isAd() Returns whether this period identifier identifies an ad in an ad group in a period.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

periodUid

public final java.lang.Object periodUid

The unique id of the timeline period.

adGroupIndex

public final int adGroupIndex

If the media period is in an ad group, the index of the ad group in the period. C.INDEX_UNSET otherwise.

adIndexInAdGroup

public final int adIndexInAdGroup

If the media period is in an ad group, the index of the ad in its ad group in the period. C.INDEX_UNSET otherwise.

windowSequenceNumber

public final long windowSequenceNumber

The sequence number of the window in the buffered sequence of windows this media period is part of. C.INDEX_UNSET if the media period id is not part of a buffered sequence of windows.

endPositionUs

public final long endPositionUs

The end position of the media to play within the media period, in microseconds, or C.TIME_END_OF_SOURCE if the end position is the end of the media period.

Note that this only applies if the media period is for content (i.e., not for an ad) and is clipped to the position of the next ad group.

Constructor Detail

MediaPeriodId

public MediaPeriodId(java.lang.Object periodUid)

Creates a media period identifier for a dummy period which is not part of a buffered sequence of windows.

Parameters:

periodUid - The unique id of the timeline period.

MediaPeriodId

public MediaPeriodId(java.lang.Object periodUid,
                     long windowSequenceNumber)

Creates a media period identifier for the specified period in the timeline.

Parameters:

periodUid - The unique id of the timeline period.

windowSequenceNumber - The sequence number of the window in the buffered sequence of windows this media period is part of.

MediaPeriodId

public MediaPeriodId(java.lang.Object periodUid,
                     long windowSequenceNumber,
                     long endPositionUs)

Creates a media period identifier for the specified clipped period in the timeline.

Parameters:

periodUid - The unique id of the timeline period.

windowSequenceNumber - The sequence number of the window in the buffered sequence of windows this media period is part of.

endPositionUs - The end position of the media period within the timeline period, in microseconds.

MediaPeriodId

public MediaPeriodId(java.lang.Object periodUid,
                     int adGroupIndex,
                     int adIndexInAdGroup,
                     long windowSequenceNumber)

Creates a media period identifier that identifies an ad within an ad group at the specified timeline period.

Parameters:

periodUid - The unique id of the timeline period that contains the ad group.

adGroupIndex - The index of the ad group.

adIndexInAdGroup - The index of the ad in the ad group.

windowSequenceNumber - The sequence number of the window in the buffered sequence of windows this media period is part of.

Method Detail

copyWithPeriodUid

public MediaSource.MediaPeriodId copyWithPeriodUid(java.lang.Object newPeriodUid)

Returns a copy of this period identifier but with newPeriodUid as its period uid.

isAd

public boolean isAd()

Returns whether this period identifier identifies an ad in an ad group in a period.

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object