Classes

Create AirPlay client instance

BroadpeakMetadata

BroadpeakSettings

ChromecastMetadata

Create Chromecast client instance

Create Appium client instance

ConvivaMetadata

ConvivaSettings

Create IMA client instance

Create Mux client instance

MuxMetadata

Create IMA client instance

Create Thumbnails client instance

CastlabsVT

Create Youbora client instance

YouboraMetadata

YouboraSettings

BasePlayer implements all properties that are updated from the State and must be synchronised on ‘playerQueue’

Cross-component communication move outside factory

Default handler for phone call interruption

The meta-data class wraps and mandatory and optional meta-data that are send to various analytics backends.

The two parameters that are mandatory in all cases are live and assetId. The live flag needs to be set to true if the content is a live stream. Analytics backends usually require this information before playback starts. The assetId identifies the content uniquely within the analytics system.

The cast settings class wraps common settings for Chromecast appId is mandatory for casting.

Download

MediaDownloadProgress

DRM configuration used for protected playback.

This structure describes player configuration for a single asset.

ClearKey usage

guard let url = URL(string: "STREAM-URL") else { return }

let config = PlayerConfiguration(with: url)
config.contentType = .hls

let player = PRESTOplaySDK.shared.player()
player.open(config: config)

FairPlay usage

guard let url = URL(string: "STREAM-URL") else { return }

let config = PlayerConfiguration(with: url)
config.contentType = .hls
config.drmSystem = .fairplay
config.drmConfiguration = DrmConfiguration()
config.drmConfiguration?.environment = .production
config.drmConfiguration?.userId = "..."
config.drmConfiguration?.sessionId = "..."
config.drmConfiguration?.merchant = "..."
config.drmConfiguration?.assetId = "..."
config.drmConfiguration?.variantId = "..."

let player = PRESTOplaySDK.shared.player()
player.open(config: config)

Custom RequestModifier usage

Example showing custom FairPlay URLs.

guard let url = URL(string: "STREAM-URL") else { return }

let config = PlayerConfiguration(with: url)
config.contentType = .hls
config.drmSystem = .fairplay
config.drmConfiguration = DrmConfiguration()
config.drmConfiguration?.licensingUrl = URL(string: "LICENSING-URL")
config.drmConfiguration?.certificateUrl = URL(string: "CERTIFICATE-URL")

// Add request/response modifiers on SDK level.
PRESTOplaySDK.shared.requestModifiers.append(RequestModifier())
PRESTOplaySDK.shared.responseModifiers.append(ResponseModifier())

let player = PRESTOplaySDK.shared.player()
player.open(config: config)

Container that groups all available media tracks by type.

Video track metadata and available renditions.

Audio track metadata and available renditions.

Text track metadata (subtitles/captions) and rendering hints.

Base rendition metadata shared by audio/video rendition variants.

Audio-specific rendition type.

Video-specific rendition type with geometry/trickplay metadata.

DRM metadata attached to renditions.

CastlabsApple

The CMCD Configuration

Discussion: Apple uses predefined network sessions called URLSession. There is no way to create a dedicated URLSession for each Request. If ‘NetworkConfiguration’ is updated it will affect the whole URLSession, which is shared for all the HTTP/S requests in ‘NetworkEngine’.

Configuration for per-state timeouts of the player state machine. Values are in seconds. Use 0 to disable a timeout for a state.

HLS settings shared by the Apple HLS player and downloader.

The subtitles settings to customize subtitles rendering.

GridThumbnail

Used to define a request to download images and slice them into multiple thumbnails in a grid pattern. Each image will be sliced into smaller segments based on the gridWidth and gridHeight. E.g. if these are both set to 2, then the image will be divided into a 2 x 2 grid producing 4 equal sized thumbnails per image. The grid cells are ordered from left to right, then top to bottom.

Single or multiple images may be downloaded using this object. If maxIndex is greater than 1 and the pathTemplate contains the token index then multiple image urls can be specified. The final image urls which will be downloaded are specified by the baseUrl + the result of the pathTemplate substitution. The index token in pathTemplate will be substituted with the index 1 up to and including maxIndex. E.g. if pathTemplate where image_$index$.jpg and maxIndex were 3, then image_1.jpg, image_2.jpg, image_3.jpg would be generated from the substitution.

Each thumbnail will be displayed for durationMs with no gabs in between. Therefore thumbnails will cover a total timerange of durationMs multiplied by the total number of thumbnails generated.

Defines a single thumbnail image along with it’s timing information.

mack: I think this should be internal only