mediasfu-angular/dist/lib/methods/utils/generate-random-participants.service.d.ts

MediaSFU Prebuilt Angular SDK

import { Participant } from '../../@types/types';
import * as i0 from "@angular/core";
export interface GenerateRandomParticipantsOptions {
    member: string;
    coHost?: string;
    host: string;
    forChatBroadcast?: boolean;
}
export type GenerateRandomParticipantsType = (options: GenerateRandomParticipantsOptions) => Participant[];
/**
 * GenerateRandomParticipants - Service to generate a list of random participants.
 *
 * This service creates a list of participants based on a set of specified options, with customization for chat broadcasts
 * and designation of specific roles like member, co-host, and host.
 *
 * @class
 * @name GenerateRandomParticipants
 * @example
 * ```typescript
 * const generateRandomParticipantsService = new GenerateRandomParticipants();
 * const participants = generateRandomParticipantsService.generateRandomParticipants({
 *   member: 'Alice',
 *   coHost: 'Bob',
 *   host: 'Charlie',
 *   forChatBroadcast: true
 * });
 * console.log(participants);
 * ```
 *
 * @param {Object} options - Options for generating participants.
 * @param {string} options.member - Primary member to include in the participants list.
 * @param {string} [options.coHost] - Optional co-host in the participants list.
 * @param {string} options.host - Host to include in the participants list.
 * @param {boolean} [options.forChatBroadcast=false] - Indicates if participants are for a chat broadcast.
 * @returns {Participant[]} Array of generated participants with randomized levels, muted states, and identifiers.
 */
export declare class GenerateRandomParticipants {
    /**
     * Generates a list of random participants with specified options.
     *
     * @param {Object} options - The options for generating participants.
     * @param {string} options.member - The member to include in the participants list.
     * @param {string} [options.coHost=""] - The co-host to include in the participants list.
     * @param {string} options.host - The host to include in the participants list.
     * @param {boolean} [options.forChatBroadcast=false] - Whether the participants are for a chat broadcast.
     * @returns {Participant[]} An array of generated participants.
     */
    generateRandomParticipants({ member, coHost, host, forChatBroadcast, }: GenerateRandomParticipantsOptions): Participant[];
    static ɵfac: i0.ɵɵFactoryDeclaration<GenerateRandomParticipants, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<GenerateRandomParticipants>;
}