mediasfu-reactjs
Version:
MediaSFU Prebuilt ReactJS SDK - Compatible with React 18 & 19, TypeScript & JavaScript
32 lines • 1.52 kB
TypeScript
import { WaitingRoomParticipant } from '../../@types/types';
export interface AllWaitingRoomMembersOptions {
waitingParticipants: WaitingRoomParticipant[];
updateWaitingRoomList: (participants: WaitingRoomParticipant[]) => void;
updateTotalReqWait: (totalReqs: number) => void;
}
export type AllWaitingRoomMembersType = (options: AllWaitingRoomMembersOptions) => Promise<void>;
/**
* Updates the waiting room participants list and the total count of waiting room participants.
*
* @param {Object} options - The options object.
* @param {Array} options.waitingParticipants - An array of participants currently in the waiting room.
* @param {Function} options.updateWaitingRoomList - A function to update the waiting room participants list.
* @param {Function} options.updateTotalReqWait - A function to update the total count of waiting room participants.
* @returns {Promise<void>} A promise that resolves when the updates are complete.
*
* @example
* ```typescript
* const participants = [
* { name: "Alice", waitingSince: "10:30" },
* { name: "Bob", waitingSince: "10:35" },
* ];
*
* await allWaitingRoomMembers({
* waitingParticipants: participants,
* updateWaitingRoomList: setWaitingRoomParticipants,
* updateTotalReqWait: setTotalWaitingRequests,
* });
* ```
*/
export declare const allWaitingRoomMembers: ({ waitingParticipants, updateWaitingRoomList, updateTotalReqWait }: AllWaitingRoomMembersOptions) => Promise<void>;
//# sourceMappingURL=allWaitingRoomMembers.d.ts.map