Firework for Developers
One-to-one Virtual ShoppingBusiness Portal
  • Welcome to Firework for Developers
  • Firework Interactive Video and One-to-many Digital Showroom
  • Web
    • Getting Started (Web)
      • Shopify
      • Magento
      • Wordpress (WooCommerce)
      • Salesforce Commerce Cloud
      • BigCommerce
    • Integration Guide for Web
      • Components
        • Hero Unit
        • Carousel / Grid
        • Storyblock (Web)
        • Player (Floating)
        • Storylink
      • Styling
      • Feed Attributes
      • Player
        • Configuration
          • Appearance
      • Video customization
        • Video Factory
        • CTA Button
        • Product cards
      • Events
        • Embed Feed and Storyblock Events
        • Video player events
        • Live stream events
        • Shopping events
      • Shopping Integration (V2)
        • Introduction
        • Shopping APIs
        • Product Hydration
        • Product Factory
        • Cart Sync
        • Tracking
          • Purchase
          • Add to cart
          • Remove from cart
          • Page viewed
        • Shopping Integration FAQ
        • Migrate from V1
      • Web SDK
      • Enhanced Picture-in-Picture
      • Privacy settings
        • Tracking settings
        • Cookies management
        • Content Security Policy
    • Telemetry console
    • Firework Service Domains
    • FAQ & Troubleshooting (Web)
  • Android SDK
    • Integration Guide for Android SDK
      • Getting Started (Android)
      • Video Feed (Android)
        • Video Feed Layouts (Android)
        • Channel Feed (Android)
        • Discover Feed (Android)
        • Playlist Feed (Android)
        • Dynamic Content Feed
        • Channel Hashtags Feed
        • Sku Feed
        • Single Content Feed
        • Configure Video Feed
      • Customization
        • CTA
      • Analytics (Android)
      • Shoppable Videos (Android)
        • Product Hydration
      • Live Stream Support (Android)
      • Video Player (Android)
      • StoryBlock (Android)
      • Share & Video Deep linking
      • Ad Support (Android)
      • Configure Video Advertisements Source (Android)
      • In-app Language Switches
      • Compose support(Android)
    • Sample App (Android)
    • FAQ & Troubleshooting (Android)
    • Changelog (Android)
  • iOS SDK
    • Integration Guide for iOS SDK
      • Getting Started (iOS)
      • ATT compliance (iOS)
      • Video Feed (iOS)
        • Discover Feed(iOS)
        • Channel Feed (iOS)
        • Playlist Feed (iOS)
        • Playlist Group Feed (iOS)
        • Dynamic Content (iOS)
        • Hashtag Playlist (iOS)
        • SKU Playlist (iOS)
        • Video Ads (iOS)
        • Video Feed Layouts (iOS)
      • Story Block (iOS)
      • Customization (iOS)
        • Video feed configurations (iOS)
        • Player configurations (iOS)
        • Shopping configurations (iOS)
          • Customize product card on videos using the custom view (iOS)
        • Customize click behaviors (iOS)
      • Shopping (iOS)
      • Live Stream Support (iOS)
      • Analytics (iOS)
      • Share & Deeplinking(iOS)
      • Ad Support (iOS)
    • Sample App (iOS)
    • FAQ & Troubleshooting (iOS)
    • Changelog (iOS)
  • React Native SDK
    • Integration Guide for React Native SDK V2
      • Getting Started (React Native)
      • ATT compliance React Native (iOS)
      • Video Feed (React Native)
      • Story Block (React Native)
      • Customization (React Native)
        • Video feed configurations (React Native)
        • Player configurations (React Native)
        • Shopping configurations (React Native)
          • Customize product card on videos using the custom view (React Native)
        • Customize click behaviors (React Native)
      • Shopping (React Native)
      • Live Stream Support (React Native)
      • Ad Support (React Native)
      • Analytics (React Native)
      • App-level Language Setting (React Native)
      • Share & Video Deeplinking (React Native)
      • Android Style (React Native)
      • Inject Android Image Loader (React Native)
      • Integrate SDKs in Hybrid React Native and native Apps
      • Reference (React Native)
      • Sample App (React Native)
      • FAQ & Troubleshooting (React Native)
      • Changelog (React Native)
  • Flutter SDK
    • Integration Guide for Flutter SDK V2
      • Getting Started (Flutter)
      • ATT compliance Flutter (iOS)
      • Video Feed (Flutter)
      • Story Block (Flutter)
      • Customization (Flutter)
        • Video feed configurations (Flutter)
        • Player configurations (Flutter)
        • Shopping configurations (Flutter)
          • Customize product card on videos using the custom view (Flutter)
        • Customize click behaviors (Flutter)
      • Live Stream Support (Flutter)
      • Shopping (Flutter)
      • Ad Support (Flutter)
      • Analytics (Flutter)
      • App-level Language Setting (Flutter)
      • Share & Video Deeplinking (Flutter)
      • Inject Android Image Loader (Flutter)
      • Android Style (Flutter)
      • Integrate SDKs in Hybrid Flutter and native Apps
      • Reference (Flutter)
      • Sample App (Flutter)
      • FAQ & Troubleshooting (Flutter)
      • Changelog (Flutter)
  • Help Articles
    • Importing Products to Firework
    • Adding products to a video
    • Displaying product videos on product pages using hashtag filtering(Web)
    • Syncing Carts
    • Encoded IDs
Powered by GitBook
On this page
  • About
  • Requirements
  • Obtain your Client ID
  • How to integrate Firework Android SDK?
  • Setup your project

Was this helpful?

  1. Android SDK
  2. Integration Guide for Android SDK

Getting Started (Android)

PreviousIntegration Guide for Android SDKNextVideo Feed (Android)

Last updated 3 months ago

