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

Class DefaultHlsPlaylistTracker

java.lang.Object

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

All Implemented Interfaces:

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

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

Default implementation for HlsPlaylistTracker.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.source.hls.playlist.HlsPlaylistTracker

HlsPlaylistTracker.Factory, HlsPlaylistTracker.PlaylistEventListener, HlsPlaylistTracker.PlaylistResetException, HlsPlaylistTracker.PlaylistStuckException, HlsPlaylistTracker.PrimaryPlaylistListener

Field Summary

Fields

Modifier and Type	Field and Description
static HlsPlaylistTracker.Factory	FACTORY Factory for DefaultHlsPlaylistTracker instances.

Constructor Summary

Constructors

Constructor and Description
DefaultHlsPlaylistTracker(HlsDataSourceFactory dataSourceFactory, com.google.android.exoplayer2.upstream.LoadErrorHandlingPolicy loadErrorHandlingPolicy, HlsPlaylistParserFactory playlistParserFactory)
DefaultHlsPlaylistTracker(HlsDataSourceFactory dataSourceFactory, com.google.android.exoplayer2.upstream.LoadErrorHandlingPolicy loadErrorHandlingPolicy, com.google.android.exoplayer2.upstream.ParsingLoadable.Parser<HlsPlaylist> playlistParser) Deprecated. Use DefaultHlsPlaylistTracker(HlsDataSourceFactory, LoadErrorHandlingPolicy, HlsPlaylistParserFactory) instead. Using this constructor prevents support for attributes that are carried over from the master playlist to the media playlists.

Method Summary

Modifier and Type	Method and Description
void	addListener(HlsPlaylistTracker.PlaylistEventListener listener) Registers a listener to receive events from the playlist tracker.
long	getInitialStartTimeUs() Returns the start time of the first loaded primary playlist, or C.TIME_UNSET if no media playlist has been loaded.
HlsMasterPlaylist	getMasterPlaylist() Returns the master playlist.
HlsMediaPlaylist	getPlaylistSnapshot(HlsMasterPlaylist.HlsUrl url, boolean isForPlayback) Returns the most recent snapshot available of the playlist referenced by the provided HlsMasterPlaylist.HlsUrl.
boolean	isLive() Returns whether the tracked playlists describe a live stream.
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)
com.google.android.exoplayer2.upstream.Loader.LoadErrorAction	onLoadError(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable, long elapsedRealtimeMs, long loadDurationMs, java.io.IOException error, int errorCount)
void	refreshPlaylist(HlsMasterPlaylist.HlsUrl url) Requests a playlist refresh and whitelists it.
void	removeListener(HlsPlaylistTracker.PlaylistEventListener listener) Unregisters a listener.
void	start(android.net.Uri initialPlaylistUri, com.google.android.exoplayer2.source.MediaSourceEventListener.EventDispatcher eventDispatcher, HlsPlaylistTracker.PrimaryPlaylistListener primaryPlaylistListener) Starts the playlist tracker.
void	stop() Stops the playlist tracker and releases any acquired resources.

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final HlsPlaylistTracker.Factory FACTORY

Factory for DefaultHlsPlaylistTracker instances.

Constructor Detail

DefaultHlsPlaylistTracker

@Deprecated
public DefaultHlsPlaylistTracker(HlsDataSourceFactory dataSourceFactory,
                                             com.google.android.exoplayer2.upstream.LoadErrorHandlingPolicy loadErrorHandlingPolicy,
                                             com.google.android.exoplayer2.upstream.ParsingLoadable.Parser<HlsPlaylist> playlistParser)

Deprecated. Use DefaultHlsPlaylistTracker(HlsDataSourceFactory, LoadErrorHandlingPolicy, HlsPlaylistParserFactory) instead. Using this constructor prevents support for attributes that are carried over from the master playlist to the media playlists.

Parameters:

dataSourceFactory - A factory for DataSource instances.

loadErrorHandlingPolicy - The LoadErrorHandlingPolicy.

playlistParser - A ParsingLoadable.Parser for HLS playlists.

DefaultHlsPlaylistTracker

public DefaultHlsPlaylistTracker(HlsDataSourceFactory dataSourceFactory,
                                 com.google.android.exoplayer2.upstream.LoadErrorHandlingPolicy loadErrorHandlingPolicy,
                                 HlsPlaylistParserFactory playlistParserFactory)

Parameters:

dataSourceFactory - A factory for DataSource instances.

loadErrorHandlingPolicy - The LoadErrorHandlingPolicy.

playlistParserFactory - An HlsPlaylistParserFactory.

Method Detail

start

public void start(android.net.Uri initialPlaylistUri,
                  com.google.android.exoplayer2.source.MediaSourceEventListener.EventDispatcher eventDispatcher,
                  HlsPlaylistTracker.PrimaryPlaylistListener primaryPlaylistListener)

