FireworkVideo IVS Supporting Library

About

A supporting library for the Amazon IVS SDK for use with FireworkVideo live stream playback. Using this library enables low latency live streaming.

Amazon IVS SDK Documentation

This supporting library assumes basic familiarity with Amazon IVS. If needed, read over the IVS User Guide before diving in.

The supporting library only supports IVS SDK 1.8.3 or higher. Using the supporting library alongside a version of IVS SDK below 1.8.3 may result in undefined behavior.

FireworkVideo SDK Documentation

This supporting library is intended to be used alongside FireworkVideo SDK. Read over the FireworkVideo SDK documentation and sample code to ensure smooth integration with IVS SDK.

Ensure your Firework content is configured and apply correct styling and/or layout before integrating the IVS supporting library. This will ensure your testing conditions will match your production environment.

The supporting library only supports FireworkVideoSDK v1.2.0 or higher

Setup

1. Add FireworkVideoSDK to your project; follow the Firework Video installation instructions.
2. Add Amazon IVS SDK to your project; follow the Amazon IVS installation instructions.
3. Add FireworkVideoIVSSupporting library to your project; follow the instructions below.

Installation

Swift Package Manager is the recommended way to install the FireworkVideo IVS Supporting Library.

Note: alternatively you can download the binary directly and install it manually.

Using the SDK

Set up the SDK alongside FireworkVideo as soon as possible after app launch. See below code snippet.

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // First initialize the FireworkVideoSDK
        FireworkVideoSDK.initializeSDK()
        
        FireworkVideoSDK.enableIVSPlayback()
        
        return true
    }

FireworkVideo after both SDKs are initialized, FireworkVideo will make internal requests to the supporting library as determined by the Firework configuration for your App ID.