Type definition for the handler that allows changing HTTP requests.

Type definition for the handler that needs to be called if a retry should happen from RetryHttpRequestHandler.

Type definition for the handler that needs to be called if no retry should happen from RetryHttpRequestHandler.

Type definition to implement custom retry behavior for failed HTTP requests. Implementing it allows to define how and when retries should occur based on the request type, retry attempt, and response.

Type definition for the handler that allows processing HTTP responses.

Called before an HTTP request is made. This delegate allows modifying the request parameters before the request is sent.

Limitations

• Requests of type HttpRequestType.keyHlsAes are not supported.

• Requests of type HttpRequestType.mediaSubtitles are only supported for side-loaded subtitles.

Called before an HTTP request is made. This property can be used to modify the request parameters before the request is sent.

• Usage Example:

  networkConfig.preprocessHttpRequest = { type, request, completionHandler in
  var modifiedRequest = httpRequest
  
  // Modify the request based on the type
  switch type {
  case .drmLicenseFairplay:
      // Example modification for DRM requests
      modifiedRequest.headers["Authorization"] = "Bearer someAccessToken"
  case .manifestHlsMaster:
      // Example modification for HLS Playlist requests
      modifiedRequest.url = modifiedRequest.url.appendingPathComponent("modified")
  default:
      break
  }
  
  // Call the completion handler with the modified request
  completionHandler(modifiedRequest)
  }
  

Limitations

• Requests of type HttpRequestType.keyHlsAes are not supported.

• Requests of type HttpRequestType.mediaSubtitles are only supported for side-loaded subtitles.

Called when an HTTP request has failed. This property allows you to override the default retry behavior with a custom handler.

A request is considered failed if the HTTP response status code is not within the 200-299 range:

let success = response.statusCode >= 200 && response.statusCode < 300

• Usage Example:

  let retryHttpRequestHandler = { requestType, retryCount, response, retryHandler, abortHandler in
  // Retry 3 times
  guard retryCount <= 3 else {
      // Abort retrying when threshold was reached
      abortHandler()
      return
  }
  
  // Customize delay for the next retry. For instance use exponential backoff:
  let retryDelay: TimeInterval = exp(0.25 * Double(retryCount))
  // Retry the original request again
  retryHandler(retryDelay, response.request)
  }
  

Default Behavior

If no custom handler is provided, the default retry logic will be applied:

• The request will be retried up to a maximum of 3 times.
• The delay between retries is calculated using a custom exponential backoff formula, with a maximum delay of 5 seconds:
  • For each retry attempt, the delay is determined by the formula exp(0.25 * retryCount), which produces a gradually increasing delay.
  • The delay is capped at 5 seconds to ensure retries occur within a reasonable timeframe.
• If the retry count exceeds 3 attempts, the request will not be retried, and the abortHandler will be called.

Customization

When a custom retryHttpRequest handler is set, no internal retry handling is done at all. The custom handler needs to manage all retries. Some considerations for implementing your own handler include:

• Ensure to set a maximum number of allowed retries to avoid retrying an unreasonable number of times.
• Be aware of an underlying AVFoundation limit of approximately 20 seconds for performing retries. If a failed request is not successfully retried within that timeframe, an error will occur. Within that 20-second window, the number of retries that can be performed is unlimited.

Limitations

• Requests of type HttpRequestType.keyHlsAes are not supported.

• Requests of type HttpRequestType.mediaSubtitles are only supported for side-loaded subtitles.

Called after an HTTP response is received. This property can be used to access or change properties of the response before it gets into the player.

• Usage Example:

  let preprocessHttpResponseHandler: NetworkConfig.PreprocessHttpResponseHandler = { type, response, completionHandler in
  var modifiedResponse = response
  
  // Modify the response as needed based on the request type
  switch type {
  case .manifestHlsVariant:
      modifiedResponse = modifyResponseForHlsVariantType(response)
  case .mediaSubtitles:
      modifiedResponse = modifyResponseForMediaPosterType(response)
  default:
      break
  }
  
  // Call the completion handler with the modified response
  completionHandler(modifiedResponse)
  }
  

Limitations

• Requests of type HttpRequestType.keyHlsAes are not supported.

• Requests of type HttpRequestType.mediaSubtitles are only supported for side-loaded subtitles.