Storyteller SDK Documentation/com.storyteller/Storyteller/StorytellerClipsAdConfiguration

StorytellerClipsAdConfiguration

data class StorytellerClipsAdConfiguration(val preRollEnabled: Boolean = true, val bottomBannerEnabled: Boolean = true)

Configuration for Clips ad placements.

Remote settings and configured ad modules still decide whether ads are available. When preRollEnabled is true, the SDK requests opening pre-roll only when the remote Clips ad cadence initial index is explicitly 0. A missing or null initial index does not create an opening or later full-screen ad slot. When preRollEnabled is false, only the eligible opening pre-roll request is skipped; configured later between-Clip cadence is unchanged.

Full-screen Clips (e.g. openCollection) default both placements to true. Embedded Clips entry points (StorytellerEmbeddedClipsState, rememberStorytellerEmbeddedClipsState, and both StorytellerClipsFragment.create overloads) are opt-in: when no configuration is supplied both placements default to false.

Constructors

Link copied to clipboard
constructor(preRollEnabled: Boolean = true, bottomBannerEnabled: Boolean = true)

Properties

Link copied to clipboard
val bottomBannerEnabled: Boolean = true

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

Link copied to clipboard
val preRollEnabled: Boolean = true

If true, opening pre-roll can be requested before the first Clip when the remote initial index is explicitly 0. Default is true.