ViewOptions Support Reference
This document describes which ViewOptions properties are supported by FwPlayerDeckView, and how they affect the PlayerDeck feed and the fullscreen player experience.
1. Unsupported Options
The following option types are not supported by FwPlayerDeckView. Setting them has no effect.
titleOption
PlayerDeck uses its own fixed title style
ctaOption
Not applicable to feed-level views
chatOption
Only applicable to full-screen-level views
storyBlockOption
Only applicable to the StoryBlock component
adOption
Ad configuration is not applicable to PlayerDeck
adBadgeOption
Ad badge configuration is not applicable to PlayerDeck
2. LayoutOption
Set via ViewOptions.Builder.layoutOption(LayoutOption).
backgroundColor
Yes
Background color of the PlayerDeck container
feedPadding
Yes
Padding around the feed content area
itemSpacing
Yes
Spacing between feed items
showPlayIcon
Yes
Whether to show the play icon on thumbnails
true
playIconWidth
Yes
Width (and height) of the play icon
24dp
roundedCorner
Yes
Whether to apply rounded corners to cards and the inline player
false
roundedCornerRadius
Yes
Corner radius value in pixels (effective when roundedCorner is true)
5
aspectRatio
Yes
Aspect ratio of the video area
9:16 (0.5625)
feedLayout
N/A
PlayerDeck always uses horizontal scrolling; this property is ignored
columnCount
N/A
PlayerDeck is always single-row; this property is ignored
feedTitlePosition
N/A
PlayerDeck uses a fixed NESTED title position; this property is ignored
ItemShape Note
The LayoutOption.Builder methods roundedCorner(), roundedCornerRadius(), aspectRatio(), and circleShape() are internally stored as a sealed class ItemShape:
ItemShape.Custom— carriesroundedCorner,roundedCornerRadius, andaspectRatio. This is the only variant supported by PlayerDeck.ItemShape.Circle— represents a circular item shape. This variant is not supported by PlayerDeck. IfcircleShape(true)is set, PlayerDeck will silently ignore it and fall back to default values.
3. PlayerOption
Set via ViewOptions.Builder.playerOption(PlayerOption).
3a. Feed-Level Properties
These properties directly control the PlayerDeck feed (thumbnails and inline player):
autoplay
Yes
Enables inline autoplay in the feed
false
3b. Fullscreen Player Properties
When a user taps a video in the PlayerDeck, a fullscreen player (PlayerActivity) opens. The following properties control that fullscreen experience:
playerMode
Yes
Display mode of the fullscreen player
PlayerMode.FULL_BLEED_MODE
showFireworkLogo
Yes
Show or hide the Firework logo
true
showShareButton
Yes
Show or hide the share button
true
showMuteButton
Yes
Show or hide the mute button
true
showPlayPauseButtonInVideo
Yes
Show or hide the play/pause button overlay
true
autoPlayOnComplete
Yes
Automatically advance to the next video
true
enablePipMode
Yes
Enable Picture-in-Picture mode
false
shareBaseUrl
Yes
Base URL for share links
""
shareUrlCustomCallBack
Yes
Custom callback to transform share URLs
Identity (returns the original URL)
sdkHandleCtaButtonClick
Yes
Whether the SDK handles CTA button clicks internally
true
logoConfig
Yes
Logo configuration
LogoConfig.NoLogo
playerUiOption
Yes
UI configuration for player controls
Default PlayerUiOption
livestreamCountDownOption
Yes
Livestream countdown timer configuration
Default LivestreamCountDownOption
showSubtitle
Yes
Show or hide subtitles
true
showCaption
Yes
Show or hide captions
true
showMoreButton
Yes
Show or hide the "more" menu button
true
reverseAudioControls
Yes
Reverse the audio control behavior
false
subtitleBackgroundColor
Yes
Background color of subtitle overlays
0x66121212
subtitleTextColor
Yes
Text color of subtitles
0xFFFFFFFF (white)
enableRotateOrientation
Yes
Allow screen rotation in the player
false
tapToEnterLiveStreamHidden
Yes
Hide the "tap to enter livestream" prompt
false
enableImmersiveMode
Yes
Enable immersive mode (hide system bars)
false
scrollingOrientation
Yes
Scrolling orientation in the fullscreen player
ScrollingOrientation.HORIZONTAL
showProductCard
Yes
Show or hide product cards in the fullscreen player
true
actionButtonOption
N/A
Not supported
4. BaseOption
Set via ViewOptions.Builder.baseOption(BaseOption).
feedResource
Yes
Determines which feed content to load (Discovery, Channel, Playlist, etc.)
progressBarColor
Yes
Color of the indeterminate progress bar (loading indicator)
Last updated
Was this helpful?