Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseTimelineMarkersOptions

    interface UseTimelineMarkersOptions {
        currentTime: number;
        currentUserId?: string;
        getCurrentTime?: () => number;
        markers?: TimelineMarkerData[];
        onMarkerAdd?: (marker: TimelineMarkerData) => void;
        onMarkerChange?: (marker: TimelineMarkerData) => void;
        onMarkerDelete?: (markerId: string) => void;
    }
    Index

    Properties

    currentTime: number

    Cached playhead position used for read-only display (e.g. fallback when getCurrentTime is not supplied). Note that consumers often round this to whole seconds for re-render budget — it's not a precise enough value to anchor a marker to a click position.

    currentUserId?: string
    getCurrentTime?: () => number

    Live accessor for the precise media time at the moment the marker is added. Preferred over currentTime because the cached state lags behind a click-seek and is typically rounded — using it causes the marker to land at the integer-second grid instead of exactly where the user clicked.

    markers?: TimelineMarkerData[]
    onMarkerAdd?: (marker: TimelineMarkerData) => void
    onMarkerChange?: (marker: TimelineMarkerData) => void
    onMarkerDelete?: (markerId: string) => void