Changelog (Android)

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[6.16.0] - 2024.11.21

Added

  • New livestream play design (MS-210)

  • Add setLivestreamPlayerVersion in FireworkSdk to switch player design version (MS-766)

  • Open/close subtitle when there is only one subtitle (MS-775)

Fixed

  • High-Level Bug Fixes for short video and livestream

[6.15.3] - 2024.11.15

Fixed

  • Data tracking issue on livestream or replay event

  • Fix crash issue when customizing share url on Flutter SDK

[6.15.2] - 2024.11.03

  • Support customizing the share URL (MS-473)

  • Support secondary CTA in in-stream PDP (MS-614)

  • Add Turkish language support (MS-626)

Fixed

  • Make Ui Element compatible with Jetpack Compose (MS-742)

[6.14.5] - 2024.10.22

Fixed

  • Fix autoplay status in storyblock

[6.14.4] - 2024.10.16

Added

  • Add Video analytics event callback (MS-699)

Fixed

  • Fix Vast tracking event issue (MS-699)

[6.14.3] - 2024.10.02

Added

  • Add autoplay status to short video event callbacks (MS-561)

  • Support configure the background color/font color for closed captions (MS-616)

Changed

  • Swap the position of the volume and cc icon on short video player (MS-608)

  • Update accessbility service of short video (MS-610)

[6.14.2] - 2024.09.27

Added

  • Support Hungary language (MS-559)

Fixed

  • Submit button text is not in alignment with button (MS-599)

[6.14.1] - 2024.09.12

Added

  • Support add/remove/replace product variants (MS-542)

  • Support hide more button in player (MS-587)

Fixed

  • Announcements are not visible in Digital Showrooms replay (MS-483)

  • Duplicate messages are displayed while scrolling the progress bar in replay (MS-566)

[6.14.0] - 2024.08.26

Added

  • [Ads] Support VAST XML passed in as widget param (MS-239)

  • Support autoplay setting for story block (MS-382)

  • Support customizing the full screen setting for story block (MS-384)

  • Support hiding ad badge for story block (MS-398)

  • Support hiding player caption (MS-404)

Fixed

  • Deal with player style inconsistencies with other platform (MS-465)

  • Fix the remind me in countdown timer to camel-case (MS-207)

[6.13.1] - 2024.08.08

Changed

  • Change behavior of audio route when there is already a player existing (MS-363)

Fixed

  • Add new products to the top of the list, not the bottom on livestream (MS-350)

  • Trailer video cannot auto play in full-screen player and compact story block (MS-371)

  • Keep product impression/click event reporting consistent with iOS/Web (MS-428, MS-402, MS-400)

[6.13.0] - 2024.07.16

Added

  • Hide/Show comments on livestream when moderator delete/restore it on biz portal (MS-11)

  • Expand comments list in livestream by default (MS-6)

  • Show product card and overlay CTA on compact story block (MS-7)

  • Make the announcements scroll on their own during the live stream. (MS-3)

  • Reduce the default modal of shopping overlay size by 50% (MS-21)

  • Add OnImpression event to PlayerLifecycleAnalyticsEvent (MS-85)

  • Show forward and backward arrow on full-screen player (MS-14)

  • Support customizing pip icon in full-screen player (MS-18)

  • Support configuring video overlay CTA to oval style (MS-20)

  • Support configuring action button(Share/Cancel button) style (MS-23)

  • Support ar-SA, ar-AE, es-MX, es-CO languages (MS-34)

Changed

  • Optimize translation in multiple languages (MS-34)

Fixed

  • Fix Chat message and poll card overlapping in replay (MS-41)

  • Fix UserSentChatMessage callback invoked on wrong time (MS-42)

  • Change md5 to SHA256 Hash Algorithm to avoid "weak hash Algorithm" issue (MS-193)

  • Show mini-size icon by default when play or pause the video in full-screen player(MS-8)

  • Fix CTA buttons are not translated in Thai (MS-33)

  • Fix PDP page cannot collapse In compact story block view (MS-128)

[6.12.2] - 2024.06.06

Added

  • Poll interactions result to Livestream replays (ASDK-2602)

  • Accessibility prompts to the Livestream countdown timer (ASDK-2536)

  • Support Thai language (ASDK-2697)

  • Add videoType and liveStreamStatus for setOnFeedItemClickListener (ASDK-2695)

Removed

  • IMA ads support (ASDK-2674)

