Plugin for Apple AVPlayer

Not into tutorials?

Project setup

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects.

Note
Cocoapods 1.6.0 + is recommended

To integrate AVPlayerDNAPlugin into your Xcode project using CocoaPods, specify this in your Podfile:

use_frameworks!
pod 'AVPlayerDNAPlugin', '~> 1.1.6'

Carthage

Add the dependencies to the Cartfile:

binary "https://sdk.streamroot.io/ios/StreamrootSDK.json" ~> 3.10.1
binary "https://sdk.streamroot.io/ios/AVPlayerDNAPlugin.json" ~> 1.1.6
github "daltoniam/Starscream" ~> "3.1.0"
github "getsentry/sentry-cocoa" ~> "4.3.1"
github "apple/swift-protobuf" ~> "1.4.0"

Link the frameworks to your project:

Code

Set the streamrootKey

In the Project Navigator, right click on "Info.plist", and "Open as" → "Source Code".

Add the following lines with the right parameters values:

<key>Streamroot</key>
<dict>
  <key>Key</key>
  <string>yourStreamrootKey</string>
</dict>

Here, <streamroot-key> refers to your Streamroot key that you will find in the Account section of the Streamroot Dashboard. If you don't have a Streamroot Key, you can register for a free trial account on our website.

Import the plugin

import AVPlayerDNAPlugin

Start and link the plugin to the player

do {
    dnaPlugin = AVPlayerDNAPlugin(manifestUrl: <#ManifestUrl#>)
    if let localPath = try dnaPlugin?.start() {
        player = AVPlayer(url: localPath)
        try dnaPlugin?.linkPlayer(player)
        player?.play()
    }
} catch let error {
    // handle error
}

<#ManifestUrl#> refers to the HLS .m3u8 master playlist URL.

Add custom options

The plugin can be started with an optional configuration.

let config = DNAConfig()
config.streamrootKey = <#YourStreamrootKey#>
config.latency = 30
config.contentId = <#ContentId#>
config.property = <#Property#>

To get the best offload capacity, we recommend setting 30s for latency.

In order to improve the DNA traffic offload, different buffer levels will be setted for each player.

Here, we will distribute the buffer target between 10 and the latency set above (30s recommended).

And then, start and link the plugin to the player

do {
    dnaPlugin = AVPlayerDNAPlugin(manifestUrl: <#ManifestUrl#>, config: config)
    if let localPath = try dnaPlugin?.start() {
        player = AVPlayer(url: localPath)
        try dnaPlugin?.linkPlayer(player)
        player?.play()
    }
} catch let error {
    // handle error
}

Stop the plugin

dnaPlugin?.stop()

Disable App Transport security