Storyteller SDK Documentation/com.storyteller.ui.pager/StorytellerClipsFragment/Companion/create

create

fun create(configuration: Storyteller.StorytellerClipCollectionConfiguration, topLevelBackEnabled: Boolean = false, openReason: Storyteller.StorytellerClipsOpenReason? = null): StorytellerClipsFragment

Creates a new instance of StorytellerClipsFragment configured with a Storyteller.StorytellerClipCollectionConfiguration. For usage details, see the Storyteller Clips Fragment Documentation.

Return

A new, configured instance of StorytellerClipsFragment.

Parameters

configuration

The Storyteller.StorytellerClipCollectionConfiguration defining the collection, initial clip/category, and other display options. Embedded Clips disable bottom banners when configuration.adConfiguration is null.

topLevelBackEnabled

If true, enables a top-level back affordance and behavior, often delegating to Listener.onTopLevelBackPressed. If false, top-level back navigation might be suppressed or handled differently. Defaults to false.

openReason

The reason for opening this Clips collection, used for analytics. Defaults to null.

@JvmOverloads
fun create(collectionId: String, initialCategory: String? = null, startClipId: String? = null, topLevelBackEnabled: Boolean = false, isOpenedReasonDeeplink: Boolean = false, theme: UiTheme? = null, context: StorytellerAnalyticsContext? = null, adConfiguration: Storyteller.StorytellerClipsAdConfiguration = Storyteller.StorytellerClipsAdConfiguration(bottomBannerEnabled = false)): StorytellerClipsFragment

Creates a new instance of StorytellerClipsFragment. This factory method is suitable for programmatic creation and embedding of the fragment. For usage details, see the Storyteller Clips Fragment Documentation.

Return

A new, configured instance of StorytellerClipsFragment.

Parameters

collectionId

The ID of the Clips collection to display.

initialCategory

Optional ID of a category within the collection to display initially. If provided and valid, the fragment will navigate to this category after loading the collection.

startClipId

Optional ID of a specific Clip to start playback with.

topLevelBackEnabled

If true, enables a top-level back affordance. Behavior might depend on the Listener. Defaults to false.

adConfiguration

Ad behavior for this Clips presentation. Embedded Clips disable bottom banners by default while retaining the other Storyteller.StorytellerClipsAdConfiguration defaults.