Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 2.4 KB

README.md

File metadata and controls

47 lines (27 loc) · 2.4 KB
Raw

FireworkVideo Agora Supporting Library

About

A supporting library for the Agora Interactive Live Streaming SDK for use with FireworkVideo live stream multi-host playback. Using this library enables low latency multi-host live streaming.

Agora Interactive Live Streaming SDK Documentation

This supporting library assumes basic familiarity with Agora. If needed, read over the Agora Documentation before diving in.

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 Agora SDK.

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

Setup

  1. Add FireworkVideoSDK to your project; follow the Firework Video installation instructions.
  2. Add FireworkVideoAgoraSupporting library to your project; follow the instructions below.

Installation

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

Note: you can also install the library via Cocoapods pod 'FireworkVideoAgoraSupport'

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

  1. Add project permissions to your Info.plist for microphone (NSMicrophoneUsageDescription) and camera usage (NSCameraUsageDescription)

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.enableMultiHostPlayback()

        return true
    }

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