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

    Interface ClipToolbarProps

    Props for ClipToolbar.

    interface ClipToolbarProps {
        clipCount: number;
        collaborationMode: CollaborationMode;
        colors: ClipCompositionColors;
        enableAudioPassthrough?: boolean;
        enableRecording: boolean;
        icons: ClipCompositionIcons;
        isOwner: boolean;
        isPassthroughAllActive?: boolean;
        isPlayingAll: boolean;
        labels: ClipCompositionLabels;
        lockMode: CompositionLockMode;
        maxClips: number;
        onImportMedia?: () => void;
        onOpenSettings?: () => void;
        onPlayAll: (scheduledStart?: number) => void;
        onRewindAll?: () => void;
        onStopAll: () => void;
        onToggleCollaboration: () => void;
        onToggleLock: () => void;
        onTogglePassthroughAll?: () => void;
        onToggleRecorder: () => void;
        readOnly: boolean;
        showRecorder: boolean;
    }
    Index

    Properties

    clipCount collaborationMode colors enableAudioPassthrough? enableRecording icons isOwner isPassthroughAllActive? isPlayingAll labels lockMode maxClips onImportMedia? onOpenSettings? onPlayAll onRewindAll? onStopAll onToggleCollaboration onToggleLock onTogglePassthroughAll? onToggleRecorder readOnly showRecorder

    Properties

    clipCount: number
    collaborationMode: CollaborationMode
    colors: ClipCompositionColors
    enableAudioPassthrough?: boolean

    Whether audio passthrough controls are available on this composition (mirrors ClipCompositionProps.enableAudioPassthrough). Gates the passthrough-all toggle.

    false
    enableRecording: boolean
    icons: ClipCompositionIcons
    isOwner: boolean
    isPassthroughAllActive?: boolean

    Current state of the passthrough-all toggle.

    false
    isPlayingAll: boolean
    labels: ClipCompositionLabels
    lockMode: CompositionLockMode
    maxClips: number
    onImportMedia?: () => void

    Open the consumer's media picker to import existing files as clips. Shown next to the recorder toggle, gated on the same can-add rule. Omit to hide the button. See ClipCompositionProps.onImportMedia.

    onOpenSettings?: () => void

    Open the recording-settings dialog (mic / camera selection).

    onPlayAll: (scheduledStart?: number) => void

    scheduledStart: optional performance.now() timestamp at which playback should be considered position 0. The toolbar's Play All always omits it (composition picks a default lookahead); the recorder passes a value to align Play All with its own MediaRecorder.start() so the new recording's t=0 lines up with the existing clips' t=0 within JS scheduler tolerance.

    onRewindAll?: () => void

    Rewind every clip to the start. When synchronised playback is in flight, the composition restarts it from the top on a fresh master clock. Omit to hide the rewind-all button.

    onStopAll: () => void
    onToggleCollaboration: () => void
    onToggleLock: () => void
    onTogglePassthroughAll?: () => void

    Toggle audio passthrough on every clip together. Omit to hide the passthrough-all button.

    onToggleRecorder: () => void
    readOnly: boolean
    showRecorder: boolean

    Settings

    Member Visibility

    On This Page

    Properties