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

    Interface PrebuiltLobbyProps

    interface PrebuiltLobbyProps {
        colors?: Partial<PrebuiltLobbyColors>;
        defaultAudioProfile?: AudioProfile;
        defaultName?: string;
        labels?: Partial<PrebuiltLobbyLabels>;
        onError?: (error: Error) => void;
        onJoin: (displayName: string) => void;
        persistDeviceSelection?: boolean;
        showAdvanced?: boolean;
        showMicrophoneBoost?: boolean;
        showNameInput?: boolean;
        showPreview?: boolean;
    }
    Index

    Properties

    colors? defaultAudioProfile? defaultName? labels? onError? onJoin persistDeviceSelection? showAdvanced? showMicrophoneBoost? showNameInput? showPreview?

    Properties

    colors?: Partial<PrebuiltLobbyColors>

    Custom colors

    defaultAudioProfile?: AudioProfile

    The capture profile the preview shows and measures with until the user chooses one. Inside HiyveProvider it defaults to the room's current profile, so the lobby matches the app's audioProfile option.

    defaultName?: string

    Default display name

    labels?: Partial<PrebuiltLobbyLabels>

    Custom labels

    onError?: (error: Error) => void

    Called when errors occur

    onJoin: (displayName: string) => void

    Called when user clicks join

    persistDeviceSelection?: boolean

    Persist device selection (camera/mic/speaker) across sessions

    showAdvanced?: boolean

    Show the device preview's Advanced section, where the user chooses how the microphone is captured (voice / music / instrument). With persistDeviceSelection the choice is remembered and applied at join.

    true
    showMicrophoneBoost?: boolean

    Show the microphone boost slider in the preview's Advanced section. Inside HiyveProvider the slider starts from the room's current boost.

    false
    showNameInput?: boolean

    Show the name input field. When false, defaultName is passed directly to onJoin.

    true
    showPreview?: boolean

    Show device preview

    Settings

    Member Visibility

    On This Page

    Properties