mediasfu-angular 1.0.0

package/dist/lib/methods/stream-methods/click-screen-share.service.d.ts

@@ -0,0 +1,44 @@
+import { Socket } from 'socket.io-client';
+import { CheckPermissionType, CheckScreenShareParameters, CheckScreenShareType, ShowAlert, StopShareScreenParameters, StopShareScreenType } from '../../@types/types';
+import * as i0 from "@angular/core";
+export interface ClickScreenShareParameters extends CheckScreenShareParameters, StopShareScreenParameters {
+    showAlert?: ShowAlert;
+    roomName: string;
+    member: string;
+    socket: Socket;
+    islevel: string;
+    youAreCoHost: boolean;
+    adminRestrictSetting: boolean;
+    audioSetting: string;
+    videoSetting: string;
+    screenshareSetting: string;
+    chatSetting: string;
+    screenAction: boolean;
+    screenAlreadyOn: boolean;
+    screenRequestState: string | null;
+    screenRequestTime: number;
+    audioOnlyRoom: boolean;
+    updateRequestIntervalSeconds: number;
+    updateScreenRequestState: (state: string | null) => void;
+    updateScreenAlreadyOn: (status: boolean) => void;
+    checkPermission: CheckPermissionType;
+    checkScreenShare: CheckScreenShareType;
+    stopShareScreen: StopShareScreenType;
+    getUpdatedAllParams: () => ClickScreenShareParameters;
+    [key: string]: any;
+}
+export interface ClickScreenShareOptions {
+    parameters: ClickScreenShareParameters;
+}
+export type ClickScreenShareType = (options: ClickScreenShareOptions) => Promise<void>;
+export declare class ClickScreenShare {
+    /**
+     * Handles the action for the screen button, including starting and stopping screen sharing.
+     *
+     * @param {ClickScreenShareParams} options - Options for handling the screen button action.
+     * @returns {Promise<void>}
+     */
+    clickScreenShare: ({ parameters }: ClickScreenShareOptions) => Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ClickScreenShare, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ClickScreenShare>;
+}

package/dist/lib/methods/stream-methods/click-video.service.d.ts

@@ -0,0 +1,58 @@
+import { CheckPermissionType, DisconnectSendTransportVideoParameters, DisconnectSendTransportVideoType, RequestPermissionCameraType, ShowAlert, StreamSuccessVideoParameters, StreamSuccessVideoType, VidCons } from '../../@types/types';
+import { Socket } from 'socket.io-client';
+import * as i0 from "@angular/core";
+export interface ClickVideoParameters extends DisconnectSendTransportVideoParameters, StreamSuccessVideoParameters {
+    checkMediaPermission: boolean;
+    hasCameraPermission: boolean;
+    videoAlreadyOn: boolean;
+    audioOnlyRoom: boolean;
+    recordStarted: boolean;
+    recordResumed: boolean;
+    recordPaused: boolean;
+    recordStopped: boolean;
+    recordingMediaOptions: string;
+    islevel: string;
+    youAreCoHost: boolean;
+    adminRestrictSetting: boolean;
+    videoRequestState: string | null;
+    videoRequestTime: number;
+    member: string;
+    socket: Socket;
+    roomName: string;
+    userDefaultVideoInputDevice: string;
+    currentFacingMode: string;
+    vidCons: VidCons;
+    frameRate: number;
+    videoAction: boolean;
+    localStream: MediaStream | null;
+    audioSetting: string;
+    videoSetting: string;
+    screenshareSetting: string;
+    chatSetting: string;
+    updateRequestIntervalSeconds: number;
+    showAlert?: ShowAlert;
+    updateVideoAlreadyOn: (value: boolean) => void;
+    updateVideoRequestState: (state: string) => void;
+    updateLocalStream: (stream: MediaStream | null) => void;
+    streamSuccessVideo: StreamSuccessVideoType;
+    disconnectSendTransportVideo: DisconnectSendTransportVideoType;
+    requestPermissionCamera: RequestPermissionCameraType;
+    checkPermission: CheckPermissionType;
+    getUpdatedAllParams: () => ClickVideoParameters;
+    [key: string]: any;
+}
+export interface ClickVideoOptions {
+    parameters: ClickVideoParameters;
+}
+export type ClickVideoType = (options: ClickVideoOptions) => Promise<void>;
+export declare class ClickVideo {
+    /**
+     * Handles the click event to toggle the participant's video on/off and manages video permission requests.
+     *
+     * @param {ClickVideoParams} options - The function parameters.
+     * @returns {Promise<void>}
+     */
+    clickVideo: ({ parameters }: ClickVideoOptions) => Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ClickVideo, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ClickVideo>;
+}

