com.google.android.exoplayer2.source.hls.playlist

Class HlsPlaylistTracker

java.lang.Object

com.google.android.exoplayer2.source.hls.playlist.HlsPlaylistTracker

All Implemented Interfaces:

com.google.android.exoplayer2.upstream.Loader.Callback<com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist>>

public final class HlsPlaylistTracker
extends java.lang.Object
implements com.google.android.exoplayer2.upstream.Loader.Callback<com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist>>

Tracks playlists linked to a provided playlist url. The provided url might reference an HLS master playlist or a media playlist.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HlsPlaylistTracker.PlaylistEventListener Called on playlist loading events.
static class	HlsPlaylistTracker.PlaylistResetException Thrown when the media sequence of a new snapshot indicates the server has reset.
static class	HlsPlaylistTracker.PlaylistStuckException Thrown when a playlist is considered to be stuck due to a server side error.
static interface	HlsPlaylistTracker.PrimaryPlaylistListener Listener for primary playlist changes.

Constructor Summary

Constructors

Constructor and Description
HlsPlaylistTracker(android.net.Uri initialPlaylistUri, HlsDataSourceFactory dataSourceFactory, com.google.android.exoplayer2.source.AdaptiveMediaSourceEventListener.EventDispatcher eventDispatcher, int minRetryCount, HlsPlaylistTracker.PrimaryPlaylistListener primaryPlaylistListener)

Method Summary

Modifier and Type	Method and Description
void	addListener(HlsPlaylistTracker.PlaylistEventListener listener) Registers a listener to receive events from the playlist tracker.
HlsMasterPlaylist	getMasterPlaylist() Returns the master playlist.
HlsMediaPlaylist	getPlaylistSnapshot(HlsMasterPlaylist.HlsUrl url) Returns the most recent snapshot available of the playlist referenced by the provided HlsMasterPlaylist.HlsUrl.
boolean	isLive() Returns whether this is live content.
boolean	isSnapshotValid(HlsMasterPlaylist.HlsUrl url) Returns whether the snapshot of the playlist referenced by the provided HlsMasterPlaylist.HlsUrl is valid, meaning all the segments referenced by the playlist are expected to be available.
void	maybeThrowPlaylistRefreshError(HlsMasterPlaylist.HlsUrl url) If the playlist is having trouble refreshing the playlist referenced by the given HlsMasterPlaylist.HlsUrl, this method throws the underlying error.
void	maybeThrowPrimaryPlaylistRefreshError() If the tracker is having trouble refreshing the master playlist or the primary playlist, this method throws the underlying error.
void	onLoadCanceled(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable, long elapsedRealtimeMs, long loadDurationMs, boolean released)
void	onLoadCompleted(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable, long elapsedRealtimeMs, long loadDurationMs)
int	onLoadError(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable, long elapsedRealtimeMs, long loadDurationMs, java.io.IOException error)
void	refreshPlaylist(HlsMasterPlaylist.HlsUrl url) Triggers a playlist refresh and whitelists it.
void	release() Releases the playlist tracker.
void	removeListener(HlsPlaylistTracker.PlaylistEventListener listener) Unregisters a listener.
void	start() Starts tracking all the playlists related to the provided Uri.

Methods inherited from class java.lang.Object

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

Constructor Detail

HlsPlaylistTracker

public HlsPlaylistTracker(android.net.Uri initialPlaylistUri,
                          HlsDataSourceFactory dataSourceFactory,
                          com.google.android.exoplayer2.source.AdaptiveMediaSourceEventListener.EventDispatcher eventDispatcher,
                          int minRetryCount,
                          HlsPlaylistTracker.PrimaryPlaylistListener primaryPlaylistListener)

Parameters:

initialPlaylistUri - Uri for the initial playlist of the stream. Can refer a media playlist or a master playlist.

dataSourceFactory - A factory for DataSource instances.

eventDispatcher - A dispatcher to notify of events.

minRetryCount - The minimum number of times the load must be retried before blacklisting a playlist.

primaryPlaylistListener - A callback for the primary playlist change events.

Method Detail

addListener

public void addListener(HlsPlaylistTracker.PlaylistEventListener listener)

Registers a listener to receive events from the playlist tracker.

Parameters:

listener - The listener.

removeListener

public void removeListener(HlsPlaylistTracker.PlaylistEventListener listener)

Unregisters a listener.

Parameters:

listener - The listener to unregister.

start

public void start()

Starts tracking all the playlists related to the provided Uri.

getMasterPlaylist

public HlsMasterPlaylist getMasterPlaylist()

Returns the master playlist.

Returns:

The master playlist. Null if the initial playlist has yet to be loaded.

getPlaylistSnapshot

public HlsMediaPlaylist getPlaylistSnapshot(HlsMasterPlaylist.HlsUrl url)

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

Parameters:

url - The HlsMasterPlaylist.HlsUrl corresponding to the requested media playlist.

Returns:

The most recent snapshot of the playlist referenced by the provided HlsMasterPlaylist.HlsUrl. May be null if no snapshot has been loaded yet.

isSnapshotValid

public boolean isSnapshotValid(HlsMasterPlaylist.HlsUrl url)

Returns whether the snapshot of the playlist referenced by the provided HlsMasterPlaylist.HlsUrl 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.

Parameters:

url - The HlsMasterPlaylist.HlsUrl.

Returns:

Whether the snapshot of the playlist referenced by the provided HlsMasterPlaylist.HlsUrl is valid.

release

public void release()

Releases the playlist tracker.

maybeThrowPrimaryPlaylistRefreshError

public void maybeThrowPrimaryPlaylistRefreshError()
                                           throws java.io.IOException

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

Throws:

java.io.IOException - The underlying error.

maybeThrowPlaylistRefreshError

public void maybeThrowPlaylistRefreshError(HlsMasterPlaylist.HlsUrl url)
                                    throws java.io.IOException

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

Parameters:

url - The HlsMasterPlaylist.HlsUrl.

Throws:

java.io.IOException - The underyling error.

refreshPlaylist

public void refreshPlaylist(HlsMasterPlaylist.HlsUrl url)

Triggers a playlist refresh and whitelists it.

Parameters:

url - The HlsMasterPlaylist.HlsUrl of the playlist to be refreshed.

isLive

public boolean isLive()

Returns whether this is live content.

Returns:

True if the content is live. False otherwise.

onLoadCompleted

public void onLoadCompleted(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable,
                            long elapsedRealtimeMs,
                            long loadDurationMs)

Specified by:

onLoadCompleted in interface com.google.android.exoplayer2.upstream.Loader.Callback<com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist>>

onLoadCanceled

public void onLoadCanceled(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable,
                           long elapsedRealtimeMs,
                           long loadDurationMs,
                           boolean released)

Specified by:

onLoadCanceled in interface com.google.android.exoplayer2.upstream.Loader.Callback<com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist>>

onLoadError

public int onLoadError(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable,
                       long elapsedRealtimeMs,
                       long loadDurationMs,
                       java.io.IOException error)

Specified by:

onLoadError in interface com.google.android.exoplayer2.upstream.Loader.Callback<com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist>>