Fixed

  • Fix SDK will crashed on initialization when there is no meta-data configured (ASDK-2700)

  • The crash which was caused by unhandled interaction type of GiveAway (ASDK-2677)

  • Fix subtitle language translation (ASDK-2681)

  • Fix subtitle list is showing in ALL-CAPS when opened in storyblock mode (ASDK-2634)

  • A rare issue in which if the Internet connection was lost before opening the player, the Livestream would not start correctly (ASDK-2282)

  • Fix prompts are not shown for title and start time in storyblock collapsed mode (ASDK-2676)

  • Fix the countdown timer has heading "Live in" talkback announces "Heading" instead of "Live In" (ASDK-2675)

[6.11.0] - 2024.05.01

Added

  • PlayUid param to data tracking events (ASDK-2511)

  • German, Vietnamese, and Italian translations

  • Livestream's "Host will be right back" feature (ASDK-1220)

  • Bring back the email field to the Question interactions (ASDK-2544)

  • Tracking level SDK config (ASDK-2557)

  • Send VideoFinishedEvent when video is closed, swiped or its playback ended (ASDK-2600)

  • Add VideoType parameter to VideoInfo, deprecate VideoInfo.isAd (ASDK-2601)

Changed

  • Replace FwJson Serialization core module with FwGson (ASDK-2440)

  • Change the LivestreamAnalyticEvent livestreamId parameter to VideoInfo which has more information (ASDK-2572)

  • Make OnProductCardClickListener.onProductCardClick return Boolean which indicates if host app handles external navigation (ASDK-2577)

Fixed

  • Product cards spacing in RTL mode (ASDK-2516)

  • Setting custom image for close button (ASDK-2171)

  • Arabic, Spanish, Polish, Japanese, Portuguese, and Russian translations

  • The Question interactions' Answer field hint and position in RTL mode (ASDK-2578)

  • Replay getting paused in PIP (ASDK-2597)

  • The bug in which the Live chat emojis was visible behind interactions (ASDK-2360)

  • The UI issue in which the feed in Horizontal mode in RTL had wrong spacing for the first item (ASDK-2517)

  • Divide by zero crash in the autoplay player (ASDK-2607)

  • Fix the chat message Username in RTL mode (ASDK-2615)

  • Pinned chat message in RTL mode (ASDK-2615)

[6.10.2] - 2024.04.03

Fixed

[6.10.1] - 2024.03.28

Fixed

  • Unmuting muted active livestream when user goes from PIP to fullscreen (ASDK-2512)

[6.10.0] - 2024.03.26

Added

  • Add custom product card view, configuration, and ProductCardsOptions public API: Default | Custom (ASDK-2146)

  • CTA types "SEE_MORE" & TALK_TO_AN_EXPERT

  • Currency codes "VED" & "SLE"

  • Livestream Provider "TWITTER"

  • Possibility to make the Logo non-clickable by defining isClickable param in PlayerOptionLogoConfig (ASDK-2389)

  • The PipEnterError.NoPlayingPlayer error type to PIP which indicates the player is paused (ASDK-2414)

  • Tracking Livestream CountDown widget impression and "Remind Me" click (ASDK-2388)

  • ProductHydrator.isInStock() method (ASDK-2420)

  • Send commerce:product_detail_impression tracking event when the product detail page is shown (ASDK-2400)

  • The new "Digital Showroom" feature including the gateway access code (ASDK-1742 & ASDK-1743)

  • Add channelId parameter to the tracking events for the ChannelHashtag feed resource type (ASDK-2474)

Changed

  • The FwStoryBlockView.init's showLivestreamCountDown option is moved to PlayerOption as LivestreamCountDownConfig and now supports Light/Dark theme and applies to both fullscreen player and StoryBlock (ASDK-2385)

  • Base URL to firework.com

  • Changed behaviour of product availability in Livestream Replay. The product availability is based on the last state of the product in the Livestream (ASDK-2420)

  • Kotlin version updated to 1.8.x (ASDK-2439)

  • Pass videoId instead of livestreamId for analytics events related to Livestream (ASDK-2455)

  • Pass videoId instead of livestreamId in FeedItem parameter of FeedItemClickListener.onItemClickcallback (ASDK-2461)

  • Call product hydration every time products are updated in the Livestream (ASDK-2463)

  • Fix sending of presentation and player_layoutproperties in data tracking (ASDK-2433)

  • Send livestream:start_active_watch for livestream replay (ASDK-2450)