package/dist/lib/methods/stream-methods/switch-audio.service.d.ts

@@ -0,0 +1,28 @@
+import { SwitchUserAudioType, SwitchUserAudioParameters } from '../../@types/types';
+import * as i0 from "@angular/core";
+export interface SwitchAudioParameters extends SwitchUserAudioParameters {
+    defAudioID: string;
+    userDefaultAudioInputDevice: string;
+    prevAudioInputDevice: string;
+    updateUserDefaultAudioInputDevice: (deviceId: string) => void;
+    updatePrevAudioInputDevice: (deviceId: string) => void;
+    switchUserAudio: SwitchUserAudioType;
+    getUpdatedAllParams: () => SwitchAudioParameters;
+    [key: string]: any;
+}
+export interface SwitchAudioOptions {
+    audioPreference: string;
+    parameters: SwitchAudioParameters;
+}
+export type SwitchAudioType = (options: SwitchAudioOptions) => Promise<void>;
+export declare class SwitchAudio {
+    /**
+     * Switches the audio input device based on user preference.
+     *
+     * @param {SwitchAudioParams} options - The function parameters.
+     * @returns {Promise<void>}
+     */
+    switchAudio({ audioPreference, parameters }: SwitchAudioOptions): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SwitchAudio, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SwitchAudio>;
+}

package/dist/lib/methods/stream-methods/switch-video-alt.service.d.ts

@@ -0,0 +1,29 @@
+import { ShowAlert, SwitchUserVideoAltType, SwitchUserVideoParameters } from '../../@types/types';
+import * as i0 from "@angular/core";
+export interface SwitchVideoAltParameters extends SwitchUserVideoParameters {
+    recordStarted: boolean;
+    recordResumed: boolean;
+    recordStopped: boolean;
+    recordPaused: boolean;
+    recordingMediaOptions: string;
+    videoAlreadyOn: boolean;
+    currentFacingMode: string;
+    prevFacingMode: string;
+    allowed: boolean;
+    audioOnlyRoom: boolean;
+    updateCurrentFacingMode: (mode: string) => void;
+    updatePrevFacingMode: (mode: string) => void;
+    updateIsMediaSettingsModalVisible: (isVisible: boolean) => void;
+    showAlert?: ShowAlert;
+    switchUserVideoAlt: SwitchUserVideoAltType;
+    getUpdatedAllParams: () => SwitchVideoAltParameters;
+}
+export interface SwitchVideoAltOptions {
+    parameters: SwitchVideoAltParameters;
+}
+export type SwitchVideoAltType = (options: SwitchVideoAltOptions) => Promise<void>;
+export declare class SwitchVideoAlt {
+    switchVideoAlt({ parameters }: SwitchVideoAltOptions): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SwitchVideoAlt, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SwitchVideoAlt>;
+}

package/dist/lib/methods/stream-methods/switch-video.service.d.ts

