shortkit_flutter library
Classes
- CaptionCue
- A single caption cue with text and timing information.
- CaptionTrack
- A single caption track associated with a content item.
- CarouselImage
- A single image within a carousel.
- CarouselOverlayConfig
- Configuration for carousel overlay rendering.
- CarouselOverlayConfigCustom
- A custom carousel overlay identified by name.
- CarouselOverlayConfigNone
- No carousel overlay is rendered.
- ContentItem
- A content item representing a video in the feed.
- FeedCallbacks
- Callback set registered per feed instance.
- FeedConfig
- FeedFilter
- Filter criteria for feed content.
- FeedHeight
- How the feed height is determined.
- FeedHeightFullscreen
- The feed occupies the full screen height.
- FeedHeightPercentage
- The feed occupies a percentage of the available height.
- FeedInput
- FeedInputImageCarousel
- FeedInputVideo
- FeedInputVideoCarousel
- FeedScrollPhase
- Describes the current scroll phase of the feed.
- FeedTransitionEvent
- Event emitted during feed scroll transitions.
- FormatChangeEvent
- Event emitted when video format changes (bitrate/resolution).
- ImageCarouselItem
- An image carousel item for custom feeds.
- LoopEvent
- Event emitted when a video loops.
- OverlayConfig
- Configuration for video overlay rendering.
- OverlayConfigCustom
- A custom overlay identified by name.
- OverlayConfigNone
- No overlay is rendered.
- OverlayState
- State passed to overlay components for rendering.
- PlayerConfig
- Configuration for a standalone ShortKit player.
- PlayerTime
- Current playback time information.
- ShortKit
- Static accessors for retrieving a ShortKitController from the widget tree.
- ShortKitController
- The primary public API for ShortKit.
- ShortKitFeed
- A platform view widget that displays a ShortKit video feed.
- ShortKitFeedController
- Per-feed controller that generates a stable UUID feedId and provides methods to manage feed items and filters for a specific feed instance.
- ShortKitOverlayCommands
- Player commands available to overlay widgets.
- ShortKitOverlayCommandsProvider
- InheritedWidget that provides the overlay method channel to descendant widgets.
- ShortKitOverlayEngine
- Registry and entry point for ShortKit overlay Flutter engines.
- ShortKitPlayer
- A platform view widget that displays a single ShortKit video player.
- ShortKitProvider
- Provides a ShortKitController to descendant widgets via InheritedWidget.
- ShortKitWidget
- A platform view widget that displays a ShortKit carousel widget.
- StoryboardData
- Storyboard data for seek thumbnail previews.
- StoryboardTile
- A single tile position within a storyboard sprite sheet.
- SurveyMode
- Survey mode configuration for the feed.
- SurveyModeNone
- No survey is shown.
- SurveyModeTemplate
- A survey using a named template.
- SurveyOption
- A selectable option within a survey.
- VideoCarouselItem
- A video carousel feed item containing multiple videos.
- VideoCarouselOverlayConfig
- Configuration for video carousel overlay rendering.
- VideoCarouselOverlayConfigCustom
- A custom video carousel overlay identified by name.
- VideoCarouselOverlayConfigNone
- No video carousel overlay is rendered.
- VideoCarouselOverlayState
- State passed to video carousel overlay builders.
- WidgetConfig
- Configuration for a ShortKit widget (multi-card carousel).
Enums
- CaptionSource
- Source type for a caption track.
- ContentSignal
- A signal indicating user sentiment toward content.
- FeedSource
- PlayerClickAction
- Action performed when the player is tapped.
- PlayerState
- The current state of the video player.
- ScrollAxis
- Scroll direction for the feed.
- ScrollPhase
- Phase of a feed scroll gesture.
Typedefs
- ShortKitCarouselOverlayBuilder = Widget Function(BuildContext context, ImageCarouselItem item, bool isActive, int activeImageIndex)
- Builder for image carousel overlay widgets.
- ShortKitOverlayBuilder = Widget Function(BuildContext context, ContentItem item, OverlayState state)
- Builder for video overlay widgets.
- ShortKitVideoCarouselOverlayBuilder = Widget Function(BuildContext context, VideoCarouselOverlayState state)
- Builder for video carousel overlay widgets.