PRESTOplaySDK Class

public class PRESTOplaySDK

Main interface for initializing the SDK and additional plugins.

Public

  • Returns the globally shared SDK instance.

    Declaration

    Swift

    public static let shared: PRESTOplaySDK

  • NetworkConfiguration (if set) is applied to NetworkEngine

    Declaration

    Swift

    public var networkConfiguration: NetworkConfiguration?

  • When enabled, uses the redirect-resolved manifest URL as the base for segment downloads. Default is false to preserve legacy behavior.

    Declaration

    Swift

    public var useRedirectedManifestURLForDownloads: Bool

  • State timeout in seconds

    Throws .network_error with timeout message if the Player remains in .playing state for longer than this value without positive effective playback rate.

    The feature is enabled if value is greater than 0.0.

    Declaration

    Swift

    public var stateTimeout: Double

  • Report most recent error / warning

    Declaration

    Swift

    public var onError: ErrorHandler?

  • Returns the authentication key for the device. Client is responsible for implementing this method.

    Declaration

    Swift

    public var onDeviceAuthTokenRequired: AuthTokenHandler?

  • Returns the authentication key for AirPlay. Client is responsible for implementing this method.

    Declaration

    Swift

    public var onAirplayAuthTokenRequired: AuthTokenHandler?

  • Initialises the SDK. This method should be called before any other.

    Only the first call to this method is honoured. Subsequent calls are no-ops.

    Declaration

    Swift

    @available(*, deprecated, message: "Will be removed in 4.1.0, use `setup(﹚` instead.")
public func register(
    _ license: String,
    _ plugins: [CLPluginProtocol],
    _ companion: CompanionSDK? = nil
) -> LicenseCheck

    Parameters

    license

    License description.
    plugins

    Array of plugin to be enabled.
    companion

    Companion SDK metadata.

    Return Value

    InItialization result.

  • Initialises the SDK. This method should be called before any other.

    Only the first call to this method is honoured. Subsequent calls are no-ops.

    Declaration

    Swift

    public func setup(
    _ license: String,
    _ plugins: [CLPluginProtocol],
    _ companion: CompanionSDK? = nil
) -> PRESTOerror?

    Parameters

    license

    License description.
    plugins

    Array of plugin to be enabled.
    companion

    Companion SDK metadata.

    Return Value

    InItialization error, or nil if succeed.

  • Sets the logging verbosity.

    Declaration

    Swift

    public func setLogLevel(_ level: CLLogLevel)

    Parameters

    level

    Log level.

  • Creates player without configuration.

    Configuration can be loaded later with load method.

    Declaration

    Swift

    public func player() -> PlayerAPI

    Return Value

    Common player interface.

  • Creates player for given configuration.

    Declaration

    Swift

    public func player(for config: PlayerConfiguration) -> PlayerAPI?

    Parameters

    config

    Player configuration.

    Return Value

    Player instance.

  • Creates a PlayerViewControllerAPI instance with the channel items and analytics data.

    Declaration

    Swift

    @available(tvOS 15.0, *)
