mediasfu-reactjs/dist/types/methods/utils/meetingTimer/startMeetingProgressTimer.d.ts

MediaSFU Prebuilt ReactJS SDK - Compatible with React 18 & 19, TypeScript & JavaScript

export interface StartMeetingProgressTimerParameters {
    updateMeetingProgressTime: (formattedTime: string) => void;
    validated: boolean;
    roomName: string;
    getUpdatedAllParams: () => StartMeetingProgressTimerParameters;
    [key: string]: any;
}
export interface StartMeetingProgressTimerOptions {
    startTime: number;
    parameters: StartMeetingProgressTimerParameters;
}
export type StartMeetingProgressTimerType = (options: StartMeetingProgressTimerOptions) => void;
/**
 * Starts a timer to track the progress of a meeting.
 *
 * @param {StartMeetingProgressTimerOptions} options - The options for starting the meeting progress timer.
 * @param {number} options.startTime - The custom start time for the meeting progress timer.
 * @param {StartMeetingProgressTimerParameters} options.parameters - The parameters required for updating the meeting progress.
 * @param {Function} options.parameters.updateMeetingProgressTime - Function to update the meeting progress time.
 * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
 *
 * @example
 * ```typescript
 * startMeetingProgressTimer({
 *   startTime: 1609459200, // e.g., timestamp for the start of the meeting
 *   parameters: {
 *     updateMeetingProgressTime: (formattedTime) => console.log("Meeting time:", formattedTime),
 *     validated: true,
 *     roomName: "room1",
 *     getUpdatedAllParams: () => ({ validated: true, roomName: "room1", updateMeetingProgressTime }),
 *   },
 * });
 * ```
 */
export declare function startMeetingProgressTimer({ startTime, parameters, }: StartMeetingProgressTimerOptions): void;
//# sourceMappingURL=startMeetingProgressTimer.d.ts.map