Getting Started (Flutter)
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
Latest version release notes
Firework App Id
Flutter SDK >=3.0.0
Dart SDK >=2.17.0
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
Installing Firework Flutter SDK requires the following step:
Install Flutter plugin package
Setup Native project
flutter pub add fw_flutter_sdk
Run pod install
in the root directory of the iOS project. And if you encountered the following issues, you could run pod repo update && pod update FireworkVideo FireworkVideoUI
in the root directory of the iOS project.
CocoaPods could not find compatible versions for pod "FireworkVideo"
CocoaPods could not find compatible versions for pod "FireworkVideoUI"
build.gradle
buildscript {
repositories {
...
// This should be added
mavenCentral()
}
dependencies {
// We suggest the Gradle plugin version greater or equal to 7.4.2.
classpath("com.android.tools.build:gradle:7.4.2")
...
}
}
allprojects {
repositories {
...
mavenCentral()
}
}
gradle-wrapper.properties
...
# We suggest the Gradle version greater or equal to 7.5.
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-all.zip
...
app/src/.../MainActivity.kt
The MainActivity should extend FlutterFragmentActivity.
class MainActivity: FlutterFragmentActivity()
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 'androidx.appcompat:appcompat:1.6.1'
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")
}
}
}
Include the app ID in your app Info.plist
file using the key FireworkVideoAppID
.
See the image below:
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>
Import fw_flutter_sdk
and call FWFlutterSDK.initializeSDK()
in application(:, didFinishLaunchingWithOptions:) -> Bool
// Import Firework Flutter SDK
import fw_flutter_sdk
@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
override func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
GeneratedPluginRegistrant.register(with: self)
// Call SDK initialization method
FWFlutterSDK.initializeSDK(nil)
return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}
}
We support passing an option to the SDK initialization method. The sample codes are:
FWFlutterSDK.initializeSDK(
SDKInitOptions(
videoLaunchBehavior: .muteOnFirstLaunch // or .default
)
)
The SDK init option structure is:
public struct SDKInitOptions: Codable {
public var userId: String?
public var videoLaunchBehavior: FWFVideoLaunchBehavior?
public init(userId: String? = nil, videoLaunchBehavior: FWFVideoLaunchBehavior? = nil) {
self.userId = userId
self.videoLaunchBehavior = videoLaunchBehavior
}
}
Step 1: Add the FWFlutterSDK.init(this)
method to your FlutterApplication class.
class MainApplication: FlutterApplication() {
override fun onCreate() {
super.onCreate()
// ...
FWFlutterSDK.init(this)
// ...
}
}
// If you have the modules below, you need to add the modules before the SDK init method
// FWFlutterSDK.addLivestreamPlayerInitializer(SingleHostLivestreamPlayerInitializer())
// FWFlutterSDK.addLivestreamPlayerInitializer(MultiHostLivestreamPlayerInitializer())
// FWFlutterSDK.setImageLoader(GlideImageLoaderFactory.createInstance(this))
// FWFlutterSDK.setImageLoader(PicassoImageLoaderFactory.createInstance(this))
FWFlutterSDK.init(this)
We support passing an option to the SDK initialization method. The sample codes are:
FWFlutterSDK.init(
this,
FWSDKInitOptionsModel(
// or FWPlayerLaunchBehavior.Default
videoLaunchBehavior = 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.
Call FireworkSDK.getInstance().markInitCalled()
on the Dart side.
import 'package:fw_flutter_sdk/fw_flutter_sdk.dart';
/// Optional: set listener for SDK init
FireworkSDK.getInstance().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 Dart side.
FireworkSDK.getInstance().markInitCalled();
Please don't call FireworkSDK.getInstance().init()
on the Dart side anymore.
To ensure compliance with Apple privacy guidelines and regulations, we don't track data if users don't allow it. Please refer to ATT compliance Flutter (iOS).
If you want to integrate the video feed, please follow the instruction here.
If you want to integrate the story block, please follow the instruction here.
If you want to customize SDK, please refer to Customization.
If you want to integrate the live stream, please follow the instruction here.
If you want to integrate video shopping, please follow the instruction here.
If you want to integrate video shopping, please follow the instruction here.
We provide a sample project on Github.