public func playerViewController(
    channels: [ChannelItem],
    analytics: [AnalyticsBackend?: AnalyticsMetadata]?,
    loopChannels: Bool
)
    -> PlayerViewControllerAPI?

    Parameters

    channels

    Array of channel items to be played.
    analytics

    AnalyticsBackend instance and the necessary metadata for analytics.
    loopChannels

    Loop the channel list at the first or last channel.

    Return Value

    An optional PlayerViewControllerAPI instance.

  • Creates DRM Prefetcher for given configuration.

    Declaration

    Swift

    public func prefetcher(for config: PlayerConfiguration) -> CLDrmPrefetcherAPI?

    Parameters

    config

    Player configuration.

    Return Value

    DRM prefetcher instance.

  • Creates downloader without configuration.

    Configuration can be loaded later with createDownload method.

    Declaration

    Swift

    public func downloader() -> DownloaderAPI

    Return Value

    Common downloader interface.

  • Sets the default playback rate range.

    Declaration

    Swift

    public func setPlaybackRateRange(of playerEngine: PlayerEngine, to range: ClosedRange<Double>)

    Parameters

    playerEngine

    Type of player engine.
    range

    Playback rate range.

  • Retrieves the playback rate range for the player engine type.

    Declaration

    Swift

    public func getPlaybackRateRange(of playerEngine: PlayerEngine?) -> ClosedRange<Double>?

    Parameters

    playerEngine

    Type of player engine.

    Return Value

    Playback rate range.

  • Initialises cast with cast settings.

    At this point authorisation requests are triggered if required.

    Declaration

    Swift

    public func cast(
    for castSettings: CastSettings
) -> CastAPI?

    Parameters

    castSettings

    Cast settings.

    Return Value

    Instance of cast.

  • Returns the cast client for a given session with player instance.

    Declaration

    Swift

    public func cast(
    forSession sessionId: String,
    engine castEngine: CastEngine? = CastEngine(rawValue: 0)
) -> CastAPI?

    Parameters

    sessionId

    Current session with player instance.
    castEngine

    Cast engine.

    Return Value

    Cast client.

  • Returns the cast client for a given player.

    Declaration

    Swift

    public func cast(
    for player: PlayerAPI,
    engine castEngine: CastEngine? = CastEngine(rawValue: 0)
) -> CastAPI?

    Parameters

    player

    Current player instance.
    castEngine

    Cast engine.

    Return Value

    Cast client.

  • Returns the Advertisements client.

    Declaration

    Swift

    public func ads(
    forSession sessionId: String,
    settings adsSettings: AdsSettings? = nil
) -> AdsAPI?

    Parameters

    sessionId

    Current session id with player instance.
    adsSettings

    Ad configuration. If nil, default configuration will be used

    Return Value

    Advertisment instance.

  • Returns the Advertisements client.

    Declaration

    Swift

    public func ads(
    for player: PlayerAPI,
    settings adsSettings: AdsSettings? = nil
) -> AdsAPI?

    Parameters

    player

    Current player instance.
    adsSettings

    Ad configuration. If nil, default configuration will be used

    Return Value

    Advertisment instance.

  • Creates an Analytics client for a given session with player and analytics backend.

    Declaration

    Swift

    public func analytics(
    forSession sessionId: String,
    _ backend: AnalyticsBackend? = nil
) -> AnalyticsAPI?

    Parameters

    sessionId

    Session identifier with existing player instance.
    backend

    Analytics backend.

  • Creates an Analytics client for a given player and analytics backend.

    Declaration

    Swift

    public func analytics(
    for player: PlayerAPI,
    _ backend: AnalyticsBackend? = nil
)
    -> AnalyticsAPI?

    Parameters

    player

    Player instance.
    backend

    Analytics backend.

  • Returns the Subtitles client for a given session with player instance.

    Declaration

    Swift

    public func subtitles(
    forSession sessionId: String,
    callbacksQueue: DispatchQueue? = nil
) -> SubtitlesAPI?

    Parameters

    sessionId

    Current session with the player instance.

    Return Value

    Subtitles client.

  • Returns the Subtitles client for a given player.

    Declaration

    Swift

    public func subtitles(
    for player: PlayerAPI,
    callbacksQueue: DispatchQueue? = nil
) -> SubtitlesAPI?

    Parameters

    player

    Current player instance.

    Return Value

    Subtitles client.

  • Returns the Thumbnails client for a given session with player instance.

    Declaration

    Swift

    public func thumbnails(
    forSession sessionId: String,
    engine thumbnailsEngine: ThumbnailsEngine = .castlabs
) -> ThumbnailsAPI?

    Parameters

    sessionId

    Session Id with player instance.

    Return Value

    Thumbnails client.

  • Returns the Thumbnails client for a given player.

    Declaration

    Swift

    public func thumbnails(
    for player: PlayerAPI,
    engine thumbnailsEngine: ThumbnailsEngine = .castlabs
) -> ThumbnailsAPI?

    Parameters

    player

    Current player instance.

    Return Value

    Thumbnails client.

  • Returns the playlist api client.

    Declaration

    Swift

    public func playlist(
    forSession sessionId: String,
    mode: PlaylistMode = .playerRecreate,
    loopList: Bool? = true
) -> PlaylistAPI?

    Parameters

    sessionId

    Session Id with player instance..
    mode

    Playlist mode.
    loopList

    Loops the playlist. Default is true. False value is effective only in .nativeQueue mode.

    Return Value

    Playlist manager instance.

  • Returns the playlist api client.

    Declaration

    Swift

    public func playlist(
    for player: PlayerAPI,
    mode: PlaylistMode = .playerRecreate,
    loopList: Bool? = true
) -> PlaylistAPI?

    Parameters

    player

    Current player instance.
    mode

    Playlist mode.
    loopList

    Loops the playlist. Default is true. False value is effective only in .nativeQueue mode.

    Return Value

    Playlist manager instance.