# 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

### Creating PlayerDeckOption

#### Using Builder

```kotlin
val playerDeckOption = PlayerDeckOption.Builder()
    .showFullScreenIcon(true)
    .showShareButton(true)
    .showSubtitle(true)
    .build()
```

#### Using DSL (Recommended)

```kotlin
val viewOptions = viewOptions {
    playerDeckOptions {
        showFullScreenIcon(true)
        showShareButton(true)
        showSubtitle(true)
    }
}
```

### Properties

#### showFullScreenIcon

**Type:** `Boolean`\
**Default:** `true`

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

```kotlin
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.

```kotlin
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.

```kotlin
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.

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

#### subtitleTextColor

**Type:** `Int` (ARGB color)\
**Default:** `0xFFFFFFFF` (white)

Text color of the subtitles.

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

### Default Values

| Property                  | Default Value |
| ------------------------- | ------------- |
| `showFullScreenIcon`      | `true`        |
| `showShareButton`         | `true`        |
| `showSubtitle`            | `true`        |
| `subtitleBackgroundColor` | `0x66121212`  |
| `subtitleTextColor`       | `0xFFFFFFFF`  |

### Complete Examples

#### Standard PlayerDeck Configuration

```kotlin
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

```kotlin
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`
* PlayerDeck options only apply to `FwPlayerDeckView`, not other widgets

### See Also

* [ViewOptions Overview](/firework-for-developers/android-sdk/integration-guide/configuration.md) - Complete configuration system
* [FwPlayerDeckView ](/firework-for-developers/android-sdk/integration-guide/01-basic-usage-and-api.md)- PlayerDeck widget guide
* [PlayerOption](/firework-for-developers/android-sdk/integration-guide/configuration/player-options.md) - Player configuration
* [BaseOption](/firework-for-developers/android-sdk/integration-guide/configuration/base-options.md) - Content source configuration


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.firework.com/firework-for-developers/android-sdk/integration-guide/configuration/playerdeck-options.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.