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
  • Customize base Share URL
  • Deep linking

Was this helpful?

  1. Android SDK
  2. Integration Guide for Android SDK

Share & Video Deep linking

Customize base Share URL

By default the share url of the firework videos have the firework base URL - https://fw.tv. For example share url can look like this:

https://fw.tv?fw_video={video_encoded_id}&fw_channel={channel_name}&fw_playlist={playlist_encoded_id}

If you want to replace the Firework base URL in share link, just provide a base URL you want in PlayerOptions:

val viewOptions = ViewOptions.Builder().playerOption(
   PlayerOption.Builder()
        .shareBaseUrl("https://www.example.com")
        .build()
).build()

// Or DSL verison: 

val viewOptions = viewOptions {
   playerOptions{
      shareBaseUrl("https://www.example.com")
   }
}

fwVideoFeedView.init(viewOptions)
PlayerOption playerOptions = new PlayerOption.Builder()
        .playerMode(PlayerMode.FIT_MODE)
        .shareBaseUrl("https://www.example.com")
        .build();

ViewOptions viewOptions = new ViewOptions.Builder()
        .playerOption(playerOptions)
        .build();

// init video feed view with view options
 videoFeedView.init(viewOptions);

Deep linking

<intent-filter android:autoVerify="true">
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT"/>
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="https" android:host="example.com" />
</intent-filter>

When a user clicks on the shared URL, the activity is launched. You can use the following function in the onCreate() method of the activity to check if the activity is launched via deep link:

fun isOpenedViaDeepLink(intent: Intent): Boolean {
    val uri: Uri? = intent.data
    if (uri == null) {
        return false
    }
    val isValidScheme = (uri.scheme ?: "") in listOf("http", "https")
    val isDeeplinkHost = uri.host == "example.com"
    return isValidScheme && isDeeplinkHost
}
boolean isOpenedViaDeepLink(Intent intent) {
    Uri uri = intent.getData();
    if (uri == null) {
        return false;
    }
    Boolean isValidScheme = uri.getScheme().contains("http") ||  uri.getScheme().contains("https");
    Boolean isDeeplinkHost = (uri.getHost() == "example.com");
    return isValidScheme && isDeeplinkHost;
}

If activity is launched via deep link, next step is to launch the player. For this purpose use the following code:

val url = intent.data!!.toString
val launchResult = FireworkSdk.startPlayer(viewOptions = viewOptions, url = url)
if(launchResult is PlayerLaunchResult.Failure) {
  // Handle error
}
PlayerLaunchResult launchResult = FireworkSdk.INSTANCE.startPlayer(viewOptions, url);
if(launchResult instanceof PlayerLaunchResult.Failure) {
    // Handle error
}

Use the following link to read more about ViewOptions: Configure Video Feed. FireworkSdk.startPlayer() returns result which indicates if url can be opened by the SDK or not.

Keep in mind that FireworkSdk should be initialised before calling FireworkSdk.startPlayer() function.

Note: Starting in Android 12 (API level 31), a generic web intent resolves to an activity in your app only if your app is approved for the specific domain contained in that web intent. If your app isn't approved for the domain, the web intent resolves to the user's default browser app instead.

PreviousStoryBlock (Android)NextAd Support (Android)

Last updated 3 months ago

Was this helpful?

If you are new to the concept of deep linking, please read the official android documentation first: To handle the universal link ( shared url ) in your app, you need to add Intent filter to the activity that should handle the deep link:

https://developer.android.com/training/app-links/deep-linking