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
  • Set shared base URL
  • Enable the share link to launch the app
  • Open video player
  • Manually construct the shared URL
  • Configuration for opening video player

Was this helpful?

  1. Flutter SDK
  2. Integration Guide for Flutter SDK V2

Share & Video Deeplinking (Flutter)

PreviousApp-level Language Setting (Flutter)NextInject Android Image Loader (Flutter)

Last updated 2 months ago

Was this helpful?

Set shared base URL

If your website integrates our Web component, we suggest setting the website link (without query) as the shared base URL. For instance, if the link for the website integrating our Web component is https://example.com, you could set the share base URL using the following code snippets.

// Set shared base URL
FireworkSDK.getInstance().shareBaseURL = "https://example.com";

Once the share URL is configured as demonstrated in the code snippets above, the sample video shared URL will become https://example.com?fw_video={video_encoded_id}&fw_channel={channel_name}&fw_playlist={playlist_encoded_id}. Users can share the video by clicking the share button.

Enable the share link to launch the app

For instance, if you set the shared base URL as https://example.com, you must ensure that links beginning with https://example.com function as universal links for iOS and app links for Android. This way, the user clicking the shared URL will trigger your app (if installed) to open. Please consult the following docs for more details:

Open video player

When a user clicks the share link, your app (if installed) will be opened. Then you can get the the shared link and use openVideoPlayer of FireworkSDK instance to open the video player.

FireworkSDK.getInstance().openVideoPlayer(sharedLink);

Manually construct the shared URL

For instance, you might want to open the video player directly, bypassing the need for users to click a share link outside the app. Instead, you could trigger the video player to open when users click a button within the app. In this case, you could manually construct the shared URL and use openVideoPlayer API to open the video player.

Open single content player

As illustrated in the following code snippets, you can launch the video player to present a single video or livestream.

final videoId = "encoded_video_id";
final channelName = "channel_name";
// openVideoPlayer API does not verify the shared base URL
// You could use https://fw.tv
// or a customized shared base URL(such as https://example.com)
final sharedLink = "https://fw.tv?fw_video=${videoId}&fw_channel=${channelName}";
FireworkSDK.getInstance().openVideoPlayer(sharedLink);

Open playlist player

As illustrated in the following code snippets, you can launch the video player to present all videos/livestreams within a playlist. The specified video will be positioned first.

// The video/livestream corresponding to this video id will be placed first.
final videoId = "encoded_video_id";
final channelName = "channel_name";
final playlistId = "encoded_playlist_id";
// openVideoPlayer API does not verify the shared base URL
// You could use https://fw.tv
// or a customized shared base URL(such as https://example.com)
final sharedLink =
    "https://fw.tv?fw_video=${videoId}&fw_channel=${channelName}&fw_playlist=${playlistId}";
FireworkSDK.getInstance().openVideoPlayer(sharedLink);

Configuration for opening video player

Please consult

https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app
https://developer.android.com/training/app-links
Player configurations (Flutter)