Method Detail

• getId

  String getId()

  The identifier of the task. (NonNull)

  Returns:

  The task identifier.

• getStatus

  CachingTaskStatus getStatus()

  The current status of the task.

  Returns:

  The status of the task. (NonNull)

  Remarks:

       - For possible values, see CachingTaskStatus.
   

  Default Value:

  CachingTaskStatus.IDLE

• getSource

  SourceDescription getSource()

  The media source associated with the task.

  Returns:

  The source description. (NonNull)

• getParameters

  CachingParameters getParameters()

  The configuration of the task.

  Returns:

  The parameters of the caching task. (NonNull)

  Remarks:

       - These parameters can not be modified after creating a task. Instead, a new task should be created with different parameters.
   

• getDuration

  double getDuration()

  The requested cached duration of the media, in seconds.

  Returns:

  The amount that will be cached, in seconds.

  Remarks:

       - Returns -1 if the duration is not available yet.
   

• getBytes

  long getBytes()

  The estimation of the amount this task will download and store, in bytes.

  Returns:

  the data estimation, in bytes.

  Remarks:

       - Returns -1 if the estimate is not available yet.
   

• getBytesCached

  long getBytesCached()

  The amount downloaded and stored, in bytes.

  Returns:

  The amount of data downloaded and stored, in bytes.

• getCached

  TimeRanges getCached()

  The time ranges indicating the data which has been cached.

  Returns:

  The time ranges cached. (NonNull)

• getSecondsCached

  double getSecondsCached()

  The amount of content that has been cached.

  Returns:

  The duration cached, in seconds.

• getPercentageCached

  double getPercentageCached()

  The percentage of content that has been cached.

  Returns:

  The percentage cached, between 0 and 1.

• getStatusNotificationId

  Integer getStatusNotificationId()

  The notification identifier of the task when showing its status notification.

  Returns:

  The notification identifier of the task. (Nullable)

  Remarks:

       - The identifier is null when the task has not been started yet.
   

• getProgressNotificationId

  Integer getProgressNotificationId()

  The notification identifier of the task when showing its progress notification.

  Returns:

  The notification identifier of the task. (Nullable)

  Remarks:

       - The identifier is null when the task has not been started yet.
   

• license

  CachingTaskLicense license()

  The API for license related queries and operations.

  Returns:

  The CachingTaskLicense. (NonNull)

• start

  void start()

  Start caching the media.

  Remarks:

       - A manifest or segment will only be cached if it is not yet present in the cache.
   

• pause

  void pause()

  Pause caching the media.

  Remarks:

       - Segments that are currently being downloaded will still be completed and stored.
       - A paused task can be resumed with start().
   

• remove

  void remove()

  Remove the cached media.

  Remarks:

       - A manifest or segment referenced by multiple tasks will only be evicted if all associated tasks are removed.