Storyteller SDK Documentation/com.storyteller.ui.compose.embedded/StorytellerEmbeddedClipsState

StorytellerEmbeddedClipsState

data class StorytellerEmbeddedClipsState(collectionId: String, topLevelBack: Boolean, clipId: String? = null, initialCategory: String? = null, isOpenedReasonDeeplink: Boolean = false, clipsTheme: UiTheme? = null, context: StorytellerAnalyticsContext? = null) : CoroutineScope

A state holder for the StorytellerEmbeddedClips composable. It manages the underlying StorytellerClipsFragmentOld instance, its lifecycle, and provides an interface for interacting with the embedded Clips player, such as controlling playback, navigation, and handling insets.

This state is typically created and remembered using rememberStorytellerEmbeddedClipsStateOld. For more information on embedding Clips, including using StorytellerClipsFragmentOld for View-based systems, see the Storyteller Clips Fragment Documentation.

Parameters

collectionId

The ID of the Clips collection to be displayed.

topLevelBack

Determines if the embedded player should handle back navigation at its top level or delegate it to the host.

clipId

Optional ID of a specific Clip to start playing within the collection.

initialCategory

Optional ID of a category to display initially within the collection.

Constructors

StorytellerEmbeddedClipsState

constructor(collectionId: String, topLevelBack: Boolean, clipId: String? = null, initialCategory: String? = null, isOpenedReasonDeeplink: Boolean = false, clipsTheme: UiTheme? = null, context: StorytellerAnalyticsContext? = null)