Skip to content

Latest commit

 

History

History
88 lines (65 loc) · 4.4 KB

README.md

File metadata and controls

88 lines (65 loc) · 4.4 KB
Raw

BitmovinPlayerCore

The BitmovinPlayerCore package is the standalone Player without additional dependencies to other modules such as BitmovinAnalytics.

Installation

To add the BitmovinPlayerCore SDK as a dependency to your project, you have three options: Using CocoaPods, Swift Package Manager or adding the SDK bundle directly.

Using CocoaPods

Add the following lines to the Podfile of your project and replace the Version Number with the desired version of BitmovinPlayerCore. All available versions from 3.77.0 on are listed in the Cocoapods trunk repository (earlier versions are listed in our CocoaPods repository instead).

Execute pod install to install the new BitmovinPlayerCore dependency.

pod 'BitmovinPlayerCore', '3.77.1-a.4'

Using Swift Package Manager

Swift Package Manager is a tool for managing the distribution of Swift frameworks. It integrates with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

Using Xcode

To integrate using Xcode 14, open your Project file and specify it in Project > Package Dependencies using the following URL:

https://github.com/bitmovin/player-ios-core.git

Using Package.swift

To integrate using Apple's Swift Package Manager, add the following as a dependency to your Package.swift and replace Version Number with the desired version of the SDK.

.package(url: "https://github.com/bitmovin/player-ios-core.git", exact: "Version Number")

And then specify the BitmovinPlayerCore as a dependency of the desired target. Here is an example of a Package.swift file:

let package = Package(
  ...
  dependencies: [
    ...
    .package(url: "https://github.com/bitmovin/player-ios-core.git", exact: "Version Number")
  ],
  targets: [
    .target(
      name: "<NAME_OF_YOUR_PACKAGE>", 
      dependencies: [
        .product(name: "BitmovinPlayerCore", package: "player-ios-core")
      ]
    )
  ]
  ...
)
Limitation

Executing swift build from the command line is currently not supported. Open the Package in Xcode if you are developing another Package depending on BitmovinPlayerCore.

Add the Player SDK to the Project directly

When using Xcode, go to the General page or your app target and add the SDK bundle (BitmovinPlayerCore.xcframework) under Linked Frameworks and Libraries. The latest SDK for iOS and tvOS can be downloaded here.

Getting Started

Configure the license key

  • Add your Bitmovin Player license key to the Info.plist file as BitmovinPlayerLicenseKey. Alternatively, you can also set the license key via the PlayerConfig.key property when creating a Player instance.

    Your Bitmovin Player license key can be found under Player -> Licenses in the Bitmovin Dashboard.

  • Add the Bundle Identifier of the iOS application which is using the SDK as an allowed domain to the Bitmovin licensing backend. This can be also done under Player -> Licenses via the Bitmovin Dashboard.

Samples

For samples using the Bitmovin Player iOS SDK see here. For a sample using the Swift Package Manager for integration, see sample named BasicPlaybackSPM.

Documentation and Resources

  • You can find a full getting started guide including examples here.
  • You can find the latest API documentation here.
  • The release notes can be found here.