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

Link copied to clipboard
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

Link copied to clipboard
val adConfiguration: Storyteller.StorytellerClipsAdConfiguration? = null

Optional ad control for this Clips presentation. Defaults to null. Full-screen Clips (openCollection) use StorytellerClipsAdConfiguration defaults, while Embedded Clips (StorytellerClipsFragment.create) disable bottom banners when omitted.

Link copied to clipboard
val categoryId: String? = null

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

Link copied to clipboard
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.

Link copied to clipboard
val collectionId: String

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

Link copied to clipboard
val context: StorytellerAnalyticsContext? = null

Optional analytics context sent with Clips events.