Description copied from interface: HlsPlaylistTracker

Starts the playlist tracker.

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

Specified by:

start in interface HlsPlaylistTracker

Parameters:

initialPlaylistUri - Uri of the HLS stream. Can point to a media playlist or a master playlist.

eventDispatcher - A dispatcher to notify of events.

primaryPlaylistListener - A callback for the primary playlist change events.

stop

public void stop()

Description copied from interface: HlsPlaylistTracker

Stops the playlist tracker and releases any acquired resources.

Must be called once per HlsPlaylistTracker.start(android.net.Uri, com.google.android.exoplayer2.source.MediaSourceEventListener.EventDispatcher, com.google.android.exoplayer2.source.hls.playlist.HlsPlaylistTracker.PrimaryPlaylistListener) call.

Specified by:

stop in interface HlsPlaylistTracker

addListener

public void addListener(HlsPlaylistTracker.PlaylistEventListener listener)

Description copied from interface: HlsPlaylistTracker

Registers a listener to receive events from the playlist tracker.

Specified by:

addListener in interface HlsPlaylistTracker

Parameters:

listener - The listener.

removeListener

public void removeListener(HlsPlaylistTracker.PlaylistEventListener listener)

Description copied from interface: HlsPlaylistTracker

Unregisters a listener.

Specified by:

removeListener in interface HlsPlaylistTracker

Parameters:

listener - The listener to unregister.

getMasterPlaylist

@Nullable
public HlsMasterPlaylist getMasterPlaylist()

Description copied from interface: HlsPlaylistTracker

Returns the master playlist.

If the uri passed to HlsPlaylistTracker.start(android.net.Uri, com.google.android.exoplayer2.source.MediaSourceEventListener.EventDispatcher, com.google.android.exoplayer2.source.hls.playlist.HlsPlaylistTracker.PrimaryPlaylistListener) points to a media playlist, an HlsMasterPlaylist with a single variant for said media playlist is returned.

Specified by:

getMasterPlaylist in interface HlsPlaylistTracker

Returns:

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

getPlaylistSnapshot

public HlsMediaPlaylist getPlaylistSnapshot(HlsMasterPlaylist.HlsUrl url,
                                            boolean isForPlayback)

Description copied from interface: HlsPlaylistTracker

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

Specified by:

getPlaylistSnapshot in interface HlsPlaylistTracker

Parameters:

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

isForPlayback - Whether the caller might use the snapshot to request media segments for playback. If true, the primary playlist may be updated to the one requested.

Returns:

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

getInitialStartTimeUs

public long getInitialStartTimeUs()

Description copied from interface: HlsPlaylistTracker

Returns the start time of the first loaded primary playlist, or C.TIME_UNSET if no media playlist has been loaded.

Specified by:

getInitialStartTimeUs in interface HlsPlaylistTracker

isSnapshotValid

public boolean isSnapshotValid(HlsMasterPlaylist.HlsUrl url)

Description copied from interface: HlsPlaylistTracker

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.

Specified by:

isSnapshotValid in interface HlsPlaylistTracker

Parameters:

url - The HlsMasterPlaylist.HlsUrl.

Returns:

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

maybeThrowPrimaryPlaylistRefreshError

public void maybeThrowPrimaryPlaylistRefreshError()
                                           throws java.io.IOException

Description copied from interface: HlsPlaylistTracker

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

Specified by:

maybeThrowPrimaryPlaylistRefreshError in interface HlsPlaylistTracker

Throws:

java.io.IOException - The underlying error.

maybeThrowPlaylistRefreshError

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

Description copied from interface: HlsPlaylistTracker

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

Specified by:

maybeThrowPlaylistRefreshError in interface HlsPlaylistTracker

Parameters:

url - The HlsMasterPlaylist.HlsUrl.

Throws:

java.io.IOException - The underyling error.

refreshPlaylist

public void refreshPlaylist(HlsMasterPlaylist.HlsUrl url)

Description copied from interface: HlsPlaylistTracker

Requests a playlist refresh and whitelists it.

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

Specified by:

refreshPlaylist in interface HlsPlaylistTracker

Parameters:

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

isLive

public boolean isLive()

Description copied from interface: HlsPlaylistTracker

Returns whether the tracked playlists describe a live stream.

Specified by:

isLive in interface HlsPlaylistTracker

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 com.google.android.exoplayer2.upstream.Loader.LoadErrorAction onLoadError(com.google.android.exoplayer2.upstream.ParsingLoadable<HlsPlaylist> loadable,
                                                                                 long elapsedRealtimeMs,
                                                                                 long loadDurationMs,
                                                                                 java.io.IOException error,
                                                                                 int errorCount)

Specified by:

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