HlsMediaPlaylist

Artifact: androidx.media3:media3-exoplayer-hls

Kotlin |Java

@UnstableApi
public final class HlsMediaPlaylist extends HlsPlaylist

java.lang.Object
↳	androidx.media3.exoplayer.hls.playlist.HlsPlaylist
	↳	androidx.media3.exoplayer.hls.playlist.HlsMediaPlaylist

Represents an HLS media playlist.

Summary

Nested types
`public class HlsMediaPlaylist.ClientDefinedAttribute` A client defined attribute.
`@Retention(value = RetentionPolicy.SOURCE) @IntDef(value = ) @Documented @Target(value = ElementType.TYPE_USE) public annotation HlsMediaPlaylist.ClientDefinedAttribute.Type` The type of the client defined attribute.
`public final class HlsMediaPlaylist.Interstitial` An interstitial data range.
`public final class HlsMediaPlaylist.Interstitial.Builder` Builder for `Interstitial`.
`@Retention(value = RetentionPolicy.SOURCE) @StringDef(value = ) @Documented @Target(value = ElementType.TYPE_USE) public annotation HlsMediaPlaylist.Interstitial.CueTriggerType` The cue trigger type.
`@Retention(value = RetentionPolicy.SOURCE) @StringDef(value = ) @Documented @Target(value = ElementType.TYPE_USE) public annotation HlsMediaPlaylist.Interstitial.NavigationRestriction` The navigation restriction identifier.
`@Retention(value = RetentionPolicy.SOURCE) @StringDef(value = ) @Documented @Target(value = ElementType.TYPE_USE) public annotation HlsMediaPlaylist.Interstitial.SnapType` The snap identifier.
`@Retention(value = RetentionPolicy.SOURCE) @StringDef(value = ) @Documented @Target(value = ElementType.TYPE_USE) public annotation HlsMediaPlaylist.Interstitial.TimelineOccupiesType` The timeline occupies identifier.
`@Retention(value = RetentionPolicy.SOURCE) @StringDef(value = ) @Documented @Target(value = ElementType.TYPE_USE) public annotation HlsMediaPlaylist.Interstitial.TimelineStyleType` The timeline style identifier.
`public final class HlsMediaPlaylist.Part extends HlsMediaPlaylist.SegmentBase` A media part.
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ElementType.TYPE_USE) @IntDef(value = ) public annotation HlsMediaPlaylist.PlaylistType` Type of the playlist, as defined by #EXT-X-PLAYLIST-TYPE.
`public final class HlsMediaPlaylist.RenditionReport` A rendition report for an alternative rendition defined in another media playlist.
`public final class HlsMediaPlaylist.Segment extends HlsMediaPlaylist.SegmentBase` Media segment reference.
`public class HlsMediaPlaylist.SegmentBase implements Comparable` The base for a `Segment` or a `Part` required for playback.
`public final class HlsMediaPlaylist.ServerControl` Server control attributes.

Constants
`static final int`	`PLAYLIST_TYPE_EVENT = 2`
`static final int`	`PLAYLIST_TYPE_UNKNOWN = 0`
`static final int`	`PLAYLIST_TYPE_VOD = 1`

Public fields
`final int`	`discontinuitySequence` The discontinuity sequence number of the first media segment in the playlist, as defined by #EXT-X-DISCONTINUITY-SEQUENCE.
`final long`	`durationUs` The total duration of the playlist in microseconds.
`final boolean`	`hasDiscontinuitySequence` Whether the playlist contains the #EXT-X-DISCONTINUITY-SEQUENCE tag.
`final boolean`	`hasEndTag` Whether the playlist contains the #EXT-X-ENDLIST tag.
`final boolean`	`hasPositiveStartOffset` Whether the `startOffsetUs` was explicitly defined by #EXT-X-START as a positive value or zero.
`final boolean`	`hasProgramDateTime` Whether the playlist contains a #EXT-X-PROGRAM-DATE-TIME tag.
`final ImmutableList<HlsMediaPlaylist.Interstitial>`	`interstitials` The interstitials declared as `#EXT-X-DATERANGE` with `CLASS="com.apple.hls.interstitial"`
`final long`	`mediaSequence` The media sequence number of the first media segment in the playlist, as defined by #EXT-X-MEDIA-SEQUENCE.
`final long`	`partTargetDurationUs` The target duration for segment parts, as defined by #EXT-X-PART-INF, or `TIME_UNSET` if undefined.
`final int`	`@HlsMediaPlaylist.PlaylistType playlistType` The type of the playlist.
`final boolean`	`preciseStart` Whether the start position should be precise, as defined by #EXT-X-START.
`final @Nullable DrmInitData`	`protectionSchemes` Contains the CDM protection schemes used by segments in this playlist.
`final Map<Uri, HlsMediaPlaylist.RenditionReport>`	`renditionReports` The rendition reports of alternative rendition playlists.
`final List<HlsMediaPlaylist.Segment>`	`segments` The list of segments in the playlist.
`final HlsMediaPlaylist.ServerControl`	`serverControl` The attributes of the #EXT-X-SERVER-CONTROL header.
`final long`	`startOffsetUs` The start offset in microseconds from the beginning of the playlist, as defined by #EXT-X-START, or `TIME_UNSET` if undefined.
`final long`	`startTimeUs` If `hasProgramDateTime` is true, contains the datetime as microseconds since epoch.
`final long`	`targetDurationUs` The target duration in microseconds, as defined by #EXT-X-TARGETDURATION.
`final List<HlsMediaPlaylist.Part>`	`trailingParts` The list of parts at the end of the playlist for which the segment is not in the playlist yet.
`final int`	`version` The compatibility version, as defined by #EXT-X-VERSION.

