Skip to main content
Flutter SDK comprises features such as brand feed, communities, and groups.

Requirements

Android

Installation

Follow the below steps and place the codes in mentioned files to install the Flutter SDK in Android. Step 1: In android/build.gradle:
Step 2: In android/app/build.gradle:
Step 3: In android/app/src/main/AndroidManifest.xml::
Step 4: Change Theme in android/app/src/main/res/values/styles.xml: Our SDK is using Material components so in order to use our sdk you need to use material theme as shown in below example
Step 5: Create android/app/proguard-rules.pro, add the following lines:
Want to override our default loader?
  • We are using lottie animation for our loader. You can put your custom lottie animation loader with the name loader_mix.json in the android/app/src/main/res/raw folder. Make sure you use the same name as provided.

Quick Start

1. Initialize SDK Place the below code in android/app/src/main/yourpackage/MainActivity.kt file to initialize the SDK.
2. Handling Deep Link To handle deep link place the below code in android/app/src/main/AndroidManifest.xml file:
Place the below code in android/app/src/main/yourpackage/MainActivity.kt file:

iOS

iOS Configuration

Follow the below steps and place the codes in mentioned files to install the Flutter SDK in iOS. 1. In ios/Podfile:

Quick Start

1. Initialize SDK
2. Handling Deep Link To handle deeplink place the below in AppDelegate.swift file:
3. Handling Push Notification To handle the push notification place the below code In AppDelegate.swift file:

Flutter

1. Load Feed View
2. Load Carousel Embed View
To configure the EmbedParams based on your need you can pass the below values. embedId = The Embed Id that you want to load. uniqueId = This is an optional parameter. This uniqueId is used when we need to display same embed in multiple/same screen. We need to provide uniqueId for the same embedId in multiple/same screen. ssoToken = This is an optional parameter. To auto login in the SDK, you shall pass “YOUR_SSO_TOKEN” in order to implement Embed with SSO in your app. interactionDeepLink = This is an optional parameter. You can pass a deeplink URL in this parameter. If a deeplink URL is given then all the interaction/clicks in the full screen view will redirect to the deeplink URL given. If not passed then the regular flow will work. It should be a correct URL else user will not be redirected. isDirectDeepLinkEnabled = This is an optional boolean parameter. Default value is false. If this parameter is true then all the interaction/clicks in the full screen view will redirect to the specific video in white labelled app associated with video and also value of this parameter “interactionDeepLink” will be ignored. If not passed then the regular flow will work.
Note: For using isDirectDeepLinkEnabled parameter, you must have white labelled your domain first and also integrated the Handling deep link part in your main app in which you want to redirect this video to.
isShowProfileEnabled = This is an optional boolean parameter. Default value is false. If this parameter is true and also if user is logged in than Profile picture will be visible in full screen view (right side top corner). On clicking the profile picture user will see the account settings and logout options. 3. Load Full Screen/Standard Wall Embed View
To configure the EmbedParams based on your need you can pass the below values. embedId = The Embed Id that you want to load. uniqueId = This is an optional parameter. This uniqueId is used when we need to display same embed in multiple/same screen. We need to provide uniqueId for the same embedId in multiple/same screen. ssoToken = This is an optional parameter. To auto login in the SDK, you shall pass “YOUR_SSO_TOKEN” in order to implement Embed with SSO in your app. interactionDeepLink = This is an optional parameter. You can pass a deeplink URL in this parameter. If a deeplink URL is given then all the interaction/clicks in the full screen view will redirect to the deeplink URL given. If not passed then the regular flow will work. It should be a correct URL else user will not be redirected. isDirectDeepLinkEnabled = This is an optional boolean parameter. Default value is false. If this parameter is true then all the interaction/clicks in the full screen view will redirect to the specific video in white labelled app associated with video and also value of this parameter “interactionDeepLink” will be ignored. If not passed then the regular flow will work.
Note: For using isDirectDeepLinkEnabled parameter, you must have white labelled your domain first and also integrated the Handling deep link part in your main app in which you want to redirect this video to.
isShowProfileEnabled = This is an optional boolean parameter. Default value is false. If this parameter is true and also if user is logged in than Profile picture will be visible in full screen view (right side top corner). On clicking the profile picture user will see the account settings and logout options. 4. Handling Push Notifications Prerequisite: Create firebase project and integrate into your app by following https://firebase.google.com/docs/flutter/setup Step 1: Create firebase_options.dart in lib folder and add below details in that file.
2. Handling background/foreground notifications
Note: Here for Android you need to provide small notification icon as “icon” key for foreground notifications. This icon needs to be in your flutter as well as android folder.
Step 5. Handle SSO Login Explicitly in SDK To Auto Login in the SDK, You need to call below method, whenever user is log in to your application.
Note: You don’t need to call the below method if you have implemented the Embed With SSO already.
Step 6. Handle SSO Logout in SDK Whenever user logs out from your application call the below method.