Limeplay - Open Source Video Player UI ComponentsLimeplay

Hooks

Feature hooks and utilities for media player state management.

Limeplay hooks fall into two categories:

Feature Hooks

Each feature hook provides a store slice, event listeners, and optionally a Setup component. Register them in createMediaKit.

HookStore KeyDescription
use-mediamediaBase media element reference and idle state
use-playerplayerShaka Player initialization and asset loading
use-playbackplaybackPlay/pause, status, loop, error state
use-volumevolumeVolume level, mute, audio detection
use-timelinetimelineCurrent time, duration, seeking, buffered ranges
use-playlistplaylistQueue management, shuffle, repeat modes
use-playback-rateplaybackRatePlayback speed control
use-picture-in-picturepictureInPicturePiP mode toggle
use-captionscaptionsText track management
use-assetassetHigher-order hook combining player + playlist

Utility Hooks

Standalone hooks that don't require feature registration:

HookDescription
use-seekSeek by offset (±N seconds)
use-idleDetect user inactivity
use-intervalsetInterval with auto-cleanup
use-track-eventsPointer event handling for sliders

On this page