CachingTask Protocol Reference

id

The identifier of the task.

Declaration

Swift

var id: String { get }


                    
                    
                    status

The current CachingTaskStatus.

Declaration

Swift

var status: CachingTaskStatus { get }


                    
                    
                    source

The SourceDescription processed by this caching task.

Declaration

Swift

var source: SourceDescription { get }


                    
                    
                    parameters

The CachingParameters for this caching task.

Remark

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

Declaration

Swift

var parameters: CachingParameters { get }


                    
                    
                    duration

The amount of content that will be available after this task has finished, in seconds.

Declaration

Swift

var duration: Double { get }


                    
                    
                    cached

List of TimeRange indicating which data is currently cached.

Declaration

Swift

var cached: [TimeRange] { get }


                    
                    
                    secondsCached

The amount of content that has already been cached, in seconds.

Declaration

Swift

var secondsCached: Double { get }


                    
                    
                    percentageCached

The percentage of content that has already been cached, between 0 and 1.

Declaration

Swift

var percentageCached: Double { get }


                    
                    
                    bytesCached

The amount of bytes that have already been cached.

Declaration

Swift

var bytesCached: UInt { get }


                    
                    
                    bytes

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

Remark

Returns -1 if the estimate is not available yet.

Declaration

Swift

var bytes: Int { get }


                    
                    
                    start()

Starts downloading the stream and stores it on the device.

Remark

An element will only be cached if it is not yet present in the cache.

Declaration

Swift

func start()


                    
                    
                    remove()

Removes the task and tries to evict all associated streaming elements.

Remark

An element referenced by multiple tasks will only be evicted if all associated tasks are removed.

Declaration

Swift

func remove()


                    
                    
                    pause()

Pauses downloading the stream.

Remark

The cachingtask can be resumed later on through the use of the start() method.
This how-to-guide explains how to save the progress of a task and what the limitations are: https://docs.theoplayer.com/how-to-guides/07-miscellaneous/10-saving-cachingtask-progress-ios.md

Declaration

Swift

func pause()


                    
                    
                    move(to:)

Moves the downloaded stream assets to the specified URL.

Remark

Remark:

Using this method before the task is completed will throw an error.
To avoid errors, make sure that the URL is valid and that the directory exists.
It is advised by Apple to avoid this approach: https://developer.apple.com/documentation/avfoundation/avassetdownloaddelegate/urlsession(_:assetdownloadtask:didfinishdownloadingto:)?language=objc#Discussion
Limit the URL usage to the application’s sandbox directory. For more info check the iOS Standard Directories: Where Files Reside section at https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html
Please consult with THEOplayer support or engineering before usage.

Example:

guard let cachingTask,
     let destinationURL = FileManager.default.urls(
       for: .documentDirectory,
       in: .userDomainMask).first else { return }
do {
   try cachingTask.move(to: destinationURL)
} catch {
   print(error.localizedDescription)
}

Declaration

Swift

func move(to url: URL) throws


                    
                    
                    license

A controller for license related queries and operations.

Declaration

Swift

var license: CachingTaskLicense { get }


                    
                    
                    network

The Network API.

Declaration

Swift

var network: Network { get }


                    
                    
                    addEventListener(type:listener:)

Adds the event listener of the given EventType.

Remark

When attaching a listener on the wrong object, the application will crash.

Declaration

Swift

func addEventListener<E>(type: EventType<E>, listener: @escaping (E) -> ()) -> EventListener where E : EventProtocol

Parameters

`type`	`EventType` of the added event listener. See `CachingTaskEventTypes` for possible values.
`listener`	Closure called when event is dispatched.

Return Value

The newly added EventListener.


                    
                    
                    removeEventListener(type:listener:)

Removes the event listener of the given CachingTaskEventType.

Declaration

Swift

func removeEventListener<E>(type: EventType<E>, listener: EventListener) where E : EventProtocol

Parameters

`type`	`EventType` of the event listener to be removed. See `CachingTaskEventTypes` for possible values.
`listener`	`EventListener` which was added by `addEventListener(...)`