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

    Interface TranscriptionControlsProps

    Props for the TranscriptionControls component.

    Provides start/stop controls for live transcription. Typically used by room owners only.

    <TranscriptionControls
      client={client}
      isOwner={isOwner}
      isTranscribing={isTranscribing}
      onTranscriptionStart={(id) => console.log('Started:', id)}
      onTranscriptionStop={() => console.log('Stopped')}
    />
    interface TranscriptionControlsProps {
        client?: unknown;
        colors?: Partial<TranscriptionControlColors>;
        disabled?: boolean;
        iconOnly?: boolean;
        isOwner?: boolean;
        isTranscribing?: boolean;
        labels?: Partial<TranscriptionControlLabels>;
        onError?: (error: Error) => void;
        onStart?: () => void;
        onStop?: () => void;
        onTranscriptionStart?: (transcriptionId: string) => void;
        onTranscriptionStop?: () => void;
        showForNonOwner?: boolean;
        size?: "small" | "medium" | "large";
        sx?: SxProps<Theme>;
        variant?: "text" | "contained" | "outlined";
    }
    Index

    Properties

    client? colors? disabled? iconOnly? isOwner? isTranscribing? labels? onError? onStart? onStop? onTranscriptionStart? onTranscriptionStop? showForNonOwner? size? sx? variant?

    Properties

    client?: unknown

    Hiyve client instance. When used inside HiyveProvider, this is automatically populated from useClient().

    colors?: Partial<TranscriptionControlColors>

    Custom colors.

    disabled?: boolean

    Whether the button should be disabled.

    false
    iconOnly?: boolean

    Whether to show the button as an icon only.

    false
    isOwner?: boolean

    Whether the current user is the room owner. Only owners can control transcription.

    false
    isTranscribing?: boolean

    Whether transcription is currently active.

    false
    labels?: Partial<TranscriptionControlLabels>

    Custom labels for internationalization.

    onError?: (error: Error) => void

    Callback when an error occurs.

    onStart?: () => void

    Callback when transcription starts (simplified form for context mode). Called after startTranscription completes.

    onStop?: () => void

    Callback when transcription stops (simplified form for context mode). Called after stopTranscription completes.

    onTranscriptionStart?: (transcriptionId: string) => void

    Callback when transcription starts successfully. Receives the transcription ID.

    onTranscriptionStop?: () => void

    Callback when transcription stops.

    showForNonOwner?: boolean

    Override whether to show controls even if not owner. By default, controls are only shown to room owners.

    size?: "small" | "medium" | "large"

    Button size.

    'medium'
    sx?: SxProps<Theme>

    Additional MUI sx props.

    variant?: "text" | "contained" | "outlined"

    Button variant.

    'contained'

    Settings

    Member Visibility

    On This Page

    Properties