StorytellerClipCollectionConfiguration

data class StorytellerClipCollectionConfiguration(val collectionId: String, val categoryId: String? = null, val clipId: String? = null, val offset: Int? = null, val context: StorytellerAnalyticsContext? = 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, offset: Int? = null, context: StorytellerAnalyticsContext? = null)

Properties

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

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

Link copied to clipboard
Link copied to clipboard
val offset: Int? = null

Optional offset to start displaying clips from a specific position in the collection. Default is 0 (start from beginning).