Constructor Detail

• Builder

  public Builder()

Method Detail

• amount

  public CachingParameters.Builder amount(String amount)

  Sets the amount of data to cache for the given stream.

  Parameters:

  amount - The amount of data to cache, in seconds or percentage string (XX%). (NonNull)

  Remarks:

  Possible formats:

       - A number in seconds.
       - A percentage string (XX%) for a proportion of the content duration.
   

  Default Value:

  "100%"

• expirationDate

  public CachingParameters.Builder expirationDate(Date expirationDate)

  Sets the expiration date of the cached data.

  Parameters:

  expirationDate - The expiration date of the cached data. (Nullable)

  Remarks:

       - Must be a date in the future.
   

  Default Value:

  30 minutes after starting the caching task.

• bandwidth

  public CachingParameters.Builder bandwidth(Long bandwidth)

  Sets the upper bandwidth limit of the quality to cache.

  Parameters:

  bandwidth - The bandwidth between one and Long.MAX_VALUE or null. (Nullable)

  Remarks:

       - This will take the quality with the highest bandwidth that is lower than the specified bandwidth.
       - It should be a value between one and Long.MAX_VALUE or null.
       - In case the value is null, it defaults to the highest bandwidth possible.
   

• build

  public CachingParameters build()

  Builds the caching parameters.