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

    Interface UseClipRecorderResult

    Result of useClipRecorder hook.

    interface UseClipRecorderResult {
        audioDevices: MediaDeviceInfo[];
        discard: () => void;
        duration: number;
        error: string | null;
        initialize: () => Promise<void>;
        mediaType: ClipMediaType;
        pause: () => void;
        previewStream: MediaStream | null;
        previewUrl: string | null;
        recordedBlob: Blob | null;
        reset: () => void;
        resume: () => void;
        save: (
            client: ClipFileClient,
            name: string,
            location: string,
            userId: string,
            userName?: string,
        ) => Promise<ClipItem>;
        selectedAudioDevice: string;
        selectedVideoDevice: string;
        setMediaType: (type: ClipMediaType) => void;
        setSelectedAudioDevice: (deviceId: string) => void;
        setSelectedVideoDevice: (deviceId: string) => void;
        start: (startAt?: number) => void;
        state: RecorderState;
        stop: () => void;
        videoDevices: MediaDeviceInfo[];
    }
    Index

    Properties

    audioDevices discard duration error initialize mediaType pause previewStream previewUrl recordedBlob reset resume save selectedAudioDevice selectedVideoDevice setMediaType setSelectedAudioDevice setSelectedVideoDevice start state stop videoDevices

    Properties

    audioDevices: MediaDeviceInfo[]

    Available audio input devices

    discard: () => void

    Discard recorded media

    duration: number

    Recording duration in seconds

    error: string | null

    Error message if any

    initialize: () => Promise<void>

    Initialize devices and request permissions

    mediaType: ClipMediaType

    Selected media type

    pause: () => void

    Pause recording

    previewStream: MediaStream | null

    Live media stream for preview

    previewUrl: string | null

    Preview URL for recorded blob

    recordedBlob: Blob | null

    Recorded blob (available after stop)

    reset: () => void

    Reset to idle state

    resume: () => void

    Resume recording

    save: (
        client: ClipFileClient,
        name: string,
        location: string,
        userId: string,
        userName?: string,
    ) => Promise<ClipItem>

    Save the recorded clip (upload to S3)

    selectedAudioDevice: string

    Selected audio device ID

    selectedVideoDevice: string

    Selected video device ID

    setMediaType: (type: ClipMediaType) => void

    Set media type (audio/video)

    setSelectedAudioDevice: (deviceId: string) => void

    Set selected audio device

    setSelectedVideoDevice: (deviceId: string) => void

    Set selected video device

    start: (startAt?: number) => void

    Start recording. Pass startAt (a performance.now() timestamp) to delay the actual MediaRecorder.start() call until that wall-clock — useful when you want the encoder's t=0 to line up with another scheduled event (e.g. existing-clip playback). The preview stream is acquired immediately regardless so device indicators come up right away.

    state: RecorderState

    Current recorder state

    stop: () => void

    Stop recording

    videoDevices: MediaDeviceInfo[]

    Available video input devices

    Settings

    Member Visibility

    On This Page

    Properties