Package com.castlabs.sdk.thumbs

# Class BifThumbnailProvider

java.lang.Object
com.castlabs.sdk.thumbs.BaseThumbnailProvider
com.castlabs.sdk.thumbs.BifThumbnailProvider

All Implemented Interfaces:
  `ThumbnailProvider`

public class BifThumbnailProvider extends BaseThumbnailProvider
Provided thumbnails from BIF files.

BIF files are essentially containers that wrap a set of jpegs and add an index that allows to map a jpeg to both a timestamp and the absolute location in the file. This enabled good streaming support as well as a compact format.

This implementation supports both blocked loading as well as streaming support for the BIF data.

Since:
  4.0.0

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from interface com.castlabs.sdk.thumbs.ThumbnailProvider

  `ThumbnailProvider.Callback, ThumbnailProvider.IndexRefreshListener, ThumbnailProvider.RequestQueuePosition, ThumbnailProvider.ThumbnailResult`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `BifThumbnailProvider(com.castlabs.sdk.thumbs.ThumbnailLoader.Factory loaderFactory, PlayerController playerController, Uri sourceUri)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `cancelPendingRequests()`
  Cancels any queued Thumbnail Requests.
  `boolean`
  `cancelRequests(long positionFromUs, long positionToUs)`
  Removes previously queued explicit requests (through the getThumbnail methods), whose requests positions' within the specified position range.
  `void`
  `destroy()`
  Free up all the resources, meaning this provider will not be used anymore
  `DownloadableResource[]`
  `getDownloadableResources(String remoteManifestUrl, File basePath, Bundle bundle)`
  This methods is used to integrate a thumbnail provider with the downloader plugins and implementation can return an array of resources that should be fetched for offline playback.
  `Future<ThumbnailProvider.ThumbnailResult>`
  `getThumbnail(long positionUs, int thumbnailIndex)`
  Load the exact thumbnail for the given position and return a `Future` linked to the operation.
  `Future<ThumbnailProvider.ThumbnailResult>`
  `getThumbnail(long positionUs, int thumbnailIndex, long positionToleranceUs)`
  Load the thumbnail for the given position and return a `Future` linked to the operation.
  `void`
  `getThumbnail(long positionUs, ThumbnailProvider.Callback callback, int thumbnailIndex)`
  Load the exact thumbnail for the given position and return it through the provided callback.
  `void`
  `getThumbnail(long positionUs, ThumbnailProvider.Callback callback, int thumbnailIndex, long positionToleranceUs)`
  Load the thumbnail for the given position and return it through the provided callback.
  `void`
  `setLoadingStrategy(LoadingStrategy loadingStrategy)`
  Updates the `LoadingStrategy` of this provider.
  `void`
  `setRequestQueuePosition(ThumbnailProvider.RequestQueuePosition queuePosition)`
  Set where in the loading queue shall new thumbnail requests be placed.

  ### Methods inherited from class com.castlabs.sdk.thumbs.BaseThumbnailProvider

  `addIndexRefreshListener, getCuePointsList, getThumbnailPosition, removeIndexRefreshListener`

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### BifThumbnailProvider

    public BifThumbnailProvider(@NonNull com.castlabs.sdk.thumbs.ThumbnailLoader.Factory loaderFactory, @NonNull PlayerController playerController, @NonNull Uri sourceUri)

- ## Method Details

  - ### destroy

    public void destroy()
    Description copied from interface: `ThumbnailProvider`
    Free up all the resources, meaning this provider will not be used anymore
    Specified by:
      `destroy` in interface `ThumbnailProvider`
    Overrides:
      `destroy` in class `BaseThumbnailProvider`

  - ### setLoadingStrategy

    public void setLoadingStrategy(@NonNull LoadingStrategy loadingStrategy)
    Description copied from interface: `ThumbnailProvider`
    Updates the `LoadingStrategy` of this provider. If thumbnails are already loading, this might not have an immediate effect.
    Parameters:
      `loadingStrategy` - the loading strategy to set

  - ### setRequestQueuePosition

    public void setRequestQueuePosition(@NonNull ThumbnailProvider.RequestQueuePosition queuePosition)
    Description copied from interface: `ThumbnailProvider`
    Set where in the loading queue shall new thumbnail requests be placed. Either front or back.
    Parameters:
      `queuePosition` - the position where to insert the upcoming thumbnail requests

  - ### cancelPendingRequests

    public void cancelPendingRequests()
    Description copied from interface: `ThumbnailProvider`
    Cancels any queued Thumbnail Requests. Requests currently processing won't be cancelled.

  - ### getDownloadableResources

    @Nullable public DownloadableResource[] getDownloadableResources(String remoteManifestUrl, File basePath, Bundle bundle)
    Description copied from interface: `ThumbnailProvider`
    This methods is used to integrate a thumbnail provider with the downloader plugins and implementation can return an array of resources that should be fetched for offline playback.
    Parameters:
      `remoteManifestUrl` - The manifest URL of the remote manifest that is the source of this download
      `basePath` - The base folder for this download
      `bundle` - The bundle that was used to start the initiate the download
    Returns:
      Array of downloadable resources or null

  - ### getThumbnail

    public void getThumbnail(long positionUs, ThumbnailProvider.Callback callback, @ThumbnailIndex int thumbnailIndex)
    Description copied from interface: `ThumbnailProvider`
    Load the exact thumbnail for the given position and return it through the provided callback.

    Same as calling `ThumbnailProvider.getThumbnail(long, Callback, int, long)` with a tolerance of 0

    Parameters:
      `positionUs` - The position in microseconds
      `callback` - The callback that will be triggered once data are available
      `thumbnailIndex` - Position of the Thumbnail relative to its timestamp

  - ### getThumbnail

    public Future<ThumbnailProvider.ThumbnailResult> getThumbnail(long positionUs, int thumbnailIndex)
    Description copied from interface: `ThumbnailProvider`
    Load the exact thumbnail for the given position and return a `Future` linked to the operation.

    Same as calling `ThumbnailProvider.getThumbnail(long, int, long)` with a tolerance of 0

    Parameters:
      `positionUs` - The position in microseconds
      `thumbnailIndex` - Position of the Thumbnail relative to its timestamp
    Returns:
      a Future identifying the request

  - ### getThumbnail

    public Future<ThumbnailProvider.ThumbnailResult> getThumbnail(long positionUs, int thumbnailIndex, long positionToleranceUs)
    Description copied from interface: `ThumbnailProvider`
    Load the thumbnail for the given position and return a `Future` linked to the operation.
    Parameters:
      `positionUs` - The position in microseconds
      `thumbnailIndex` - Position of the Thumbnail relative to its timestamp
      `positionToleranceUs` - Maximum tolerance time between the time of the requested thumbnail and a potentially already-loaded thumbnail in the index. If a matching nearby thumbnail with data is found, it will be returned immediately. Otherwise the requested thumbnail will be scheduled for fetching. If 0, the exact thumbnail will always be returned, loading it if necessary.
    Returns:
      a Future identifying the request

  - ### getThumbnail

    public void getThumbnail(long positionUs, ThumbnailProvider.Callback callback, int thumbnailIndex, long positionToleranceUs)
    Description copied from interface: `ThumbnailProvider`
    Load the thumbnail for the given position and return it through the provided callback.
    Parameters:
      `positionUs` - The position in microseconds
      `callback` - The callback that will be triggered once data are available
      `thumbnailIndex` - Position of the Thumbnail relative to its timestamp
      `positionToleranceUs` - Maximum tolerance time between the time of the requested thumbnail and a potentially already-loaded thumbnail in the index. If a matching nearby thumbnail with data is found, it will be returned immediately. Otherwise the requested thumbnail will be scheduled for fetching. If 0, the exact thumbnail will always be returned, loading it if necessary.

  - ### cancelRequests

    public boolean cancelRequests(long positionFromUs, long positionToUs)
    Description copied from interface: `ThumbnailProvider`
    Removes previously queued explicit requests (through the getThumbnail methods), whose requests positions' within the specified position range. If the request was issued with a `ThumbnailProvider.Callback` it will be invoked.

    Parameters:
      `positionFromUs` - minimum position for cancelling a request (inclusive)
      `positionToUs` - maximum position for cancelling a request (exclusive)
    Returns:
      whether at least one request has been cancelled by the method call