CachingTask

public protocol CachingTask : EventDispatcherProtocol

Represents a caching task.

  • id

    The identifier of the task.

    Declaration

    Swift

    var id: String { get }

  • The current CachingTaskStatus.

    Declaration

    Swift

    var status: CachingTaskStatus { get }

  • The SourceDescription processed by this caching task.

    Declaration

    Swift

    var source: SourceDescription { get }

  • 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 }

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

    Declaration

    Swift

    var duration: Double { get }

  • List of TimeRange indicating which data is currently cached.

    Declaration

    Swift

    var cached: [TimeRange] { get }

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

    Declaration

    Swift

    var secondsCached: Double { get }

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

    Declaration

    Swift

    var percentageCached: Double { get }

  • The amount of bytes that have already been cached.

    Declaration

    Swift

    var bytesCached: UInt { get }

  • 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()

  • 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()

  • Pauses downloading the stream.

    Remark

    Declaration

    Swift

    func pause()

  • A controller for license related queries and operations.

    Declaration

    Swift

    var license: CachingTaskLicense { get }

  • 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.

  • 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(...)