ThumbnailsApi

@objcMembers
@objc(BMPThumbnailsApi)
public class ThumbnailsApi : NSObject

Provides the means to interact and manage thumbnails. Accessible through Player.thumbnails.

This API is not supported during casting.

  • Declaration

    Swift

    public weak var _delegate: _ThumbnailsApiDelegate?

  • Returns the thumbnail image for the active Source at a certain time. Requires a configured ThumbnailTrack in the corresponding SourceConfig.

    This function returns nil in the following cases:

    • If there is no active source.
    • If the thumbnails were not loaded yet.
    • If there are no ThumbnailTracks provided in the corresponding SourceConfigs.

    • If there is no thumbnail available at the provided time.

    Declaration

    Swift

    public func thumbnail(forTime time: TimeInterval) -> Thumbnail?

    Parameters

    time

    The time for which the thumbnail should be returned.

    Return Value

    An instance of Thumbnail for the given time, or nil.