DefaultHlsPlaylistTracker

const val DEFAULT_PLAYLIST_STUCK_TARGET_DURATION_COEFFICIENT = 3.5: Double

Default coefficient applied on the target duration of a playlist to determine the amount of time after which an unchanging playlist is considered stuck.

const val FACTORY: HlsPlaylistTracker.Factory!

Factory for DefaultHlsPlaylistTracker instances.

DefaultHlsPlaylistTracker(
    dataSourceFactory: HlsDataSourceFactory!,
    loadErrorHandlingPolicy: LoadErrorHandlingPolicy!,
    playlistParserFactory: HlsPlaylistParserFactory!
)

Creates an instance.

DefaultHlsPlaylistTracker(
    dataSourceFactory: HlsDataSourceFactory!,
    loadErrorHandlingPolicy: LoadErrorHandlingPolicy!,
    playlistParserFactory: HlsPlaylistParserFactory!,
    playlistStuckTargetDurationCoefficient: Double
)

Creates an instance.

fun addListener(listener: HlsPlaylistTracker.PlaylistEventListener!): Unit

Registers a listener to receive events from the playlist tracker.

fun excludeMediaPlaylist(playlistUrl: Uri!, exclusionDurationMs: Long): Boolean

Excludes the given media playlist for the given duration, in milliseconds.

fun getPlaylistSnapshot(url: Uri!, isForPlayback: Boolean): HlsMediaPlaylist?

Returns the most recent snapshot available of the playlist referenced by the provided .

fun isSnapshotValid(url: Uri!): Boolean

Returns whether the snapshot of the playlist referenced by the provided Uri is valid, meaning all the segments referenced by the playlist are expected to be available. If the playlist is not valid then some of the segments may no longer be available.

fun maybeThrowPlaylistRefreshError(url: Uri!): Unit

If the playlist is having trouble refreshing the playlist referenced by the given Uri, this method throws the underlying error.

fun maybeThrowPrimaryPlaylistRefreshError(): Unit

If the tracker is having trouble refreshing the multivariant playlist or the primary playlist, this method throws the underlying error. Otherwise, does nothing.

fun onLoadCanceled(
    loadable: ParsingLoadable<HlsPlaylist!>!,
    elapsedRealtimeMs: Long,
    loadDurationMs: Long,
    released: Boolean
): Unit

Called when a load has been canceled.

Note: If the Loader has not been released then there is guaranteed to be a memory barrier between load exiting and this callback being called. If the has been released then this callback may be called before load exits.

fun onLoadCompleted(
    loadable: ParsingLoadable<HlsPlaylist!>!,
    elapsedRealtimeMs: Long,
    loadDurationMs: Long
): Unit

Called when a load has completed.

Note: There is guaranteed to be a memory barrier between load exiting and this callback being called.

fun onLoadError(
    loadable: ParsingLoadable<HlsPlaylist!>!,
    elapsedRealtimeMs: Long,
    loadDurationMs: Long,
    error: IOException!,
    errorCount: Int
): Loader.LoadErrorAction!

Called when a load encounters an error.

Note: There is guaranteed to be a memory barrier between load exiting and this callback being called.

fun refreshPlaylist(url: Uri!): Unit

Requests a playlist refresh and removes it from the exclusion list.

The playlist tracker may choose to delay the playlist refresh. The request is discarded if a refresh was already pending.

fun removeListener(listener: HlsPlaylistTracker.PlaylistEventListener!): Unit

Unregisters a listener.

fun start(
    initialPlaylistUri: Uri!,
    eventDispatcher: MediaSourceEventListener.EventDispatcher!,
    primaryPlaylistListener: HlsPlaylistTracker.PrimaryPlaylistListener!
): Unit

Starts the playlist tracker.

Must be called from the playback thread. A tracker may be restarted after a stop call.

fun stop(): Unit

Stops the playlist tracker and releases any acquired resources.

Must be called once per start call.

val initialStartTimeUs: Long

val isLive: Boolean

val multivariantPlaylist: HlsMultivariantPlaylist?