Class Loader
- java.lang.Object
-
- com.google.android.exoplayer2.upstream.Loader
-
- All Implemented Interfaces:
LoaderErrorThrower
@Deprecated public final class Loader extends Object implements LoaderErrorThrower
Deprecated.com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.Manages the background loading ofLoader.Loadable
s.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Loader.Callback<T extends Loader.Loadable>
Deprecated.A callback to be notified ofLoader
events.static interface
Loader.Loadable
Deprecated.An object that can be loaded using aLoader
.static class
Loader.LoadErrorAction
Deprecated.Action that can be taken in response toLoader.Callback.onLoadError(Loadable, long, long, IOException, int)
.static interface
Loader.ReleaseCallback
Deprecated.A callback to be notified when aLoader
has finished being released.static class
Loader.UnexpectedLoaderException
Deprecated.Thrown when an unexpected exception or error is encountered during loading.-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.upstream.LoaderErrorThrower
LoaderErrorThrower.Placeholder
-
-
Field Summary
Fields Modifier and Type Field Description static Loader.LoadErrorAction
DONT_RETRY
Deprecated.Discards the failedLoader.Loadable
and ignores any errors that have occurred.static Loader.LoadErrorAction
DONT_RETRY_FATAL
Deprecated.Discards the failedLoader.Loadable
.static Loader.LoadErrorAction
RETRY
Deprecated.Retries the load using the default delay.static Loader.LoadErrorAction
RETRY_RESET_ERROR_COUNT
Deprecated.Retries the load using the default delay and resets the error count.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
cancelLoading()
Deprecated.Cancels the current load.void
clearFatalError()
Deprecated.Clears any stored fatal error.static Loader.LoadErrorAction
createRetryAction(boolean resetErrorCount, long retryDelayMillis)
Deprecated.Creates aLoader.LoadErrorAction
for retrying with the given parameters.boolean
hasFatalError()
Deprecated.Whether the last call tostartLoading(T, com.google.android.exoplayer2.upstream.Loader.Callback<T>, int)
resulted in a fatal error.boolean
isLoading()
Deprecated.Returns whether the loader is currently loading.void
maybeThrowError()
Deprecated.Throws a fatal error, or a non-fatal error if loading is currently backed off and the currentLoader.Loadable
has incurred a number of errors greater than theLoader
s default minimum number of retries.void
maybeThrowError(int minRetryCount)
Deprecated.Throws a fatal error, or a non-fatal error if loading is currently backed off and the currentLoader.Loadable
has incurred a number of errors greater than the specified minimum number of retries.void
release()
Deprecated.Releases the loader.void
release(Loader.ReleaseCallback callback)
Deprecated.Releases the loader.<T extends Loader.Loadable>
longstartLoading(T loadable, Loader.Callback<T> callback, int defaultMinRetryCount)
Deprecated.Starts loading aLoader.Loadable
.
-
-
-
Field Detail
-
RETRY
public static final Loader.LoadErrorAction RETRY
Deprecated.Retries the load using the default delay.
-
RETRY_RESET_ERROR_COUNT
public static final Loader.LoadErrorAction RETRY_RESET_ERROR_COUNT
Deprecated.Retries the load using the default delay and resets the error count.
-
DONT_RETRY
public static final Loader.LoadErrorAction DONT_RETRY
Deprecated.Discards the failedLoader.Loadable
and ignores any errors that have occurred.
-
DONT_RETRY_FATAL
public static final Loader.LoadErrorAction DONT_RETRY_FATAL
Deprecated.Discards the failedLoader.Loadable
. The next call tomaybeThrowError()
will throw the last load error.
-
-
Constructor Detail
-
Loader
public Loader(String threadNameSuffix)
Deprecated.- Parameters:
threadNameSuffix
- A name suffix for the loader's thread. This should be the name of the component using the loader.
-
-
Method Detail
-
createRetryAction
public static Loader.LoadErrorAction createRetryAction(boolean resetErrorCount, long retryDelayMillis)
Deprecated.Creates aLoader.LoadErrorAction
for retrying with the given parameters.- Parameters:
resetErrorCount
- Whether the previous error count should be set to zero.retryDelayMillis
- The number of milliseconds to wait before retrying.- Returns:
- A
Loader.LoadErrorAction
for retrying with the given parameters.
-
hasFatalError
public boolean hasFatalError()
Deprecated.Whether the last call tostartLoading(T, com.google.android.exoplayer2.upstream.Loader.Callback<T>, int)
resulted in a fatal error. CallingmaybeThrowError()
will throw the fatal error.
-
clearFatalError
public void clearFatalError()
Deprecated.Clears any stored fatal error.
-
startLoading
public <T extends Loader.Loadable> long startLoading(T loadable, Loader.Callback<T> callback, int defaultMinRetryCount)
Deprecated.Starts loading aLoader.Loadable
.The calling thread must be a
Looper
thread, which is the thread on which theLoader.Callback
will be called.- Type Parameters:
T
- The type of the loadable.- Parameters:
loadable
- TheLoader.Loadable
to load.callback
- A callback to be called when the load ends.defaultMinRetryCount
- The minimum number of times the load must be retried beforemaybeThrowError()
will propagate an error.- Returns:
SystemClock.elapsedRealtime()
when the load started.- Throws:
IllegalStateException
- If the calling thread does not have an associatedLooper
.
-
isLoading
public boolean isLoading()
Deprecated.Returns whether the loader is currently loading.
-
cancelLoading
public void cancelLoading()
Deprecated.Cancels the current load.- Throws:
IllegalStateException
- If the loader is not currently loading.
-
release
public void release()
Deprecated.Releases the loader. This method should be called when the loader is no longer required.
-
release
public void release(@Nullable Loader.ReleaseCallback callback)
Deprecated.Releases the loader. This method should be called when the loader is no longer required.- Parameters:
callback
- An optional callback to be called on the loading thread once the loader has been released.
-
maybeThrowError
public void maybeThrowError() throws IOException
Deprecated.Description copied from interface:LoaderErrorThrower
Throws a fatal error, or a non-fatal error if loading is currently backed off and the currentLoader.Loadable
has incurred a number of errors greater than theLoader
s default minimum number of retries. Else does nothing.- Specified by:
maybeThrowError
in interfaceLoaderErrorThrower
- Throws:
IOException
- The error.
-
maybeThrowError
public void maybeThrowError(int minRetryCount) throws IOException
Deprecated.Description copied from interface:LoaderErrorThrower
Throws a fatal error, or a non-fatal error if loading is currently backed off and the currentLoader.Loadable
has incurred a number of errors greater than the specified minimum number of retries. Else does nothing.- Specified by:
maybeThrowError
in interfaceLoaderErrorThrower
- Parameters:
minRetryCount
- A minimum retry count that must be exceeded for a non-fatal error to be thrown. Should be non-negative.- Throws:
IOException
- The error.
-
-