PlayerDeck Options

PlayerDeckOption configures behavior specific to FwPlayerDeckView. These options control the fullscreen icon, share button, and subtitle appearance in the inline PlayerDeck feed.

Overview

PlayerDeckOption provides configuration for:

• Fullscreen icon visibility

• Share button visibility

• Subtitle display, text color, and background color

• Social link text styling

Creating PlayerDeckOption

Using Builder

val playerDeckOption = PlayerDeckOption.Builder()
    .showFullScreenIcon(true)
    .showShareButton(true)
    .showSubtitle(true)
    .socialLinkStyle(SocialLinkStyle(fontSizeSp = 14f, fontWeight = 600))
    .build()

Using DSL (Recommended)

val viewOptions = viewOptions {
    playerDeckOptions {
        showFullScreenIcon(true)
        showShareButton(true)
        showSubtitle(true)
        socialLinkStyle(SocialLinkStyle(fontSizeSp = 14f, fontWeight = 600))
    }
}

Properties

showFullScreenIcon

Type: Boolean Default: true

Show or hide the fullscreen expansion icon on each deck item.

playerDeckOptions {
    showFullScreenIcon(true)
}

When enabled, a fullscreen icon appears on each video card, allowing users to tap it to open the fullscreen player directly.

showShareButton

Type: Boolean Default: true

Show or hide the share button on each deck item.

playerDeckOptions {
    showShareButton(true)
}

When enabled, a share button appears on the video card, allowing users to share the video.

showSubtitle

Type: Boolean Default: true

Show or hide subtitles on the inline PlayerDeck player.

playerDeckOptions {
    showSubtitle(true)
}

When enabled, subtitles are displayed over the video during inline playback (if the video has subtitle data available).

subtitleBackgroundColor

Type: Int (ARGB color) Default: 0x66121212 (semi-transparent dark)

Background color of the subtitle overlay.

playerDeckOptions {
    subtitleBackgroundColor(0x66121212.toInt())
}

subtitleTextColor

Type: Int (ARGB color) Default: 0xFFFFFFFF (white)

Text color of the subtitles.

playerDeckOptions {
    subtitleTextColor(0xFFFFFFFF.toInt())
}

socialLinkStyle

Type: SocialLinkStyle? Default: null (uses the SDK default 12sp text size and 400 font weight)

Configures the text style for social/sponsor links shown in the inline FwPlayerDeckView player. This option only affects PlayerDeck inline UI; fullscreen social link styling is configured through PlayerOption.socialLinkStyle.

import com.firework.common.social.SocialLinkStyle

val playerDeckOption = PlayerDeckOption.Builder()
    .socialLinkStyle(SocialLinkStyle(fontSizeSp = 14f, fontWeight = 600))
    .build()

Using the Kotlin DSL:

import com.firework.common.social.SocialLinkStyle

val viewOptions = viewOptions {
    playerDeckOptions {
        socialLinkStyle(SocialLinkStyle(fontSizeSp = 14f, fontWeight = 600))
    }
}

SocialLinkStyle Properties

Property	Type	Default	Description
fontSizeSp	Float?	null	Social link text size in sp units
fontWeight	Int?	null	Social link text weight from 1 to 1000; null keeps the layout default

Note: Passing SocialLinkStyle(fontSizeSp = null, fontWeight = null) does not override the layout text size or font weight. The effective SDK defaults are 12sp and 400.

Default Values

Property	Default Value
showFullScreenIcon	true
showShareButton	true
showSubtitle	true
subtitleBackgroundColor	0x66121212
subtitleTextColor	0xFFFFFFFF
socialLinkStyle	null (uses SDK default 12sp, 400)

Complete Examples

Standard PlayerDeck Configuration

val viewOptions = viewOptions {
    baseOptions {
        feedResource(FeedResource.Channel("your_channel_id"))
    }
    playerOptions {
        autoplay(true)
    }
    playerDeckOptions {
        showFullScreenIcon(true)
        showShareButton(true)
    }
}

playerDeckView.init(viewOptions, childFragmentManager)

PlayerDeck with Subtitles

val viewOptions = viewOptions {
    baseOptions {
        feedResource(FeedResource.Playlist("channel_id", "playlist_id"))
    }
    playerOptions {
        autoplay(true)
    }
    playerDeckOptions {
        showSubtitle(true)
        subtitleTextColor(Color.WHITE)
        subtitleBackgroundColor(Color.parseColor("#88000000"))
    }
}

Important Notes

• showFullScreenIcon and showShareButton only affect the inline deck item UI, not the fullscreen player

• Subtitle options (showSubtitle, subtitleTextColor, subtitleBackgroundColor) control inline playback subtitles; fullscreen subtitle settings are configured via PlayerOption

• socialLinkStyle only affects inline PlayerDeck social/sponsor link text; fullscreen social link text is configured via PlayerOption.socialLinkStyle

• PlayerDeck options only apply to FwPlayerDeckView, not other widgets

See Also

• ViewOptions Overview - Complete configuration system

• FwPlayerDeckView - PlayerDeck widget guide

• PlayerOption - Player configuration

• BaseOption - Content source configuration