Public constructors
HlsMediaPlaylist( @HlsMediaPlaylist.PlaylistType int playlistType, String baseUri, List<String> tags, long startOffsetUs, boolean preciseStart, long startTimeUs, boolean hasDiscontinuitySequence, int discontinuitySequence, long mediaSequence, int version, long targetDurationUs, long partTargetDurationUs, boolean hasIndependentSegments, boolean hasEndTag, boolean hasProgramDateTime, @Nullable DrmInitData protectionSchemes, List<HlsMediaPlaylist.Segment> segments, List<HlsMediaPlaylist.Part> trailingParts, HlsMediaPlaylist.ServerControl serverControl, Map<Uri, HlsMediaPlaylist.RenditionReport> renditionReports, List<HlsMediaPlaylist.Interstitial> interstitials ) Constructs an instance.

Public constructors

HlsMediaPlaylist(
    @HlsMediaPlaylist.PlaylistType int playlistType,
    String baseUri,
    List<String> tags,
    long startOffsetUs,
    boolean preciseStart,
    long startTimeUs,
    boolean hasDiscontinuitySequence,
    int discontinuitySequence,
    long mediaSequence,
    int version,
    long targetDurationUs,
    long partTargetDurationUs,
    boolean hasIndependentSegments,
    boolean hasEndTag,
    boolean hasProgramDateTime,
    @Nullable DrmInitData protectionSchemes,
    List<HlsMediaPlaylist.Segment> segments,
    List<HlsMediaPlaylist.Part> trailingParts,
    HlsMediaPlaylist.ServerControl serverControl,
    Map<Uri, HlsMediaPlaylist.RenditionReport> renditionReports,
    List<HlsMediaPlaylist.Interstitial> interstitials
)

Constructs an instance.

Public methods
`HlsMediaPlaylist`	`copy(List<StreamKey> streamKeys)` Returns a copy of the manifest including only the streams specified by the given keys.
`HlsMediaPlaylist`	`copyWith(long startTimeUs, int discontinuitySequence)` Returns a playlist identical to this one except for the start time, the discontinuity sequence and `hasDiscontinuitySequence` values.
`HlsMediaPlaylist`	`copyWithEndTag()` Returns a playlist identical to this one except that an end tag is added.
`long`	`getEndTimeUs()` Returns the result of adding the duration of the playlist to its start time.
`boolean`	`isNewerThan(@Nullable HlsMediaPlaylist other)` Returns whether this playlist is newer than `other`.

