THEOplayerSDK

THEOplayerSDK brings the universal video player solution created by THEO Technologies to iOS and tvOS, enabling you to quickly deliver cross-platform content playback.

Prerequisites

Cocoapods

You must have Cocoapods installed. You can install Cocoapods by following the Cocoapods Installation Guide or by using Brew.

THEOplayer license

You must have a valid THEOplayer license. Request your license via https://portal.theoplayer.com where you can create a THEOplayer iOS SDK. After creating an iOS SDK, you can copy its license string to your clipboard as demonstrated in the screenshot below. You must use this license string when setting up THEOplayer.

Included features

THEOplayerSDK consists of modular features. This package includes only the basic features: hls, ui and airplay.
Additional feature sets will be provided in the future.

Alternatively, you can make your own custom build via our THEOportal.

Installation

It's considered good practice to run pod repo update before adding new pods to your Podfile.
This will help find newly added pods by updating the list of references to the public spec repos.
If you just installed Cocoapods or are already up-to-date, then this step can be skipped.

Add pod 'THEOplayerSDK-basic', '~> 2.82' similar to the following to your Podfile:

target 'MyApp' do
  pod 'THEOplayerSDK-basic', '~> 2.82'
end

Note that you can omit ~> 2.82 to get the latest published version of the THEOplayerSDK.

Then, using the terminal navigate to the directory where your Podfile is located and run:

pod install

Note that versions earlier than 2.82.0 (release 2021.1.2) are not available on the public Cocoapods registry.
Earlier versions are available through our THEOportal.

Usage

Import the THEOplayerSDK framework to your swift file:

import THEOplayerSDK

Next, create a player instance using one of the THEOplayer initializers and give it a frame and a source.

The next two examples demonstrate how you can setup THEOplayer through UIKit and SwiftUI. Note the "your_license_here" placeholder in these two examples. You want to replace this string with the license string mentioned in the "Prerequisites".

UIKit

This is how the code will look like in a UIKit based app's View Controller:

class ViewController: UIViewController {
    var playerConfig = THEOplayerConfiguration(pip: PiPConfiguration(), license: "your_license_here")
    var player = THEOplayer(configuration: playerConfig)

    func setupPlayer() {
        let playerFrame = CGRect(x: 0, y: 0, width: 320, height: 180)
        let source = "https://cdn.theoplayer.com/video/big_buck_bunny/big_buck_bunny.m3u8"
        let mimeType = "application/x-mpegurl"

        player.frame = playerFrame
        player.center = view.center
        player.source = SourceDescription(source: TypedSource(src: source, type: mimeType))
    }

    override func viewDidLoad() {
        super.viewDidLoad()

        setupPlayer()
        player.addAsSubview(of: self.view)
    }
}

Note that the player variable is declared as a property of the ViewController class.
This is required to maintain a strong reference to the player object.

SwiftUI

This is how the code will look like in a SwiftUI based app's Content View:

struct THEOplayerWrapper: UIViewRepresentable {
    var playerConfig = THEOplayerConfiguration(pip: PiPConfiguration(), license: "your_license_here")
    var player = THEOplayer(configuration: playerConfig)

    func setupPlayer() {
        let playerFrame = CGRect(x: 0, y: 0, width: 320, height: 180)
        let source = "https://cdn.theoplayer.com/video/big_buck_bunny/big_buck_bunny.m3u8"
        let mimeType = "application/x-mpegurl"

        player.frame = playerFrame
        player.source = SourceDescription(source: TypedSource(src: source, type: mimeType))
    }

    func makeUIView(context: Context) -> UIView {
        setupPlayer()
        let playerView = UIView()
        player.addAsSubview(of: playerView)
        return playerView
    }

    func updateUIView(_ uiView: UIView, context: Context) {
        // make necessary updates
    }
}

struct ContentView: View {
    var body: some View {
        VStack {
            Text("THEOplayer Sample")
            THEOplayerWrapper()
        }
    }
}

That's it! You should now have a working player in your application.

Documentation

The documentation for THEOplayer is located on our documentation website. For an example on how to setup THEOplayer, take a look at our Getting started guide.

Support

If you are having issues installing or using the package, first look for existing answers on our documentation website, and in particular our FAQ.

You can also contact our technical support team by following the instructions on our support page. Note that your level of support depends on your selected support plan.

FAQ

Why am I getting No such module 'THEOplayerSDK' (or similar errors)?

This could be due to a couple of reasons:

• You incorrectly configured your Podfile, or forgot to run pod install --repo-update to install your Podfile.
• You used an older version of Cocoapods. You can check your version through pod --version. Run (sudo) gem install cocoapods to upgrade to the latest version.
• You opened your xcodeproj instead of your xcworkspace. (Open your xcworkspace instead!)
• Xcode is being weird. Close your Workspace, uninstall your pods through pod deintegrate, and install them again through pod install --repo-update.

License

The contents of this package are subject to the THEOplayer license.