Was this helpful?

-

The latest version

About

Firework Android SDK is a library that provides a set of programming interfaces that enable developers to integrate video feeds from Firework - a shoppable video and Livestream platform - into an Android app.

Requirements

Firework Android SDK is compatible with the following:

  • Android min SDK 21

  • Kotlin/Java code base

  • Gradle build system

Obtain your Client ID

To integrate Firework Android SDK into your application, you have to register your application with the Firework platform and get a unique client ID. To get the client ID:

  • Provide your application's package name to the business team/engineering team you are coordinating with.

  • You will receive via email the client ID and then follow the setup steps below under Firework IDs to include both in your app.

The client ID is used to authenticate your application with the server. Authentication will fail if you use a wrong client ID.

How to integrate Firework Android SDK?

Make sure your project is using the mavenCentral repository in your project build.gradle or build.gradle.kts repositories block:

repositories {
    ...
    mavenCentral()
}
repositories {
    ...
    mavenCentral()
}    

Add these dependencies based on your requirements:

  • Firework SDK: The main dependency of Firework Android SDK is required for the library initialization and video and livestream features.

  • Single Host (high latency) Livestream: If you are planning to use a single host Livestream from an external source.

  • Multi-Host (low latency) Livestream: If you are planning to use Livestream with multiple hosts.

  • Image Loader: The SDK requires an image loader that can be one of the predefined Glide or Picasso or your custom implementation of the ImageLoader interface using your solution.

def fireworkSdkVersion = "latest_firework_sdk_version"
implementation 'com.firework:sdk:$fireworkSdkVersion'

// Only for single host (Optional)
implementation 'com.firework.external.livestream:singleHostPlayer:$fireworkSdkVersion'

// Only for multi host (Optional)
implementation 'com.firework.external.livestream:multiHostPlayer:$fireworkSdkVersion'

// Glide (Optional)
implementation 'com.firework.external.imageloading:glide:$fireworkSdkVersion'

// Picasso (Optional)
implementation 'com.firework.external.imageloading:picasso:$fireworkSdkVersion'
val fireworkSdkVersion = "latest_firework_sdk_version"
implementation("com.firework:sdk:$fireworkSdkVersion")

// Only for single host (Optional)
implementation("com.firework.external.livestream:singleHostPlayer:$fireworkSdkVersion")

// Only for multi host (Optional)
implementation("com.firework.external.livestream:multiHostPlayer:$fireworkSdkVersion")

// Glide (optional)
implementation("com.firework.external.imageloading:glide:$fireworkSdkVersion")

// Picasso (optional)
implementation("com.firework.external.imageloading:picasso:$fireworkSdkVersion")

SDK Initialization

Call this code in your custom application class onCreate method to initialize the Firework SDK:

import com.firework.sdk.FireworkSdk
import com.firework.sdk.FireworkSdkConfig
import com.firework.sdk.FireworkInitError
import com.firework.imageloading.glide.GlideImageLoaderFactory

class MyApp : Application() {

    override fun onCreate() {
        super.onCreate()
        
        // build Firework Android SDK configuration
        val config = FireworkSdkConfig.Builder(context = this)
            .clientId(FW_CLIENT_ID) // Client OAUTH Id
            .userId("My app User ID") // Optional field to set the User ID in your eco-system.
            .imageLoader(GlideImageLoaderFactory.createInstance(context = this)) // Glide, Picasso, or your ImageLoader implementation
            .enableCache(true) // Enable or disable video players cache, enabled by default
            .maxCacheSizeBytes(MAX_CACHE_SIZE_BYTES) // Max cache size used by video players, 25MB by default
            .muteOnLaunch(true) // Mute videos on lauch
            .addLivestreamPlayerInitializer(SingleHostLivestreamPlayerInitializer()) // For single-host livestream use
            .addLivestreamPlayerInitializer(MultiHostLivestreamPlayerInitializer()) // For multi-host livestream use
            .build()
        
        // initialize Firework Android SDK
        FireworkSdk.init(
            fireworkSdkConfig = config,
            onSuccess = {
                // Successful initialization
            },
            onError = { error ->
                when (error) {
                    is FireworkInitError.InitializationError -> {
                        // Handle initialization error
                    }
                    
                    is FireworkInitError.AlreadyInitializedError -> {
                        // The SDK is already initialized
                    }
                }
            },
        )
    }
}

Since the Firework company is developing multiple SDKs for different purposes and they may lead to dependency conflicts, we introduced BoM solution which can be used when your app depends on more than one Firework SDKs or like to use the Firework opensource libraries.

In this solution, your project's gradle file should only define the platform dependency with the latest BoM version:

def fireworkSdkVersion = "latest_firework_bom_version"
implementation platform'com.firework:firework-bom:$fireworkBomVersion'

// no version is needed
implementation `com.firework:sdk`
implementation `com.firework.external.imageloading:glide`
implementation `com.firework.external.livestream:singleHostPlayer`
val fireworkBomVersion = "latest_firework_bom_version"
implementation(platform("com.firework:firework-bom:$fireworkBomVersion"))

// no version is needed
implementation("com.firework:sdk")
implementation("com.firework.external.imageloading:glide")
implementation("com.firework.external.livestream:singleHostPlayer")

Setup your project

We suggest you set the android:largeHeap="true" in your application tag at the AndroidManifest.xml file.

<application
        ......
        android:largeHeap="true">

    ......

</application>

The library packages are accessible through the . You can check for the latest stable released version using the MavenCentral tag on top of this doc.

Glide Image Loader: A implementation of the SDK ImageLoader interface.

Picasso Image Loader: A implementation of the SDK ImageLoader interface.

Using BoM (Bill of Material)

MavenCentral repositories
Glide
Picasso
release notes