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

    Interface ClipCompositionProps

    Props for the ClipComposition main component.

    interface ClipCompositionProps {
        autoSaveInterval?: number;
        colors?: Partial<ClipCompositionColors>;
        enableAudioPassthrough?: boolean;
        enableAutoSave?: boolean;
        enableDragReorder?: boolean;
        enableMarkers?: boolean;
        enableRecording?: boolean;
        enableRegions?: boolean;
        fileId?: string;
        fileLocation?: string;
        icons?: Partial<ClipCompositionIcons>;
        initialComposition?: ClipCompositionFile;
        labels?: Partial<ClipCompositionLabels>;
        maxClips?: number;
        maxHeight?: string | number;
        maxRecordingDuration?: number;
        onAutoSave?: (fileId: string) => void;
        onChange?: (composition: ClipCompositionFile) => void;
        onClipAdded?: (clip: ClipItem) => void;
        onClipRemoved?: (clipId: string) => void;
        onError?: (error: Error) => void;
        onSaveError?: (error: Error) => void;
        onTitleChange?: (title: string) => void;
        readOnly?: boolean;
        showHeader?: boolean;
        showToolbar?: boolean;
        styles?: Partial<ClipCompositionStyles>;
        sx?: SxProps<Theme>;
        title?: string;
    }
    Index

    Properties

    autoSaveInterval? colors? enableAudioPassthrough? enableAutoSave? enableDragReorder? enableMarkers? enableRecording? enableRegions? fileId? fileLocation? icons? initialComposition? labels? maxClips? maxHeight? maxRecordingDuration? onAutoSave? onChange? onClipAdded? onClipRemoved? onError? onSaveError? onTitleChange? readOnly? showHeader? showToolbar? styles? sx? title?

    Properties

    autoSaveInterval?: number

    Auto-save interval in milliseconds

    5000
    colors?: Partial<ClipCompositionColors>

    Custom colors

    enableAudioPassthrough?: boolean

    Enable audio passthrough

    false
    enableAutoSave?: boolean

    Enable auto-save

    true
    enableDragReorder?: boolean

    Enable drag-and-drop reorder

    true
    enableMarkers?: boolean

    Enable timeline markers/comments on clip players

    false
    enableRecording?: boolean

    Enable recording feature

    true
    enableRegions?: boolean

    Enable regions on clip players

    false
    fileId?: string

    Existing file ID for updates

    fileLocation?: string

    File storage location

    icons?: Partial<ClipCompositionIcons>

    Custom icons

    initialComposition?: ClipCompositionFile

    Initial composition to load

    labels?: Partial<ClipCompositionLabels>

    Custom labels

    maxClips?: number

    Maximum number of clips allowed

    20
    maxHeight?: string | number

    Maximum container height

    maxRecordingDuration?: number

    Maximum recording duration in seconds

    300
    onAutoSave?: (fileId: string) => void

    Called after auto-save completes

    onChange?: (composition: ClipCompositionFile) => void

    Called when composition changes

    onClipAdded?: (clip: ClipItem) => void

    Called when a clip is added

    onClipRemoved?: (clipId: string) => void

    Called when a clip is removed

    onError?: (error: Error) => void

    General error callback

    onSaveError?: (error: Error) => void

    Called when a save error occurs

    onTitleChange?: (title: string) => void

    Called when the composition title changes

    readOnly?: boolean

    Read-only mode

    false
    showHeader?: boolean

    Show header with title

    true
    showToolbar?: boolean

    Show toolbar

    true
    styles?: Partial<ClipCompositionStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx styling prop

    title?: string

    Title for the composition

    Settings

    Member Visibility

    On This Page

    Properties