mediasfu-angular/dist/lib/consumers/start-share-screen.service.d.ts

MediaSFU Prebuilt Angular SDK

import { StreamSuccessScreenType, StreamSuccessScreenParameters, ShowAlert } from '../@types/types';
import * as i0 from "@angular/core";
export interface StartShareScreenParameters extends StreamSuccessScreenParameters {
    shared: boolean;
    showAlert?: ShowAlert;
    updateShared: (shared: boolean) => void;
    onWeb: boolean;
    targetWidth?: number;
    targetHeight?: number;
    streamSuccessScreen: StreamSuccessScreenType;
    [key: string]: any;
}
export interface StartShareScreenOptions {
    parameters: StartShareScreenParameters;
}
export type StartShareScreenType = (options: StartShareScreenOptions) => Promise<void>;
/**
 * StartShareScreen - Service to initiate screen sharing with configurable options for different environments.
 *
 * This service initiates the screen sharing process, handling both successful and failed attempts
 * and updating the shared state accordingly.
 *
 * @class
 * @name StartShareScreen
 * @example
 * ```typescript
 * const startShareScreenService = new StartShareScreen();
 * await startShareScreenService.startShareScreen({
 *   parameters: {
 *     shared: false,
 *     showAlert: (alert) => console.log(alert.message),
 *     updateShared: (shared) => console.log('Shared state:', shared),
 *     onWeb: true,
 *     targetWidth: 1920,
 *     targetHeight: 1080,
 *     streamSuccessScreen: async ({ stream }) => {
 *       // Handle the successful stream here
 *       console.log('Stream started:', stream);
 *     },
 *   },
 * });
 * ```
 *
 * @param {StartShareScreenOptions} options - The options for starting screen sharing.
 * @param {Object} options.parameters - The parameters controlling screen sharing behavior.
 * @param {boolean} options.parameters.shared - Indicates if the screen is currently shared.
 * @param {Function} options.parameters.showAlert - Function to display alerts.
 * @param {Function} options.parameters.updateShared - Function to update the shared state.
 * @param {boolean} options.parameters.onWeb - Indicates if the app is running in a web environment.
 * @param {number} [options.parameters.targetWidth=1280] - Optional width setting for shared screen resolution.
 * @param {number} [options.parameters.targetHeight=720] - Optional height setting for shared screen resolution.
 * @param {Function} options.parameters.streamSuccessScreen - Function to handle successful screen sharing.
 *
 * @method startShareScreen - Initiates the screen sharing process based on the provided parameters.
 * @returns {Promise<void>} Resolves when the screen sharing process is complete or fails.
 */
export declare class StartShareScreen {
    /**
     * Starts the screen sharing process.
     *
     * @param {StartShareScreenOptions} options - The options for starting screen sharing.
     * @param {Object} options.parameters - The parameters for screen sharing.
     * @param {boolean} options.parameters.shared - Indicates if the screen is currently being shared.
     * @param {Function} options.parameters.showAlert - Function to show alert messages.
     * @param {Function} options.parameters.updateShared - Function to update the shared state.
     * @param {boolean} options.parameters.onWeb - Indicates if the application is running on a web platform.
     * @param {number} [options.parameters.targetWidth] - The target width for screen sharing.
     * @param {number} [options.parameters.targetHeight] - The target height for screen sharing.
     * @param {Function} options.parameters.streamSuccessScreen - Function to handle successful screen sharing.
     *
     * @returns {Promise<void>} A promise that resolves when the screen sharing process is complete.
     *
     * @throws Will log an error message if there is an issue starting the screen share.
     */
    startShareScreen: ({ parameters }: StartShareScreenOptions) => Promise<void>;
    static ɵfac: i0.ɵɵFactoryDeclaration<StartShareScreen, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<StartShareScreen>;
}