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

    Function useActiveRooms

    • Access active room discovery state and actions.

      Returns {
          advertiseRoom: (
              cloudClient: {
                  advertiseRoom(options: AdvertiseRoomOptions): Promise<void>;
              },
              options: AdvertiseRoomOptions,
          ) => Promise<void>;
          clearError: () => void;
          connectActiveRooms: (streamUrl: string) => void;
          disconnectActiveRooms: () => void;
          error: string | null;
          fetchActiveRooms: (
              cloudClient: { getActiveRooms(userId?: string): Promise<ActiveRoom[]> },
              userId?: string,
          ) => Promise<ActiveRoom[]>;
          isConnected: boolean;
          isLoading: boolean;
          removeAdvertisedRoom: (
              cloudClient: { removeAdvertisedRoom(roomName: string): Promise<void> },
              roomName: string,
          ) => Promise<void>;
          rooms: ActiveRoom[];
          updateAdvertisedRoom: (
              cloudClient: {
                  updateAdvertisedRoom(
                      roomName: string,
                      updates: Partial<AdvertiseRoomOptions>,
                  ): Promise<void>;
              },
              roomName: string,
              updates: Partial<AdvertiseRoomOptions>,
          ) => Promise<void>;
      }

      Object containing active rooms state and discovery actions

      Active rooms are live rooms advertised by their owners for discovery. Use connectActiveRooms to open an SSE stream for real-time updates, or fetchActiveRooms for a one-shot query.