LoadErrorHandlingPolicy

@UnstableApi
interface LoadErrorHandlingPolicy

Known direct subclasses

A policy that defines how load errors are handled.

Some loaders are able to choose between a number of alternate resources. Such loaders will call getFallbackSelectionFor when a load error occurs. The FallbackSelection returned by the policy defines whether the loader should fall back to using another resource, and if so the duration for which the failing resource should be excluded.

When fallback does not take place, a loader will call getRetryDelayMsFor. The value returned by the policy defines whether the failed load can be retried, and if so the duration to wait before retrying. If the policy indicates that a load error should not be retried, it will be considered fatal by the loader. The loader may also consider load errors that can be retried fatal if at least getMinimumLoadableRetryCount retries have been attempted.

Methods are invoked on the playback thread.

Summary

Nested types

Holds information about the available fallback options.

A selected fallback option.
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(value = )
annotation LoadErrorHandlingPolicy.FallbackType

Fallback type.

Holds information about a load task error.

Constants
const Int

Fallback to the same resource at a different location (i.e., a different URL through which the exact same data can be requested).
const Int

Fallback to a different track (i.e., a different representation of the same content; for example the same video encoded at a different bitrate or resolution).

Public functions
LoadErrorHandlingPolicy.FallbackSelection?

Returns whether a loader should fall back to using another resource on encountering an error, and if so the duration for which the failing resource should be excluded.
Int

Returns the minimum number of times to retry a load before a load error that can be retried may be considered fatal.
Long

Returns whether a loader can retry on encountering an error, and if so the duration to wait before retrying.
Unit

Called once loadTaskId will not be associated with any more load errors.

Constants

FALLBACK_TYPE_LOCATION

const val FALLBACK_TYPE_LOCATION = 1: Int

Fallback to the same resource at a different location (i.e., a different URL through which the exact same data can be requested).

FALLBACK_TYPE_TRACK

const val FALLBACK_TYPE_TRACK = 2: Int

Fallback to a different track (i.e., a different representation of the same content; for example the same video encoded at a different bitrate or resolution).

Public functions

getFallbackSelectionFor

fun getFallbackSelectionFor(
    fallbackOptions: LoadErrorHandlingPolicy.FallbackOptions!,
    loadErrorInfo: LoadErrorHandlingPolicy.LoadErrorInfo!
): LoadErrorHandlingPolicy.FallbackSelection?

Returns whether a loader should fall back to using another resource on encountering an error, and if so the duration for which the failing resource should be excluded.

If the returned fallback type was not advertised as available, then the loader will not fall back.

Parameters
fallbackOptions: LoadErrorHandlingPolicy.FallbackOptions!

The available fallback options.
loadErrorInfo: LoadErrorHandlingPolicy.LoadErrorInfo!

A LoadErrorInfo holding information about the load error.
Returns
LoadErrorHandlingPolicy.FallbackSelection?

The selected fallback, or null if the calling loader should not fall back.

getMinimumLoadableRetryCount

fun getMinimumLoadableRetryCount(dataType: Int): Int

Returns the minimum number of times to retry a load before a load error that can be retried may be considered fatal.

Parameters
dataType: Int

One of the C.DATA_TYPE_* constants indicating the type of data being loaded.
Returns
Int

The minimum number of times to retry a load before a load error that can be retried may be considered fatal.
See also
startLoading

getRetryDelayMsFor

fun getRetryDelayMsFor(
    loadErrorInfo: LoadErrorHandlingPolicy.LoadErrorInfo!
): Long

Returns whether a loader can retry on encountering an error, and if so the duration to wait before retrying. A return value of TIME_UNSET indicates that the error is fatal and should not be retried.

For loads that can be retried, loaders may ignore the retry delay returned by this method in order to wait for a specific event before retrying.

Parameters
loadErrorInfo: LoadErrorHandlingPolicy.LoadErrorInfo!

A LoadErrorInfo holding information about the load error.
Returns
Long

The duration to wait before retrying in milliseconds, or TIME_UNSET if the error is fatal and should not be retried.

onLoadTaskConcluded

fun onLoadTaskConcluded(loadTaskId: Long): Unit

Called once loadTaskId will not be associated with any more load errors.

Implementations should clean up any resources associated with loadTaskId when this method is called.