PlayerQueuable

public protocol PlayerQueuable

Protocol defining the player interface for managing playback queue.

  • An observable array of all items currently in the queue.

    Declaration

    Swift

    var allItems: Observable<[MediaPlaylistItem]> { get }
  • addAsset(mediaPlaylistRequestItem:) Default implementation

    Adds an item to the player queue.

    Default Implementation

    Declaration

    Swift

    func addAsset(mediaPlaylistRequestItem: MediaPlaylistRequestItem) -> Bool

    Parameters

    mediaPlaylistRequestItem

    The MediaPlaylistRequestItem to be added to queue

    Return Value

    A boolean value indicating the success/failure of the item addition.

  • addAssets(mediaPlaylistRequestItems:) Default implementation

    Adds multiple items to the player queue.

    Default Implementation

    Declaration

    Swift

    func addAssets(mediaPlaylistRequestItems: [MediaPlaylistRequestItem])

    Parameters

    mediaPlaylistRequestItems

    The list of MediaPlaylistRequestItem.
  • removeItem(item:) Default implementation

    Removes an item from the queue.

    Default Implementation

    Declaration

    Swift

    func removeItem(item: MediaPlaylistItem)

    Parameters

    item

    The item to be removed from the queue.
  • playNext() Default implementation

    Initiates playback of the next item in the queue.

    Default Implementation

    Declaration

    Swift

    func playNext()
  • playPrevious() Default implementation

    Initiates playback of the previous item in the queue.

    Default Implementation

    Declaration

    Swift

    func playPrevious()
  • play(item:) Default implementation

    Initiates playback of the specified item.

    Default Implementation

    Declaration

    Swift

    func play(item: MediaPlaylistItem)

    Parameters

    item

    The item to be played, which should already exist in allItems.
  • hasPreviousMediaPlaylistItem() Default implementation

    Checks if a previous item exists in the queue.

    Default Implementation

    Declaration

    Swift

    func hasPreviousMediaPlaylistItem() -> Bool

    Return Value

    A boolean value indicating whether a previous item exists.

  • hasNextMediaPlaylistItem() Default implementation

    Checks if a next item exists in the queue.

    Default Implementation

    Declaration

    Swift

    func hasNextMediaPlaylistItem() -> Bool

    Return Value

    A boolean value indicating whether a next item exists.