mediasfu-angular/dist/lib/consumers/resume-pause-streams.service.d.ts

mediasfu-angular - Angular 17/18/19 WebRTC SDK for video conferencing, webinars, broadcasts, live streaming, chat, recording, whiteboard, and AI agents. Prebuilt rooms and fully custom UIs.

import { Participant, Transport, Stream } from '../@types/types';
import * as i0 from "@angular/core";
export interface ResumePauseStreamsParameters {
    participants: Participant[];
    dispActiveNames: string[];
    remoteScreenStream: Stream[];
    consumerTransports: Transport[];
    screenId?: string;
    islevel: string;
    getUpdatedAllParams: () => ResumePauseStreamsParameters;
    [key: string]: any;
}
export interface ResumePauseStreamsOptions {
    parameters: ResumePauseStreamsParameters;
}
export type ResumePauseStreamsType = (options: ResumePauseStreamsOptions) => Promise<void>;
/**
 * Resumes or pauses streams based on the provided parameters.
 *
 * This method processes the current participant states and the active display names to determine
 * which audio and video streams should be resumed or paused. It communicates with the server
 * to resume streams as necessary.
 *
 * @param {ResumePauseStreamsOptions} options - The options for resuming or pausing streams.
 * @param {Object} options.parameters - The parameters for the function.
 * @param {Array<Participant>} options.parameters.participants - The list of participants in the session.
 * @param {Array<string>} options.parameters.dispActiveNames - The list of active display names.
 * @param {Array<Transport>} options.parameters.consumerTransports - The list of consumer transports.
 * @param {string} [options.parameters.screenId] - The screen producer ID if applicable.
 * @param {string} options.parameters.islevel - The level of the user (e.g., participant or host).
 *
 * @returns {Promise<void>} A promise that resolves when the streams have been resumed or paused.
 *
 * @throws Will throw an error if there is an issue during the process of resuming or pausing streams.
 *
 * @example
 * ```typescript
 * await resumePauseStreams({
 *   parameters: {
 *     participants: [...], // Array of participants
 *     dispActiveNames: ['Alice', 'Bob'], // Active display names
 *     consumerTransports: [...], // Array of consumer transports
 *     screenId: 'screen123', // Screen producer ID
 *     islevel: '1', // User level
 *     getUpdatedAllParams: myGetUpdatedFunction, // Function to get updated params
 *   },
 * });
 * ```
 */
export declare class ResumePauseStreams {
    /**
     * Resumes or pauses streams based on the provided parameters.
     *
     * @param {ResumePauseStreamsOptions} options - The options for resuming or pausing streams.
     * @param {Object} options.parameters - The parameters for the function.
     * @param {Array} options.parameters.participants - The list of participants.
     * @param {Array} options.parameters.dispActiveNames - The list of active display names.
     * @param {Array} options.parameters.consumerTransports - The list of consumer transports.
     * @param {string} options.parameters.screenId - The screen producer ID.
     * @param {string} options.parameters.islevel - The level of the user.
     *
     * @returns {Promise<void>} A promise that resolves when the streams have been resumed or paused.
     *
     * @throws Will throw an error if there is an issue during the process of resuming or pausing streams.
     */
    resumePauseStreams: ({ parameters }: ResumePauseStreamsOptions) => Promise<void>;
    static ɵfac: i0.ɵɵFactoryDeclaration<ResumePauseStreams, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<ResumePauseStreams>;
}