Overview

Pillarbox is the iOS and tvOS modern reactive SRG SSR player ecosystem implemented on top of AVFoundation and AVKit. Pillarbox has been designed with robustness, efficiency and flexibility in mind, with full customization of:

Metadata and asset URL retrieval.
Asset resource loading, including support for FairPlay.
Analytics and monitoring integration.
User interface layout in SwiftUI.

[!IMPORTANT] Even though Pillarbox offers features that are specific to our company, its player is fully generic and can be used to play any kind of content.

Features

Pillarbox player provides all essential playback features you might expect:

Audio and video (standard / monoscopic 360°) playback.
Support for on-demand and live streams (with or without DVR).
First-class integration with SwiftUI to create the stunning playback user experience that your application deserves.
Integration with the standard system playback user experience, both on iOS and tvOS.
Playlist management including bidirectional navigation.
Support for alternative audio tracks, Audio Description, subtitles, CC and SDH, all tightly integrated with standard system accessibility features.
Metadata and chapter support.
AirPlay compatibility.
Control center integration.
Multiple instance support.
Best-in-class Picture in Picture support.
The smoothest possible seek experience on Apple devices, with blazing-fast content navigation in streams enabled for trick play.
Playback speed controls.
Looping playback.
Monitoring with Pillarbox Quality of Experience (QoE) and Quality of Service (QoS) platform.

In addition Pillarbox provides the ability to play all SRG SSR content through a dedicated package.

Showcase

Here are a few examples of layouts which can be achieved using Pillarbox and SwiftUI, directly borrowed from our demo project:

From left to right:

Screenshots 1, 2 and 3: Rich custom player user interface.
Screenshot 4: Player with associated playlist.
Screenshot 5: Stories.
Screenshot 6: Custom chapter navigation.

Compatibility

The library is suitable for applications running on iOS 16, tvOS 16 and above.

Integration

The library can be integrated using Swift Package Manager directly within Xcode. You can also declare the library as a dependency of another one directly in the associated Package.swift manifest.

If you want your application to run on Silicon Macs as an iPad application you must add -weak_framework MediaPlayer to your target Other Linker Flags setting.

Documentation

Pillarbox documentation includes articles, tutorials and an API reference to help you learn more about available features and how to integrate them into your application.

[!TIP] If you discover errors in the documentation or if some documentation is missing please file a dedicated issue. You can also directly submit documentation improvements via pull requests.

DocC documentation

Documentation is available as a DocC documentation catalog. This catalog must be built by opening the project with Xcode and selecting Product > Build Documentation. You can then access it right from within the Xcode documentation window.

Online documentation

Documentation for each major product provided by Pillarbox can also be found online on Swift Package Index:

Player: Create engaging audio and video playback experiences.
CoreBusiness: Play SRG SSR content with the Player framework.
Monitoring: Monitor playback activity.
Analytics: Measure app usage according to SRG SSR requirements.

Documentation is also available for companion products:

Core: Essential tools used when implementing Pillarbox.
Circumspect: A Nimble-based framework for testing Combine publishers.

[!TIP] Documentation available from the above links opens for the latest tag. Use Swift Package Index navigation top bar to quickly switch to another tag or main.

Miscellaneous documentation

Further documentation is also available by following the links below:

Plugins

The package provides a single plugin which automatically inserts correct versioning information into binaries. This plugin must be trusted interactively when a project integrating Pillarbox is built using Xcode for the first time.

On a continuous integration server you must trust plugins automatically by setting an appropriate default:

defaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YES

If you are using Xcode Cloud this can be achieved with a custom build script.

If your project is built with xcodebuild directly the same effect can be achieved by passing the -skipPackagePluginValidation option.

Code example

With Pillarbox creating a custom video player user interface has never been easier. Simply instantiate a Player and start building your user interface in SwiftUI right away:

import PillarboxPlayer
import SwiftUI

struct PlayerView: View {
    @StateObject private var player = Player(
        item: .simple(url: URL(string: "https://devstreaming-cdn.apple.com/videos/streaming/examples/img_bipbop_adv_example_ts/master.m3u8")!)
    )

    var body: some View {
        ZStack {
            VideoView(player: player)
            Button(action: player.togglePlayPause) {
                Image(systemName: player.shouldPlay ? "pause.circle.fill" : "play.circle.fill")
                    .resizable()
                    .frame(width: 80, height: 80)
            }
        }
        .onAppear(perform: player.play)
    }
}

With the expressiveness of SwiftUI, our rich playback API and the set of components at your disposal you will have a full-fledged player user interface in no time.

Contributing

If you want to contribute to the project have a look at our contributing guide.

License

See the LICENSE file for more information.

SRGSSR / pillarbox-apple

readme