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

    Interface ClipGridProps

    Props for ClipGrid.

    interface ClipGridProps {
        audioPassthroughActive?: boolean;
        canRemoveClip?: (clip: ClipItem) => boolean;
        clips: ClipItem[];
        colors: ClipCompositionColors;
        editable: boolean;
        enableAudioPassthrough: boolean;
        enableDragReorder: boolean;
        enableMarkers?: boolean;
        enableRegions: boolean;
        icons: ClipCompositionIcons;
        isPlayingAll?: boolean;
        isRecorderActive?: boolean;
        labels: ClipCompositionLabels;
        markersUserId?: string;
        onClipEnded?: (clipId: string) => void;
        onClipPause?: (clipId: string) => void;
        onClipPlay?: (clipId: string) => void;
        onError?: (error: Error) => void;
        onMarkerAdd?: (clipId: string, marker: TimelineMarkerData) => void;
        onMarkerChange?: (clipId: string, marker: TimelineMarkerData) => void;
        onMarkerDelete?: (clipId: string, markerId: string) => void;
        onNameChange: (clipId: string, name: string) => void;
        onRegionChange?: (clipId: string, region: RegionData) => void;
        onRegionDelete?: (clipId: string, regionId: string) => void;
        onRemove: (clipId: string) => void;
        onReorder: (clips: ClipItem[]) => void;
        onVolumeChange?: (clipId: string, volume: number) => void;
        ownerName?: string;
        playStartTime?: number | null;
        resolveClipOwnerName?: (clip: ClipItem) => string | undefined;
        rewindSignal?: number;
        styles: ClipCompositionStyles;
    }
    Index

    Properties

    audioPassthroughActive? canRemoveClip? clips colors editable enableAudioPassthrough enableDragReorder enableMarkers? enableRegions icons isPlayingAll? isRecorderActive? labels markersUserId? onClipEnded? onClipPause? onClipPlay? onError? onMarkerAdd? onMarkerChange? onMarkerDelete? onNameChange onRegionChange? onRegionDelete? onRemove onReorder onVolumeChange? ownerName? playStartTime? resolveClipOwnerName? rewindSignal? styles

    Properties

    audioPassthroughActive?: boolean

    See ClipPlayerProps.audioPassthroughActive — forwarded to every player.

    canRemoveClip?: (clip: ClipItem) => boolean

    Per-clip remove permission. Called for each clip to decide whether its delete button renders. Omit to allow removal of every clip (subject to editable). See ClipPlayerProps.removable.

    clips: ClipItem[]
    colors: ClipCompositionColors
    editable: boolean
    enableAudioPassthrough: boolean
    enableDragReorder: boolean
    enableMarkers?: boolean

    Enable timeline markers/comments

    enableRegions: boolean
    icons: ClipCompositionIcons
    isPlayingAll?: boolean

    When true, all clips should start playback

    isRecorderActive?: boolean

    When true, the recorder panel is visible — hides the empty state

    labels: ClipCompositionLabels
    markersUserId?: string

    Current user ID for marker edit/delete permissions

    onClipEnded?: (clipId: string) => void
    onClipPause?: (clipId: string) => void
    onClipPlay?: (clipId: string) => void
    onError?: (error: Error) => void
    onMarkerAdd?: (clipId: string, marker: TimelineMarkerData) => void
    onMarkerChange?: (clipId: string, marker: TimelineMarkerData) => void
    onMarkerDelete?: (clipId: string, markerId: string) => void
    onNameChange: (clipId: string, name: string) => void
    onRegionChange?: (clipId: string, region: RegionData) => void
    onRegionDelete?: (clipId: string, regionId: string) => void
    onRemove: (clipId: string) => void
    onReorder: (clips: ClipItem[]) => void
    onVolumeChange?: (clipId: string, volume: number) => void
    ownerName?: string

    See ClipPlayerProps.ownerName — forwarded to every player.

    playStartTime?: number | null

    Master-clock anchor for synchronised playback. Forwarded to every mounted ClipPlayer so they all schedule play() against the same performance.now() timestamp. See ClipPlayerProps.playStartTime.

    resolveClipOwnerName?: (clip: ClipItem) => string | undefined

    See ClipCompositionProps.resolveClipOwnerName — forwarded to every player.

    rewindSignal?: number

    See ClipPlayerProps.rewindSignal — forwarded to every player.

    styles: ClipCompositionStyles

    Settings

    Member Visibility

    On This Page

    Properties