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

    Interface ClipPlayerProps

    Props for ClipPlayer.

    interface ClipPlayerProps {
        clip: ClipItem;
        colors: ClipCompositionColors;
        editable: boolean;
        enableAudioPassthrough: boolean;
        enableMarkers?: boolean;
        enableRegions: boolean;
        icons: ClipCompositionIcons;
        isPlayingAll?: boolean;
        labels: ClipCompositionLabels;
        markersUserId?: string;
        onEnded?: (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;
        onPause?: (clipId: string) => void;
        onPlay?: (clipId: string) => void;
        onRegionChange?: (clipId: string, region: RegionData) => void;
        onRegionDelete?: (clipId: string, regionId: string) => void;
        onRemove?: (clipId: string) => void;
        onVolumeChange?: (clipId: string, volume: number) => void;
        styles: ClipCompositionStyles;
    }
    Index

    Properties

    clip: ClipItem
    editable: boolean
    enableAudioPassthrough: boolean
    enableMarkers?: boolean

    Enable timeline markers/comments

    enableRegions: boolean
    isPlayingAll?: boolean

    When true, programmatically start playback

    markersUserId?: string

    Current user ID for marker edit/delete permissions

    onEnded?: (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
    onPause?: (clipId: string) => void
    onPlay?: (clipId: string) => void
    onRegionChange?: (clipId: string, region: RegionData) => void
    onRegionDelete?: (clipId: string, regionId: string) => void
    onRemove?: (clipId: string) => void
    onVolumeChange?: (clipId: string, volume: number) => void