Skip to main content

BBPlayerOptions

class BBPlayerOptions(
    val autoPlay: Boolean? = null,
    val muted: Boolean? = null,
    val noChromeCast: Boolean? = null,
    val noStats: Boolean? = null,
    val commercials: Boolean? = null,
    val forceFullscreenLandscape: Boolean? = null,
    val allowCollapseExpand: Boolean? = null,
    val showChromeCastMiniControlsInPlayer: Boolean? = null,
    val showDescription: Boolean? = null,
    val waitForCmp: Boolean? = null,
    val handleConsentManagement: Boolean? = null,
    val tagForUnderAgeOfConsent: Boolean? = null,
    val consentString: String? = null,
    val consentGdprApplies: Int? = null,
    val consentCmpVersion: Int? = null,
    val adsystemPpid: String? = null,
    val adsystemBuid: String? = null,
    /** Custom parameters to add to ad tag URLs. Keys should NOT include the "adTagUrlParam_" prefix. */
    val adTagUrlParams: Map<String, String>? = null,
    /**
     * When true, the SDK persists playback position per clip and auto-seeks to the stored position
     * on the next load of the same clip ("Continue Watching"). Default off; opt in for long-form
     * detail screens and leave off for shorts feeds / autoplay carousels / ad-only flows.
     * The persisted position is also readable via [com.bluebillywig.bbnativeplayersdk.PlayHistoryManager.lastKnownPosition]
     * for rendering "% watched" badges without instantiating a player.
     */
    val continueWatching: Boolean? = null,
    /** Escape hatch for custom or undocumented options. */
    val custom: Map<String, Any?>? = null,
)

Type-safe configuration options for [BBNativePlayer].

Replaces the untyped Map<String, Any?> options parameter with compile-time checked properties. Use [custom] as an escape hatch for any options not yet covered by typed properties.

See also:

  • BBNativePlayer

Properties​

adTagUrlParams​

val adTagUrlParams: Map<String, String>?

Custom parameters to add to ad tag URLs. Keys should NOT include the "adTagUrlParam_" prefix.

continueWatching​

val continueWatching: Boolean?

When true, the SDK persists playback position per clip and auto-seeks to the stored position on the next load of the same clip ("Continue Watching"). Default off; opt in for long-form detail screens and leave off for shorts feeds / autoplay carousels / ad-only flows. The persisted position is also readable via [com.bluebillywig.bbnativeplayersdk.PlayHistoryManager.lastKnownPosition] for rendering "% watched" badges without instantiating a player.

custom​

val custom: Map<String, Any?>?

Escape hatch for custom or undocumented options.