Interface LoadErrorHandlingPolicy

  • All Known Implementing Classes:
    DefaultLoadErrorHandlingPolicy

    public interface LoadErrorHandlingPolicy
    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(FallbackOptions, LoadErrorInfo) when a load error occurs. The LoadErrorHandlingPolicy.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(LoadErrorInfo). 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(int) retries have been attempted.

    Methods are invoked on the playback thread.

    • Field Detail

      • FALLBACK_TYPE_LOCATION

        static final int FALLBACK_TYPE_LOCATION
        Fallback to the same resource at a different location (i.e., a different URL through which the exact same data can be requested).
        See Also:
        Constant Field Values
      • FALLBACK_TYPE_TRACK

        static final int FALLBACK_TYPE_TRACK
        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).
        See Also:
        Constant Field Values
    • Method Detail

      • getRetryDelayMsFor

        long getRetryDelayMsFor​(LoadErrorHandlingPolicy.LoadErrorInfo loadErrorInfo)
        Returns whether a loader can retry on encountering an error, and if so the duration to wait before retrying. A return value of C.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 - A LoadErrorHandlingPolicy.LoadErrorInfo holding information about the load error.
        Returns:
        The duration to wait before retrying in milliseconds, or C.TIME_UNSET if the error is fatal and should not be retried.
      • onLoadTaskConcluded

        default void onLoadTaskConcluded​(long loadTaskId)
        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.

      • getMinimumLoadableRetryCount

        int getMinimumLoadableRetryCount​(int dataType)
        Returns the minimum number of times to retry a load before a load error that can be retried may be considered fatal.
        Parameters:
        dataType - One of the C.DATA_TYPE_* constants indicating the type of data being loaded.
        Returns:
        The minimum number of times to retry a load before a load error that can be retried may be considered fatal.
        See Also:
        Loader.startLoading(Loadable, Callback, int)