Deprecated

  • The FireworkSdkConfig's checksumRequired option. (ASDK-2378)

Removed

  • Livestream Provider "MUX"

  • Livestream Replay's "Recorded" badge (ASDK-2387)

Fixed

  • A potential bug in PicassoImageLoader which was throwing exception when the image path was empty

  • A bug which enterPip API was returning PipEnterError.DisabledByClient when there was no active player (ASDK-2414)

  • A bug that the PIP chevron button was not showing when StoryBlock Livestream was going back from PIP mode to fullscreen (ASDK-2352)

  • The FwVideoFeedView memory leak caused by the ViewImpressionsTracker (ASDK-2319)

  • Fix logic of sending engagement:interactable_engaged_view tracking event

  • Fix ConcurentModificationException inside FeedWebSocketService (ASDK-2504)

Security

  • A runtime crash caused by IMA library on Android 14 (ASDK-2439)

[6.9.3] - 2024.02.16

Fixed

  • A regression which if player was paused, the enterPip API was returning inactive player error (ASDK-2412)

[6.9.2] - 2024.02.07

Fixed

  • The bug that was causing a crash when the initial run was with bad/no internet connection (ASDK-2384)

[6.9.1] - 2024.01.26

Changed

  • Add VideoInfo param to onCartClick callback (ASDK-2365)

  • Add VideoInfo param to onProductHydration callback (ASDK-2366)

Fixed

  • LivestreamKeyMoment not implementing Serializable (ASDK-2375)

  • The Livestream Replay item performance issue, which was limiting the number of StoryBlocks in one page

[6.9.0] - 2024.01.18

Added

  • Product key moments feature to Livestream replay (ASDK-2132)

  • Logo on the Player feature and PlayerOptionLogoConfig public API: NoLogo|Logo.AggregatorLogo(channelId)|Logo.CreatorLogo(channelId) (ASDK-2134)

  • The Livestream Count Down feature for the trailer (ASDK-2174)

  • ImageLoader config including CircleTransformation (ASDK-2202)

  • New CTA Action Types including: BOOK_A_TEST_DRIVE, ENROLL_NOW, INVEST_NOW, RSVP, SEE_FULL_RECIPE, SHOP_RECIPE, VIEW_RECIPE (ASDK-2234)

  • Show the seek bar in StoryBlock and hide it when there is not much room to show it (ASDK-2244)

  • The light player feature for autoplay (ASDK-2153)

