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

    Interface UseRecordingFeaturesOptions

    Options for the useRecordingFeatures hook

    interface UseRecordingFeaturesOptions {
        disabled?: boolean;
        hasClient: boolean;
        isRecording: boolean;
        isRecordingStarting: boolean;
        isStreaming: boolean;
        isStreamingStarting: boolean;
        moodAnalysis: MoodAnalysis | null;
        onError?: (error: Error, operation: string) => void;
        onIntelligenceConfigChange?: (config: IntelligenceConfig) => void;
        onIntelligenceModeStarted?: (config: IntelligenceConfig) => void;
        onIntelligenceModeStopped?: () => void;
        onMoodAnalysisDisabled?: () => void;
        onMoodAnalysisEnabled?: () => void;
        onRecordingStarted?: (options: RecordingOptions) => void;
        onRecordingStopped?: () => void;
        onStreamingStarted?: () => void;
        onStreamingStopped?: () => void;
        recordingDuration?: number;
        startRecording: (options: RecordingOptions) => Promise<boolean>;
        startStreaming: (
            config: {
                createMp4?: boolean;
                mode?: "single" | "multi";
                rtmpUrl?: string;
            },
        ) => Promise<void>;
        stopRecording: () => void;
        stopStreaming: () => Promise<void>;
        streamingConfig?: {
            createMp4?: boolean;
            mode?: "single" | "multi";
            rtmpUrl?: string;
        };
        streamingDuration?: number;
        userIntelligenceConfig?: IntelligenceConfig;
    }
    Index

    Properties

    disabled? hasClient isRecording isRecordingStarting isStreaming isStreamingStarting moodAnalysis onError? onIntelligenceConfigChange? onIntelligenceModeStarted? onIntelligenceModeStopped? onMoodAnalysisDisabled? onMoodAnalysisEnabled? onRecordingStarted? onRecordingStopped? onStreamingStarted? onStreamingStopped? recordingDuration? startRecording startStreaming stopRecording stopStreaming streamingConfig? streamingDuration? userIntelligenceConfig?

    Properties

    disabled?: boolean

    Whether controls are disabled

    hasClient: boolean

    Client availability check

    isRecording: boolean

    Whether recording is currently active (from useRecording)

    isRecordingStarting: boolean

    Whether recording is starting (from useRecording)

    isStreaming: boolean

    Whether streaming is active (from useStreaming)

    isStreamingStarting: boolean

    Whether streaming is starting (from useStreaming)

    moodAnalysis: MoodAnalysis | null

    Mood analysis from provider (null if not available)

    onError?: (error: Error, operation: string) => void
    onIntelligenceConfigChange?: (config: IntelligenceConfig) => void

    Callbacks

    onIntelligenceModeStarted?: (config: IntelligenceConfig) => void
    onIntelligenceModeStopped?: () => void
    onMoodAnalysisDisabled?: () => void
    onMoodAnalysisEnabled?: () => void
    onRecordingStarted?: (options: RecordingOptions) => void
    onRecordingStopped?: () => void
    onStreamingStarted?: () => void
    onStreamingStopped?: () => void
    recordingDuration?: number

    Recording duration in seconds (from useRecording)

    startRecording: (options: RecordingOptions) => Promise<boolean>

    Start recording function (from useRecording)

    startStreaming: (
        config: {
            createMp4?: boolean;
            mode?: "single" | "multi";
            rtmpUrl?: string;
        },
    ) => Promise<void>

    Start streaming function (from useStreaming)

    stopRecording: () => void

    Stop recording function (from useRecording)

    stopStreaming: () => Promise<void>

    Stop streaming function (from useStreaming)

    streamingConfig?: {
        createMp4?: boolean;
        mode?: "single" | "multi";
        rtmpUrl?: string;
    }

    Streaming config

    streamingDuration?: number

    Streaming duration in seconds (from useStreaming)

    userIntelligenceConfig?: IntelligenceConfig

    User-provided intelligence config

    Settings

    Member Visibility

    On This Page

    Properties