StoryBlock (Android)
StoryBlock
component allows the host app to embed the Fireworks video player directly into its view hierarchy.
StoryBlock is a heavy object containing multiple instances of the player, Heavy-lifting UI elements, and intensive background tasks, Beware that the recommended number of the StoryBlock being used in a single screen is 1. However, in a wide range of new Android devices, 2 instances might work alright. Any number of StoryBlock above this limitation is not recommended by the Firework team and is not supported.
StoryBlock lifecycle is very simple, the host app needs to create an instance of StoryBlock and initialise it once, then the StoryBlock goes to live mode and works as expected until the host app decides to kill the lifecycle, so call the destroy function. The init
function must not be called more than once, as same as destroy
function. The SDK trusts the host app to use these handles as expected, any violation of the lifecycle use might lead to unexpected behaviour of StoryBlock.
Lifecycle
Integration
To include a StoryBlock
in your app, add it to your app's layout, and initialise it by calling init()
method.
Initialisation of the StoryBlock
the component is as below
When you set the pauseWhenNotVisible
parameter to true
in the init()
function, the StoryBlock
will take automatic action to pause (or mute, in the case of a livestream) its playback whenever it becomes invisible on the screen. It will then resume normal playback when it becomes visible again.
Calling storyblock.destroy()
releases all resources allocated for the StoryBlock
.
StoryBlock
standalone configurations
StoryBlock
standalone configurationsYou can choose whether to enable autoplay mode or not; it's turned on by default.
You can also decide if you want to display the full-screen icon on the story block by adjusting the settings in storyBlockOptions
; the default setting for this is true.
StoryBlock
player modes
StoryBlock
player modesYou may choose between two-player modes for the StoryBlock
:
FIT_MODE
FULL_BLEED_MODE
When StoryBlock
is set up to display video in PlayerMode.FIT_MODE
, internally it tries to scale video with 9:16
dimension ratio. To achieve the proper result StoryBlock
the container should be placed into ConstraintLayout
with app:layout_constraintDimensionRatio="9:16"
attribute:
If StoryBlock
is set up with FULL_BLEED_MODE
, it will just fill in the container following its width and height.
Fullscreen and Compact state
StoryBlock
maybe displayed in fullscreen and compact mode
When the StoryBlock
is in the compact mode it displays a limited set of components. For example, shopping and livestream chat components are supported only in fullscreen mode.
It is possible to open the fullscreen mode programmatically by calling:
Play and pause the video in StoryBlock
StoryBlock
Users can pause and resume the video by calling the following functions
Keep in mind that pause()
function will not work for ad videos and livestreams.
Automatically release StoryBlock (Deprecated, please use FwStoryBlockView instead)
The FwLifecycleAwareStoryBlockView
is a wrapper for the FwStoryBlockView
class, providing automatic cleanup when the parent component (Fragment or Activity) is destroyed.
To utilize and set up the FwLifecycleAwareStoryBlockView
, follow the same procedures as you would for the FwStoryBlockView
. The only difference is that the destroy()
method will be triggered automatically when needed.
Last updated