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

    Function WaitingRoomAdmittance

    • WaitingRoomAdmittance - Host controls for managing the waiting room.

      Parameters

      Returns Element | null

      This component displays a list of participants waiting to be admitted to the room. Hosts can admit or reject individual participants, or admit all at once.

      Context-aware: When used inside HiyveProvider, the component automatically:

      • Gets waiting users from useWaitingRoom() hook
      • Connects admit/reject actions to context functions
      • Shows only for room owners (returns null for non-owners)
      • Supports auto-admitting system users (recorders, streamers, transcribers)

      When used outside HiyveProvider (or with explicit props), pass participants, onAdmit, and onReject directly.

      The component supports three display variants:

      • popover: Shows as a dropdown attached to an anchor element
      • inline: Renders inline as part of the page layout
      • dialog: Shows as a modal dialog

      Context-connected usage (inside HiyveProvider):

      <HiyveProvider generateRoomToken={generateToken}>
      <WaitingRoomAdmittance
      variant="popover"
      anchorEl={anchorEl}
      open={open}
      onClose={() => setOpen(false)}
      autoAdmitSystemUsers={true}
      />
      </HiyveProvider>

      Manual prop-based usage:

      <WaitingRoomAdmittance
      participants={waitingList}
      onAdmit={handleAdmit}
      onReject={handleReject}
      variant="popover"
      anchorEl={anchorEl}
      open={Boolean(anchorEl)}
      onClose={() => setAnchorEl(null)}
      />

      With audio notification:

      <WaitingRoomAdmittance
      playNotificationSound={true}
      notificationSoundUrl="/sounds/notification.mp3"
      autoAdmitSystemUsers={true}
      />