Getting Started

Latest version release notes

Prerequisites

  • Firework App Id

  • React Native 0.60 or greater.

  • iOS project

    • iOS 13 or greater.

    • Xcode 14 or greater.

    • Swift 5.7 or greater.

  • Android Project

    • JAVA_HOME 1.8 or greater

    • minSdkVersion 21 or greater

    • compileSdkVersion 31 or greater

    • targetSdkVersion = 31 or greater

    • kotlinVersion 1.8.0 or greater

Installation

Installing Firework React Native SDK requires the following step:

  1. Install NPM package

  2. Setup Native project

Install NPM Package

npm install react-native-firework-sdk
#or
yarn add react-native-firework-sdk

Setup Native Project

iOS

Run pod install in the root directory of the iOS project. And we also need to re-run pod install when upgrading the RN SDK version.

Android

  • build.gradle

buildscript {
  repositories {
    ...
    // This should be added
    mavenCentral()
  }
  dependencies {
    // We don’t require Gradle plugin version. Just an example.
    classpath("com.android.tools.build:gradle:4.2.2")
    ...
  }
}

allprojects {
  repositories {
    ...
    mavenCentral()
  }
}
  • gradle-wrapper.properties

...
# We don’t require Gradle version. Just an example.
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-all.zip
...
  • app/build.gradle

...
apply from: 'firework.gradle'
  • add android:windowSoftInputMode="adjustPan" to the file app/src/Androidmanifest.xml if there is a story block in your app and use the live stream

    <application
        android:name=".MainApplication"
        ...>
        <activity
            android:name=".MainActivity"
            ...
            android:windowSoftInputMode="adjustPan">
        </activity>
    </application>
  • New file: app/firework.gradle

android {
  packagingOptions {
    exclude 'META-INF/*.kotlin_module'
  }
}

dependencies {
  implementation "com.firework:sdk:+"
  // Uncomment the next line if you want to integrate the single-host live stream
  // implementation "com.firework.external.livestream:singleHostPlayer:+"
  // Uncomment the next line if you want to integrate the multi-host live stream
  // implementation "com.firework.external.livestream:multiHostPlayer:+"
}

configurations.all {
  resolutionStrategy.eachDependency { details ->
    if (details.requested.group == 'com.firework' && details.requested.name == 'sdk') {
      details.useVersion rootProject.ext.get("fwNativeVersion")
    }
    if (details.requested.group == 'com.firework.external.livestream' && details.requested.name == 'singleHostPlayer') {
      details.useVersion rootProject.ext.get("fwNativeVersion")
    }
    if (details.requested.group == 'com.firework.external.livestream' && details.requested.name == 'multiHostPlayer') {
      details.useVersion rootProject.ext.get("fwNativeVersion")
    }
  }
}

App Id Configuration

iOS

Include the app ID in your app Info.plist file using the key FireworkVideoAppID .

See the image below:

Android

Include the appid in your app AndroidManifest.xml file, like below:

  <application
    ...
  >
    <activity .../>
    ...
    
    // Include the app ID
    <meta-data
      android:name="Firework:Appid"
      android:value="your firework appid" />
  </application>

SDK Initialization

iOS

In your iOS project, you need to call FWReactNativeSDK.initializeSDK(nil) in application(:, didFinishLaunchingWithOptions:) -> Bool method.

import react_native_firework_sdk

func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
    FWReactNativeSDK.initializeSDK(nil)
    
    return true
}

If your AppDelegate class is written by Objective-C, you should create a Swift file to call the API. For example, you could create FireworkSupportLibraryBridge.swift and add the following codes.

import react_native_firework_sdk

@objc
public class FireworkSupportLibraryBridge: NSObject {
  @objc public static func initFireworkSDK() {
      FWReactNativeSDK.initializeSDK(nil)
  }
}

Then add [FireworkSupportLibraryBridge initFireworkSDK]; on application:didFinishLaunchingWithOptions: method.

// You should change the file to Objective-C Generated Interface Header name.
// Generally, it's "{TargetName}-Swift.h"
#import "FireworkSdkExample-Swift.h"

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [FireworkSupportLibraryBridge initFireworkSDK];
  return YES;
}

iOS initialization options

We support passing an option to the SDK initialization method. The sample codes are:

FWReactNativeSDK.initializeSDK(
    SDKInitOptions(
        videoLaunchBehavior: .muteOnFirstLaunch
    )
)

The SDK init option structure is:

public struct SDKInitOptions: Codable {
    public var userId: String?
    public var videoLaunchBehavior: FWRVideoLaunchBehavior?
    public init(userId: String? = nil, videoLaunchBehavior: FWRVideoLaunchBehavior? = nil) {
        self.userId = userId
        self.videoLaunchBehavior = videoLaunchBehavior
    }
}

Android

Step 1: Add the FWReactNative.init method to your MainApplication class.

class MainApplication: xxxx {

  override fun onCreate() {
    super.onCreate()
    // ...
    FWReactNativeSDK.INSTANCE.init(
      this,
      new FWSDKInitOptionsModel(null, FWPlayerLaunchBehavior.MuteOnFirstLaunch)
    );
    // ...
  }
}
    // If you have the modules below, you need to add the modules before the SDK init method
    //    FWReactNativeSDK.INSTANCE.addLivestreamPlayerInitializer(new SingleHostLivestreamPlayerInitializer());
    //    FWReactNativeSDK.INSTANCE.addLivestreamPlayerInitializer(new MultiHostLivestreamPlayerInitializer());
    //    FWReactNativeSDK.INSTANCE.setImageLoader(GlideImageLoaderFactory.INSTANCE.createInstance(this));
    //    FWReactNativeSDK.INSTANCE.setImageLoader(PicassoImageLoaderFactory.INSTANCE.createInstance(this));

    FWReactNativeSDK.INSTANCE.init(
      this,
      new FWSDKInitOptionsModel(null, FWPlayerLaunchBehavior.MuteOnFirstLaunch)
    );

Android initialization options

We support passing an option to the SDK initialization method. The sample codes are:

    FWReactNativeSDK.INSTANCE.init(
      this,
      new FWSDKInitOptionsModel(null, FWPlayerLaunchBehavior.MuteOnFirstLaunch)
    );

The SDK init option structure is:

data class FWSDKInitOptionsModel(
  val userId: String? = null,
  val videoLaunchBehavior: FWPlayerLaunchBehavior? = null,
)

Step 2: Please check the Inject Image Loader section. Choose an image loader(Glide or Picasso) that works for you. If you're not sure which one to use, Glide image loader is recommended.

JS

Call FireworkSDK.getInstance().markInitCalled() on the JS side.

import FireworkSDK from 'react-native-firework-sdk';

/*
  Optional: set listener for SDK init
*/
FireworkSDK.getInstance().onSDKInit = (event) => {
  console.log('onSDKInit', event);
};

/* 
  Although we call the initialization method on the native side,
  we also need to mark the initialization method as being called on the JS side.
*/
FireworkSDK.getInstance().markInitCalled();

Please don't call FireworkSDK.getInstance().init() on the JS side anymore.

Video Feed

If you want to integrate a video feed, please follow the instruction here.

Shopping

If you want to integrate video shopping, please follow the instruction here.

Sample Project

We provide a sample project on Github.

Last updated