@@ -0,0 +1,35 @@
+import { ShowAlert, SwitchUserVideoParameters, SwitchUserVideoType } from '../../@types/types';
+import * as i0 from "@angular/core";
+export interface SwitchVideoParameters extends SwitchUserVideoParameters {
+    recordStarted: boolean;
+    recordResumed: boolean;
+    recordStopped: boolean;
+    recordPaused: boolean;
+    recordingMediaOptions: string;
+    videoAlreadyOn: boolean;
+    userDefaultVideoInputDevice: string;
+    defVideoID: string;
+    allowed: boolean;
+    updateDefVideoID: (deviceId: string) => void;
+    updatePrevVideoInputDevice: (deviceId: string) => void;
+    updateUserDefaultVideoInputDevice: (deviceId: string) => void;
+    updateIsMediaSettingsModalVisible: (isVisible: boolean) => void;
+    showAlert?: ShowAlert;
+    switchUserVideo: SwitchUserVideoType;
+    [key: string]: any;
+}
+export interface SwitchVideoOptions {
+    videoPreference: string;
+    parameters: SwitchVideoParameters;
+}
+export type SwitchVideoType = (options: SwitchVideoOptions) => Promise<void>;
+export declare class SwitchVideo {
+    /**
+     * Switches the user's video device based on the provided video preference.
+     *
+     * @param {SwitchVideoParams} options - The function parameters.
+     */
+    switchVideo({ videoPreference, parameters }: SwitchVideoOptions): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SwitchVideo, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SwitchVideo>;
+}

package/dist/lib/methods/utils/format-number.service.d.ts

@@ -0,0 +1,24 @@
+import * as i0 from "@angular/core";
+export interface FormatNumberOptions {
+    number: number;
+}
+export type FormatNumberType = (options: FormatNumberOptions) => Promise<string | undefined>;
+export declare class FormatNumber {
+    /**
+     * Formats a number into a string representation with appropriate suffixes (K, M, B).
+     *
+     * @param number - The number to format.
+     * @returns A promise that resolves to a formatted string or undefined if the input is falsy.
+     *
+     * @example
+     * ```typescript
+     * formatNumber(500); // "500"
+     * formatNumber(1500); // "1.5K"
+     * formatNumber(1500000); // "1.5M"
+     * formatNumber(1500000000); // "1.5B"
+     * ```
+     */
+    formatNumber({ number }: FormatNumberOptions): Promise<string | undefined>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormatNumber, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FormatNumber>;
+}

package/dist/lib/methods/utils/generate-random-messages.service.d.ts

@@ -0,0 +1,26 @@
+import { Message, Participant } from '../../@types/types';
+import * as i0 from "@angular/core";
+export interface GenerateRandomMessagesOptions {
+    participants: Participant[];
+    member: string;
+    coHost?: string;
+    host: string;
+    forChatBroadcast?: boolean;
+}
+export type GenerateRandomMessagesType = (options: GenerateRandomMessagesOptions) => Message[];
+export declare class GenerateRandomMessages {
+    /**
+     * Generates random messages for a given set of participants.
+     *
+     * @param {Object} options - The options for generating random messages.
+     * @param {Array} options.participants - The list of participants.
+     * @param {string} options.member - The member who is part of the chat.
+     * @param {string} [options.coHost=""] - The co-host of the chat.
+     * @param {string} options.host - The host of the chat.
+     * @param {boolean} [options.forChatBroadcast=false] - Flag to indicate if the messages are for chat broadcast.
+     * @returns {Message[]} An array of generated messages.
+     */
+    generateRandomMessages({ participants, member, coHost, host, forChatBroadcast, }: GenerateRandomMessagesOptions): Message[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<GenerateRandomMessages, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GenerateRandomMessages>;
+}

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

@@ -0,0 +1,24 @@
+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[];
+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>;
+}

package/dist/lib/methods/utils/generate-random-polls.service.d.ts