Inherited fields

From androidx.media3.exoplayer.hls.playlist.HlsPlaylist

`final String`	`baseUri` The base uri.
`final boolean`	`hasIndependentSegments` Whether the media is formed of independent segments, as defined by the #EXT-X-INDEPENDENT-SEGMENTS tag.
`final List<String>`	`tags` The list of tags in the playlist.

Constants

PLAYLIST_TYPE_EVENT

public static final int PLAYLIST_TYPE_EVENT = 2

PLAYLIST_TYPE_UNKNOWN

public static final int PLAYLIST_TYPE_UNKNOWN = 0

PLAYLIST_TYPE_VOD

public static final int PLAYLIST_TYPE_VOD = 1

Public fields

discontinuitySequence

public final int discontinuitySequence

The discontinuity sequence number of the first media segment in the playlist, as defined by #EXT-X-DISCONTINUITY-SEQUENCE.

durationUs

public final long durationUs

The total duration of the playlist in microseconds.

hasDiscontinuitySequence

public final boolean hasDiscontinuitySequence

Whether the playlist contains the #EXT-X-DISCONTINUITY-SEQUENCE tag.

hasEndTag

public final boolean hasEndTag

Whether the playlist contains the #EXT-X-ENDLIST tag.

hasPositiveStartOffset

public final boolean hasPositiveStartOffset

Whether the startOffsetUs was explicitly defined by #EXT-X-START as a positive value or zero.

hasProgramDateTime

public final boolean hasProgramDateTime

Whether the playlist contains a #EXT-X-PROGRAM-DATE-TIME tag.

interstitials

public final ImmutableList<HlsMediaPlaylist.Interstitial> interstitials

The interstitials declared as #EXT-X-DATERANGE with CLASS="com.apple.hls.interstitial"

mediaSequence

public final long mediaSequence

The media sequence number of the first media segment in the playlist, as defined by #EXT-X-MEDIA-SEQUENCE.

partTargetDurationUs

public final long partTargetDurationUs

The target duration for segment parts, as defined by #EXT-X-PART-INF, or TIME_UNSET if undefined.

playlistType

@HlsMediaPlaylist.PlaylistType
public final int playlistType

The type of the playlist. See PlaylistType.

preciseStart

public final boolean preciseStart

Whether the start position should be precise, as defined by #EXT-X-START.

protectionSchemes

public final @Nullable DrmInitData protectionSchemes

Contains the CDM protection schemes used by segments in this playlist. Does not contain any key acquisition data. Null if none of the segments in the playlist is CDM-encrypted.

renditionReports

public final Map<Uri, HlsMediaPlaylist.RenditionReport> renditionReports

The rendition reports of alternative rendition playlists.

segments

public final List<HlsMediaPlaylist.Segment> segments

The list of segments in the playlist.

serverControl

public final HlsMediaPlaylist.ServerControl serverControl

The attributes of the #EXT-X-SERVER-CONTROL header.

startOffsetUs

public final long startOffsetUs

The start offset in microseconds from the beginning of the playlist, as defined by #EXT-X-START, or TIME_UNSET if undefined. The value is guaranteed to be between 0 and durationUs, inclusive.

startTimeUs

public final long startTimeUs

If hasProgramDateTime is true, contains the datetime as microseconds since epoch. Otherwise, contains the aggregated duration of removed segments up to this snapshot of the playlist.

targetDurationUs

public final long targetDurationUs

The target duration in microseconds, as defined by #EXT-X-TARGETDURATION.

trailingParts

public final List<HlsMediaPlaylist.Part> trailingParts

The list of parts at the end of the playlist for which the segment is not in the playlist yet.

version

public final int version

The compatibility version, as defined by #EXT-X-VERSION.

Public constructors