Storyteller SDK Documentation/com.storyteller/Storyteller/StorytellerClipsAdConfiguration

StorytellerClipsAdConfiguration

data class StorytellerClipsAdConfiguration(val bottomBannerEnabled: Boolean = true, val preRollEnabled: Boolean = true, val betweenClipsAdProviderOrder: List<Storyteller.StorytellerAdProvider>? = null, val frequency: Int? = null, val initialIndex: Int? = null)

Configuration for ad behavior in one Clips presentation.

Constructors

constructor(bottomBannerEnabled: Boolean)

Preserves the original positional one-Boolean API, where the value controls bottom banners.

constructor(bottomBannerEnabled: Boolean, preRollEnabled: Boolean, betweenClipsAdProviderOrder: List<Storyteller.StorytellerAdProvider>?)

Preserves the three-property constructor from Android SDK 11.6.x.

constructor(bottomBannerEnabled: Boolean = true, preRollEnabled: Boolean = true, betweenClipsAdProviderOrder: List<Storyteller.StorytellerAdProvider>? = null, frequency: Int? = null, initialIndex: Int? = null)

Types

Companion

object Companion

Properties

betweenClipsAdProviderOrder

val betweenClipsAdProviderOrder: List<Storyteller.StorytellerAdProvider>? = null

Optional provider priority for ads shown between Clips. null preserves the SDK's existing module-order and custom-module behavior, an empty list disables standard between-Clip ads for this presentation, and a populated list restricts and orders recognized eligible providers. IMA, remote cadence, consent, and bottom banners remain independent. Cadence overrides apply only when remote settings select the eligible between-Clips strategy; they cannot enable ads or bypass the existing source, provider, consent, or player gates.

bottomBannerEnabled

val bottomBannerEnabled: Boolean = true

If true, bottom banner ads can be requested and rendered when remote settings enable them. Default is true.

frequency

val frequency: Int? = null

Optional interval between eligible between-Clip ad positions for this presentation. A positive value overrides the remote Clips frequency. null or an invalid value inherits the remote frequency.

initialIndex

val initialIndex: Int? = null

Optional first eligible standard Clips ad position for this presentation. 0 is the special opening-ad value; positive values are one-based content positions, so 2 schedules the first eligible slot after the second Clip. A non-negative value overrides the remote Clips initial index. null or an invalid value inherits the remote initial index.

preRollEnabled

val preRollEnabled: Boolean = true

If true, an eligible standard zero-index opening ad or configured IMA module can show before the initially opened Clip. If false, both opening paths are suppressed while later between-Clip cadence and bottom banners remain eligible. Default is true.

Functions

copy

fun copy(bottomBannerEnabled: Boolean): Storyteller.StorytellerClipsAdConfiguration

Preserves the original one-property data-class copy method for compiled integrations.

fun copy(bottomBannerEnabled: Boolean, preRollEnabled: Boolean, betweenClipsAdProviderOrder: List<Storyteller.StorytellerAdProvider>?): Storyteller.StorytellerClipsAdConfiguration

Preserves the three-property data-class copy method from Android SDK 11.6.x.