Video Feed
Currently, there are eight source types of the video feed:
Discover
Channel
Playlist
Playlist Group(Only supported on iOS)
Dynamic Content
Hashtag Playlist
SKU
Single Content
Integration
Please refer to the Encoded IDs help article to learn about how to find your encoded channel ID, playlist ID, playlist Group ID
Mode
VideoFeed
widget supports three modes: row
, column
, and grid
.
Use grid
mode:
Video feed configuration
VideoFeed
widget provides videoFeedConfiguration
property for configuring Video Feed. The current configurable are backgroundColor
, cornerRadius
, and titlePosition
etc. Please refer to VideoFeedConfiguration for more details.
Video player configuration
VideoFeed
widget provides videoPlayerConfiguration
property for configuring Video Player. The current configurable properties are playerStyle
, videoCompleteAction
, and ctaButtonStyle
etc. Please refer to VideoPlayerConfiguration for more details.
Video feed loading result callback
VideoFeed
widget provides onVideoFeedLoadFinished
property for setting video feed loading result callback.
Video empty callback
VideoFeed
widget provides onVideoFeedEmpty
property for setting video feed empty callback. The callback is triggered when there are no items in the video feed. For example, you could hide the widget when the callback is triggered. The callback is triggered in the following scenarios:
Load successfully but the back end returns an empty list
The load failed and the list is empty
Force refreshing video feed
Enable PiP(Picture in Picture)
You need to set enablePictureInPicture
to true
to enable PiP.
Set up the iOS project
To enable PiP outside the iOS app, you also need to add Background Modes capability via Signing & Capabilities in your iOS project settings. More information about this can be found here: Apple Documentation
To use Picture in Picture, we configure the app to support background audio playback. See Configuring the Audio Playback of iOS and tvOS Apps for more details.
As the following screenshot, we should select "Audio, AirPlay, and Picture in Picture".
![](https://docs.firework.com/~gitbook/image?url=https%3A%2F%2F688917408-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MLoGG8m6bokS9YTmS7m%252Fuploads%252FJ1yN6dBMbc1NnXJcK9Mv%252Fimage.png%3Falt%3Dmedia%26token%3D8da66c27-7f62-4dbe-a280-ea184a3ac2ff&width=768&dpr=4&quality=100&sign=9ec7c4dc&sv=1)
Keep alive when scrolling the widget out of the view box
Generally, if you put the video feed widget as the child of ListView, it will be rebuilt when scrolling the widget out of the view box. You could set wantKeepAlive
as true
to make the video feed widget keep alive when scrolling the widget out of the view box.
onVideoFeedClick
The callback is triggered when users click the video feed item. The event type is VideoFeedClickEvent.
onCustomCTAClick
The callback is triggered when users click the CTA button on the video in the video player. We start the floating player in the following sample codes. The event type is CustomCTAClickEvent.
Reference
Last updated