@@ -0,0 +1,18 @@
+import { Poll } from '../../@types/types';
+import * as i0 from "@angular/core";
+export interface GenerateRandomPollsOptions {
+    numberOfPolls: number;
+}
+export type GenerateRandomPollsType = (options: GenerateRandomPollsOptions) => Poll[];
+export declare class GenerateRandomPolls {
+    /**
+     * Generates an array of random poll objects.
+     *
+     * @param {GenerateRandomPollsOptions} options - An object containing the number of polls to generate.
+     * @param {number} options.numberOfPolls - The number of random polls to generate.
+     * @returns {Poll[]} An array of random poll objects.
+     */
+    generateRandomPolls({ numberOfPolls }: GenerateRandomPollsOptions): Poll[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<GenerateRandomPolls, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GenerateRandomPolls>;
+}

package/dist/lib/methods/utils/generate-random-request-list.service.d.ts

@@ -0,0 +1,24 @@
+import { Request, Participant } from '../../@types/types';
+import * as i0 from "@angular/core";
+export interface GenerateRandomRequestListOptions {
+    participants: Participant[];
+    hostName: string;
+    coHostName?: string;
+    numberOfRequests: number;
+}
+export type GenerateRandomRequestListType = (options: GenerateRandomRequestListOptions) => Request[];
+export declare class GenerateRandomRequestList {
+    /**
+     * Generates a list of random requests for participants, excluding the host and co-host.
+     *
+     * @param {GenerateRandomRequestListOptions} options - The options for generating the request list.
+     * @param {Participant[]} options.participants - The list of participants.
+     * @param {string} options.hostName - The name of the host.
+     * @param {string} options.coHostName - The name of the co-host.
+     * @param {number} options.numberOfRequests - The number of requests to generate for each participant.
+     * @returns {Request[]} The generated list of requests.
+     */
+    generateRandomRequestList({ participants, hostName, coHostName, numberOfRequests, }: GenerateRandomRequestListOptions): Request[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<GenerateRandomRequestList, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GenerateRandomRequestList>;
+}

package/dist/lib/methods/utils/generate-random-waiting-room-list.service.d.ts

@@ -0,0 +1,19 @@
+import { WaitingRoomParticipant } from '../../@types/types';
+import * as i0 from "@angular/core";
+export type GenerateRandomWaitingRoomListType = () => WaitingRoomParticipant[];
+export declare class GenerateRandomWaitingRoomList {
+    /**
+     * Generates a random list of participants for a waiting room.
+     *
+     * @param options - Configuration options for generating the waiting room list.
+     * @returns An array of `WaitingRoomParticipant` objects, each with a random name, mute status, and unique ID.
+     *
+     * @example
+     * const options = {};
+     * const waitingRoomList = generateRandomWaitingRoomList(options);
+     * console.log(waitingRoomList);
+     */
+    generateRandomWaitingRoomList(): WaitingRoomParticipant[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<GenerateRandomWaitingRoomList, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GenerateRandomWaitingRoomList>;
+}

package/dist/lib/methods/utils/get-modal-position.util.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Defines the style object for positioning the modal.
+ */
+import { ModalPositionStyle } from '../../@types/types';
+export interface GetModalPositionOptions {
+    position: string;
+}
+export type GetModalPositionType = (options: GetModalPositionOptions) => ModalPositionStyle;
+/**
+ * Gets the style for positioning a modal based on the specified position.
+ * @function
+ * @param {string} position - The desired position for the modal ('center', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight').
+ * @returns {ModalPositionStyle} - The style object for positioning the modal.
+ */
+export declare function getModalPosition({ position }: GetModalPositionOptions): ModalPositionStyle;

package/dist/lib/methods/utils/get-overlay-position.util.d.ts

@@ -0,0 +1,12 @@
+import { OverlayPositionStyle } from '../../@types/types';
+export interface GetOverlayPositionOptions {
+    position: string;
+}
+export type GetOverlayPositionType = (options: GetOverlayPositionOptions) => OverlayPositionStyle;
+/**
+ * Gets the style for positioning an overlay based on the specified position.
+ * @function
+ * @param {string} position - The desired position for the overlay ('topLeft', 'topRight', 'bottomLeft', 'bottomRight').
+ * @returns {OverlayPositionStyle} - The style object for positioning the overlay.
+ */
+export declare function getOverlayPosition({ position }: GetOverlayPositionOptions): OverlayPositionStyle;