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

Package-level declarations

Types

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.

StorytellerFollowableCategoryCustomScreen

@Stable

data class StorytellerFollowableCategoryCustomScreen(val modifier: Modifier, val category: StorytellerCategory, val onBackClicked: () -> Unit)

A data class that provides the necessary information and callbacks for a client application to render a custom screen for a followable category. This is provided by the SDK when the StorytellerDelegate.customScreenForCategory() method is invoked. For more information on implementing custom category screens, see the Storyteller Delegates Documentation.

Functions

rememberStorytellerEmbeddedClipsState

@Composable

fun rememberStorytellerEmbeddedClipsState(collectionId: String, topLevelBack: Boolean, clipId: String? = null, initialCategory: String? = null, openedReason: Storyteller.StorytellerClipsOpenReason? = null, clipsTheme: UiTheme? = null, context: StorytellerAnalyticsContext? = null): StorytellerEmbeddedClipsState

StorytellerEmbeddedClips

@Composable

fun StorytellerEmbeddedClips(state: StorytellerEmbeddedClipsState, modifier: Modifier = Modifier)

A Composable function for embedding a Storyteller Clips player within a Jetpack Compose UI. This component displays a collection of video Clips, adapting its size to maintain a 9:16 aspect ratio while fitting within the constraints of its parent layout. It handles loading states and can display either a direct Clips feed or a tabbed interface for "For You" and "Following" feeds if enabled via the StorytellerEmbeddedClipsStateOld.