Changed

  • Respect safe area when showing custom product card (ASDK-2231)

  • Expose product unit details in product card details (ASDK-2239)

  • WebSocket implementation to stop channels closing each other (ASDK-2245, ASDK-2278)

  • Handling invalid IVS playback URL issue and adding public API: LivestreamErrorInvalidPlaybackUrl (ASDK-2273)

  • Enable announcement feature in StoryBlock (#2940)

  • Avoiding the 10-second blank screen which was happening when the MultiHost (low latency) Livestream was being played by the SingleHost (high latency) Livestream player (ASDK-2321)

  • Video info to Shopping callbacks including: onCtaButtonClick, onProductLinkClickListener, and onProductCardClickListener (ASDK-2327)

  • Expose feedId (a.k.a feed Embed Instance ID) for FwStoryBlockView, FwLifecycleAwareStoryBlockView, and FwVideoFeedView to identify an analytic event per widget and Storyblock (ASDK-2322)

  • Enhanced multiple data tracking wrong or missing events

Deprecated

  • FireworkImageLoader module and the host app can use GlideImageLoader or PicassoImageLoader instead (ASDK-2329)

  • FwLifecycleAwareStoryBlockView and FwLifecycleAwareVideoFeedView cause they didn't do their purpose and now the host app has control over the lifecycle and can decide when to initialize and destroy the StoryBlock (ASDK-2354)

Fixed

  • The StoryBlock Live tap to enter when the user already entered and just returns (ASDK-2189)

  • Player does not honor RTL setting for the videos when Arabic language is selected (ASDK-1919)

  • Showing N/A instead of original price when it is not available (ASDK-1891)

  • "powered by" icon in RTL mode (ASDK-2204)

  • Pausing the StoryBlock when is scrolled out of screen (ASDK-2136)

  • OutOfMemory error loading stream (ASDK-2198)

  • The subtitle menu in RTL mode (ASDK-1916)

  • Random StoryBlock crash on destroy (ASDK-2214)

  • Subtitle setting did not persist in the case when captions were turned off in system settings (ASDK-1915)

  • An issue with the player not resuming onResume

  • The app crashes while leaving the player (ASDK-2232)

  • Duplicate items after refresh (ASDK-2247)

  • The wrong product image is shown on the pinned product (ASDK-2248)

  • The StoryBlock does not repeat a feed with a single element (ASDK-2249)

  • The issue in username flow which renders showing "Happy Banana" on the chat input (ASDK-2245)

  • the Close button wrong behavior when the video is playing in a loop (ASDK-2267)

  • App crashes when a product with deep link is opened via Shop Now CTA (ASDK-2266)

  • Multiple bugs related to wrong states caused by late SDK/Views initialization and introducing FireworkInitError → AlreadyInitializedError (ASDK-2242)

  • Crashing the SDK when the Livestream element is missing in the feed to update (ASDK-2274)

  • The issue that was preventing single-element feed from loading (ASDK-2270)

  • The CTA loader in 'shop now" is not timing out after 10 seconds (ASDK-2286)

  • The issue in product talkback which was not losing focus when PDP was opened (ASDK-1779)

  • Product title hydration on PDP page (ASDK-2136)

  • Livestream player showing the trailer in Player when the Livestream is started in StoryBlock (ASDK-2093)

  • Storyblock continues to play in the background (ASDK-2297)

  • Duplicates in the video feed view when clicking on the last item (ASDK-2310)

  • The KeyboardUtils destroy before init crash (#2939)

  • The “Tap to enter livestream” button is shown in the fullscreen player when the user switches to another screen and then comes back (ASDK-2293)

[6.8.1] - 2023.11.06

Fixed

  • App crashes when video in the feed is not in view and PIP is playing (ASDK-2208)

[6.8.0] - 2023.11.01

Added

  • Multiple pinned products in the Livestream replay (ASDK-2126)

  • New log system, allowing host app to implement the FwLogAppender to receive SDK logs (ASDK-1644)

  • Updating Livestream interactions including Polls and Questions during live (ASDK-2118)

  • Add Livestream "Tap to enter" button to the compact StoryBlock and make it adjustable to the view size (ASDK-2143)

Fixed

  • Video in collapsed mode does not pause when the kebab menu is opened after closing the fullscreen player (ASDK-2060)

  • Switching trailer to live in pip (ASDK-2111)

  • Crash when feed is destroyed before init (ASDK-2137)

  • Setting errorListener is not working if called before feedView.init() (ASDK-2138)

  • FwFeedView loading state was not sent to FeedViewStateListener (ASDK-2139)

  • When an answered question is launched again, UI does not hide the unanswered question (ASDK-2042)

  • No response when clicking the video again after closing pip (ASDK-2135)

  • Fix multiple cases of memory leaks in FwStoryBlockView, Player, and DI (ASDK-2165)

  • Player switches to the next video when returning from PIP in RTL mode (ASDK-2001)

  • Two half videos are shown in PIP when video PIP window is resized in RTL mode (ASDK-2172)

  • Fix "Add to cart" Arabic translation

[6.6.0]

  • New Product card design in the short video

  • Presenting a new PDP page

  • Introducing a new content source for single video ID

[6.3.1]

  • Custom VAST attributes

  • Universal Link Support

  • Add toast for showing AddToCartError.Timeout.message

  • Support product hydration with these two options:

    • productUnit.url

    • productUnit.image.url

  • Support Subtitles UI

  • RMN Measurements and Tracking

  • Add Poll to Livestream

  • Adding questions to Livestream

  • Realtime subtitles

  • Adding Poll in Short Videos

  • Adding Questions in Short Videos

[6.2.0]

  • Ability to Mute Ads

  • Added Mute button in the top-left corner

  • ChatUX Changes

  • Collapsed and Expand Modes for the Chat

  • Lighter gradient in the background

  • Missed messages button

  • Messages fading out on the top of chat

  • Drawable Gradient

  • Ability to set drawable background gradient under the caption

  • Manually Uploaded Posters

  • Images coming from the back-end are automatically placed on the video thumbnail

  • Customer Update Bug Fixes and Data Fixes

  • Hashtag Playlist

  • filter by hashtags

  • High-Level Bug Fixes for StoryBlock and PIP

Last updated