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

    Interface RecordingState

    Recording state for meeting recordings.

    Tracks whether a recording is in progress and provides the recording ID and start time for duration calculations.

    Recording is asynchronous - when startRecording() is called, the recording doesn't start immediately. Instead:

    1. isRecordingStarting becomes true
    2. A recording bot is launched on the server
    3. When the bot joins and starts recording, RECORDING_STATE_CHANGED event fires
    4. isRecording becomes true and isRecordingStarting becomes false

    Use isRecordingStarting to show a spinner or loading indicator while waiting for the recording to actually begin.

    Recording indicator with loading state:

    function RecordingIndicator() {
      const { isRecording, isRecordingStarting, recordingDuration } = useRecording();

      if (isRecordingStarting) {
        return <div className="recording-starting">⏳ Starting recording...</div>;
      }

      if (!isRecording) return null;

      const minutes = Math.floor(recordingDuration / 60);
      const seconds = recordingDuration % 60;

      return (
        <div className="recording">
          🔴 REC {minutes}:{seconds.toString().padStart(2, '0')}
        </div>
      );
    }
    • RecordingOptions for recording configuration
    • useRecording for the recording hook
    interface RecordingState {
        error: string | null;
        isRecording: boolean;
        isRecordingStarting: boolean;
        recordingId: string | null;
        recordingStartTime: Date | null;
        responseId: string | null;
    }
    Index

    Properties

    error isRecording isRecordingStarting recordingId recordingStartTime responseId

    Properties

    error: string | null

    Error message if recording failed to start or encountered an error, null otherwise

    isRecording: boolean

    Whether a recording is currently in progress

    isRecordingStarting: boolean

    Whether a recording start request is in progress. True from when startRecording() is called until RECORDING_STATE_CHANGED confirms start.

    recordingId: string | null

    Server-assigned recording ID, null if not recording

    recordingStartTime: Date | null

    When the recording started, null if not recording

    responseId: string | null

    OpenAI Responses API context ID created by the recording bot. Used for querying AI against the accumulated transcript context. Only available when transcription is enabled with useContext: true.

    Settings

    Member Visibility

    On This Page

    Properties