Storyteller SDK Documentation/com.storyteller/Storyteller/StorytellerClipCollectionConfiguration

StorytellerClipCollectionConfiguration

data class StorytellerClipCollectionConfiguration(val collectionId: String, val categoryId: String? = null, val clipId: String? = null, val context: StorytellerAnalyticsContext? = null, val adConfiguration: Storyteller.StorytellerClipsAdConfiguration? = null)

Configuration for opening a collection of Clips. For more details on opening the Storyteller player, see the Opening the Player Documentation.

Constructors

constructor(collectionId: String, categoryId: String? = null, clipId: String? = null, context: StorytellerAnalyticsContext? = null)

constructor(collectionId: String, categoryId: String? = null, clipId: String? = null, context: StorytellerAnalyticsContext? = null, adConfiguration: Storyteller.StorytellerClipsAdConfiguration? = null)

Properties

adConfiguration

val adConfiguration: Storyteller.StorytellerClipsAdConfiguration? = null

Optional ad placement controls for this Clips presentation. Defaults to null. When null, full-screen Clips (openCollection) keep both placements enabled, while Embedded Clips (StorytellerClipsFragment.create) treat an omitted configuration as opt-in (both placements disabled). Pass a concrete StorytellerClipsAdConfiguration to set placements explicitly.

categoryId

val categoryId: String? = null

Optional ID of a category associated with this Clips collection. Can be used for context or analytics.

clipId

val clipId: String? = null

Optional ID of a specific Clip to start playing within the collection. If null, the collection typically starts from the first Clip.

collectionId

val collectionId: String

The ID of the Clips collection to open. This is mandatory.

context

val context: StorytellerAnalyticsContext? = null

Optional analytics context sent with Clips events.