@cometchat/calls-sdk-javascript 4.2.5 → 5.0.0-beta.2

package/pack/src/models/CometChatCalls.d.ts

@@ -1,181 +0,0 @@
-import { CallSettings, CallSettingsBuilder, MainVideoContainerSetting } from "./CallSettings";
-import { CallAppSettings, CallAppSettingsBuilder } from "./CallsAppSettings";
-import { OngoingCallListener } from "./Listener";
-import { CallConstants } from "../constants";
-import { PresenterSettings, PresenterSettingsBuilder } from "./PresenterSettings";
-import { ListenerHandlers } from "./ListnerHandler";
-import { CallLog } from './CallLog';
-import { CallLogRequestBuilder } from './CometChatCallLogs';
-import { CallUser } from "./CallUser";
-import { CallGroup } from "./CallGroup";
-import { Participant } from './Participant';
-import { Recording } from './Recording';
-export declare class CometChatCalls {
-    private static appSettings;
-    private static inProgress;
-    private static callEventListener;
-    private static debounceDeviceChange;
-    private static deviceList;
-    static CALL_MODE: {
-        readonly DEFAULT: "DEFAULT";
-        readonly SPOTLIGHT: "SPOTLIGHT";
-        readonly GRID: "TILE";
-    };
-    /**
-     * Alias to CometChatCalls.CALL_MODE
-     */
-    static MODE: {
-        readonly DEFAULT: "DEFAULT";
-        readonly SPOTLIGHT: "SPOTLIGHT";
-        readonly GRID: "TILE";
-    };
-    static addCallEventListener: typeof ListenerHandlers.addCallEventListener;
-    static removeCallEventListener: typeof ListenerHandlers.removeCallEventListener;
-    static OngoingCallListener: typeof OngoingCallListener;
-    static CallSettingsBuilder: typeof CallSettingsBuilder;
-    static CallSettings: typeof CallSettings;
-    static PresenterSettingsBuilder: typeof PresenterSettingsBuilder;
-    static PresenterSettings: typeof PresenterSettings;
-    static CallAppSettingsBuilder: typeof CallAppSettingsBuilder;
-    static CallAppSettings: typeof CallAppSettings;
-    static MainVideoContainerSetting: typeof MainVideoContainerSetting;
-    static CallLogRequestBuilder: typeof CallLogRequestBuilder;
-    static CallLog: typeof CallLog;
-    static CallUser: typeof CallUser;
-    static CallGroup: typeof CallGroup;
-    static Participant: typeof Participant;
-    static Recording: typeof Recording;
-    private static isPresenterMode;
-    static joinPresentation(callToken: string, presenterSettings: PresenterSettings, htmlElement: HTMLElement): Promise<void>;
-    static startSession(callToken: string, callSettings: CallSettings, htmlElement: HTMLElement): Promise<void>;
-    private static startSessionCore;
-    private static startTheSession;
-    static generateToken(sessionID: string, authToken: string): Promise<{
-        token: string;
-    }>;
-    static init(appSettings: CallAppSettings): Promise<void>;
-    private static getRef;
-    /**
-     * Method to pause/unpause video stream.
-     * @param {boolean} pauseVideo Defaults to true
-     * @returns {void}
-     */
-    static pauseVideo(pauseVideo?: boolean): void;
-    /**
-     * Method to resume video stream. Alias to resumeVideo.
-     * @returns {void}
-     */
-    static unPauseVideo(): void;
-    /**
-     * Method to resume video stream.
-     * @returns {void}
-     */
-    static resumeVideo(): void;
-    /**
-     * Method to set mode.
-     * @param mode
-     * @returns {void}
-     */
-    static setMode(mode: (typeof CallConstants.MODE)[keyof typeof CallConstants.MODE]): void;
-    /**
-     * Method to mute/unmute audio stream.
-     * @param {boolean} muteAudio Defaults to true
-     * @returns {void}
-     */
-    static muteAudio(muteAudio?: boolean): void;
-    /**
-     * Method to unmute audio stream.
-     * @returns {void}
-     */
-    static unMuteAudio(): void;
-    /**
-     * Method to start screen share.
-     * @returns {void}
-     */
-    static startScreenShare(): void;
-    /**
-     * Method to stop screen share.
-     * @returns {void}
-     */
-    static stopScreenShare(): void;
-    static endSession(): void;
-    static switchCamera(): void;
-    /**
-     * Method to start call recording.
-     * @returns {void}
-     */
-    static startRecording(): void;
-    /**
-     * Method to stop call recording.
-     * @returns {void}
-     */
-    static stopRecording(): void;
-    /**
-     * Method to switch an audio call to video call.
-     * @returns {void}
-     */
-    static switchToVideoCall(): void;
-    /**
-     * Method to open the virtual background settings.
-     * @returns {void}
-     */
-    static openVirtualBackground(): void;
-    /**
-     * Method to close the virtual background settings.
-     * @returns {void}
-     */
-    static closeVirtualBackground(): void;
-    /**
-     * Method to set the background blur. This method takes number as input which decides the blur level of the background.
-     * @param {number} blurLevel The blur level of the background
-     * @returns {void}
-     */
-    static setBackgroundBlur(blurLevel: number): void;
-    /**
-     * Method to set the background image. This method takes either a URL or file Object & sets that image as the background.
-     * @param image image URL or file Object
-     * @returns {void}
-     */
-    static setBackgroundImage(image: string | Blob | Object): void;
-    /**
-     * Method to get all the available audio input devices.
-     * @returns {MediaDeviceInfo[]}
-     */
-    static getAudioInputDevices(): MediaDeviceInfo[];
-    /**
-     * Method to get all the available audio output devices.
-     * @returns {MediaDeviceInfo[]}
-     */
-    static getAudioOutputDevices(): MediaDeviceInfo[];
-    /**
-     * Method to get all the available video input devices.
-     * @returns {MediaDeviceInfo[]}
-     */
-    static getVideoInputDevices(): MediaDeviceInfo[];
-    /**
-     * Method to change the audio input device.
-     * @param {string} deviceId
-     * @returns {void}
-     */
-    static setAudioInputDevice(deviceId: string): void;
-    /**
-     * Method to change the audio output device.
-     * @param {string} deviceId
-     * @returns {void}
-     */
-    static setAudioOutputDevice(deviceId: string): void;
-    /**
-     * Method to change the video input device.
-     * @param {string} deviceId
-     * @returns {void}
-     */
-    static setVideoInputDevice(deviceId: string): void;
-    /**
-     * Retrieves call details for a given session ID and auth token.
-     * @param sessionID - The session ID of the call.
-     * @param authToken - The authentication token required to make the API call.
-     * @returns A Promise that resolves to a CallLog object containing the call details.
-     * @throws {CometChatCallsException} If there is an error retrieving the call details.
-     */
-    static getCallDetails(sessionID: string, authToken: string): Promise<Array<CallLog>>;
-}

package/pack/src/models/CometChatCallsException.d.ts

@@ -1,8 +0,0 @@
-import { ErrorModel } from "./ErrorModel";
-export declare class CometChatCallsException {
-    code?: ErrorModel["code"];
-    name?: ErrorModel["name"];
-    message?: ErrorModel["message"];
-    details?: ErrorModel["details"];
-    constructor(errorModel: ErrorModel);
-}

package/pack/src/models/ErrorModel.d.ts

@@ -1,12 +0,0 @@
-/**
- *
- *
- * @export
- * @interface ErrorModel
- */
-export interface ErrorModel {
-    code?: string | number;
-    name?: string;
-    message?: string;
-    details?: string;
-}

package/pack/src/models/Listener.d.ts

@@ -1,91 +0,0 @@
-import { ICallEventsData } from "../types/callEvents";
-import { CometChatCallsException } from "./CometChatCallsException";
-interface IOngoingCallListener {
-    onUserJoined: (user: Partial<ICallEventsData["onUserJoined"]>) => void;
-    onUserLeft: (user: Partial<ICallEventsData["onUserJoined"]>) => void;
-    onUserListUpdated: (userList: Partial<ICallEventsData["onUserListUpdated"]>) => void;
-    onMediaDeviceListUpdated: (devices: Partial<ICallEventsData["onMediaDeviceListUpdated"]>) => void;
-    onRecordingStarted: (event: Partial<ICallEventsData["onRecordingStarted"]>) => void;
-    onRecordingStopped: () => void;
-    onScreenShareStarted: () => void;
-    onScreenShareStopped: () => void;
-    onUserMuted: (event: Partial<ICallEventsData["onUserMuted"]>) => void;
-    onUserUnMuted: (event: Partial<ICallEventsData["onUserUnMuted"]>) => void;
-    onCallSwitchedToVideo: (event: Partial<ICallEventsData["onCallSwitchedToVideo"]>) => void;
-    onCallEnded: () => void;
-    onSessionTimeout: () => void;
-    onCallEndButtonPressed: () => void;
-    onError: (error: CometChatCallsException) => void;
-}
-export declare class OngoingCallListener {
-    /**
-     * @internal
-    */
-    onYouLeft?: Function;
-    /**
-     * @internal
-    */
-    onYouJoined?: Function;
-    /**
-     * This event is triggered when a user joins the call.
-    */
-    onUserJoined?: IOngoingCallListener["onUserJoined"];
-    /**
-     * This event is triggered when a user leaves the call.
-    */
-    onUserLeft?: IOngoingCallListener["onUserLeft"];
-    /**
-     * This event is triggered when the participant list of the call changes.
-    */
-    onUserListUpdated?: IOngoingCallListener["onUserListUpdated"];
-    /**
-     * This event is triggered when the media device list changes.
-    */
-    onMediaDeviceListUpdated?: IOngoingCallListener["onMediaDeviceListUpdated"];
-    /**
-     * This event is triggered when someone starts recording the call.
-    */
-    onRecordingStarted?: IOngoingCallListener["onRecordingStarted"];
-    /**
-     * This event is triggered when someone stops recording the call.
-    */
-    onRecordingStopped?: IOngoingCallListener["onRecordingStopped"];
-    /**
-     * This event is triggered when someone starts sharing their screen in the call.
-    */
-    onScreenShareStarted?: IOngoingCallListener["onScreenShareStarted"];
-    /**
-     * This event is triggered when someone stops sharing their screen in the call.
-    */
-    onScreenShareStopped?: IOngoingCallListener["onScreenShareStopped"];
-    /**
-     * This event is triggered when a user is muted.
-    */
-    onUserMuted?: IOngoingCallListener["onUserMuted"];
-    /**
-     * This event is triggered when a user is unmuted.
-     */
-    onUserUnMuted?: IOngoingCallListener["onUserUnMuted"];
-    /**
-     * This event is triggered when an audio call is switched to a video call.
-    */
-    onCallSwitchedToVideo?: IOngoingCallListener["onCallSwitchedToVideo"];
-    /**
-     * This event is triggered when the call is ended.
-    */
-    onCallEnded?: IOngoingCallListener["onCallEnded"];
-    /**
-     * This event is triggered when the call is ended due to session timeout.
-    */
-    onSessionTimeout?: IOngoingCallListener["onSessionTimeout"];
-    /**
-     * This event is triggered when an error occurs.
-    */
-    onError?: IOngoingCallListener["onError"];
-    /**
-     * This event is triggered when user presses end call button.
-    */
-    onCallEndButtonPressed?: IOngoingCallListener["onCallEndButtonPressed"];
-    constructor(eventObj: Partial<IOngoingCallListener>);
-}
-export {};

package/pack/src/models/ListnerHandler.d.ts

@@ -1,10 +0,0 @@
-import { OngoingCallListener } from "./Listener";
-interface IMultiOngoingCallListener extends OngoingCallListener {
-    _name: string;
-}
-export declare class ListenerHandlers {
-    static callHandlers?: IMultiOngoingCallListener[];
-    static addCallEventListener(name: string, callListener: OngoingCallListener): void;
-    static removeCallEventListener(handler: string): void;
-}
-export {};

package/pack/src/models/Participant.d.ts

@@ -1,184 +0,0 @@
-/**
- * Represents a participant in a call.
- */
-export declare class Participant {
-    /**
-     * The unique identifier of the participant.
-     */
-    private uid;
-    /**
-     * The name of the participant.
-     */
-    private name;
-    /**
-     * The avatar of the participant.
-     */
-    private avatar;
-    /**
-     * The total audio minutes of the participant.
-     */
-    private totalAudioMinutes;
-    /**
-     * The total video minutes of the participant.
-     */
-    private totalVideoMinutes;
-    /**
-     * The total duration in minutes of the participant.
-     */
-    private totalDurationInMinutes;
-    /**
-     * The device ID of the participant.
-     */
-    private deviceID;
-    /**
-     * Whether the participant has joined the call or not.
-     */
-    private hasJoined;
-    /**
-     * The timestamp when the participant joined the call.
-     */
-    private joinedAt;
-    /**
-     * The timestamp when the participant left the call.
-     */
-    private leftAt;
-    /**
-     * The media ID of the participant.
-     */
-    private mid;
-    /**
-     * The state of the participant.
-     */
-    private state;
-    /**
-     * Creates a new instance of Participant.
-     * @param object - The object containing the participant data.
-     */
-    constructor(object: any);
-    /**
-     * Gets the unique identifier of the participant.
-     * @returns The unique identifier of the participant.
-     */
-    getUid(): string;
-    /**
-     * Sets the unique identifier of the participant.
-     * @param value - The unique identifier of the participant.
-     */
-    setUid(value: string): void;
-    /**
-     * Gets the name of the participant.
-     * @returns The name of the participant.
-     */
-    getName(): string;
-    /**
-     * Sets the name of the participant.
-     * @param value - The name of the participant.
-     */
-    setName(value: string): void;
-    /**
-     * Gets the avatar of the participant.
-     * @returns The avatar of the participant.
-     */
-    getAvatar(): string;
-    /**
-     * Sets the avatar of the participant.
-     * @param value - The avatar of the participant.
-     */
-    setAvatar(value: string): void;
-    /**
-     * Gets the total audio minutes of the participant.
-     * @returns The total audio minutes of the participant.
-     */
-    getTotalAudioMinutes(): number;
-    /**
-     * Sets the total audio minutes of the participant.
-     * @param value - The total audio minutes of the participant.
-     */
-    setTotalAudioMinutes(value: number): void;
-    /**
-     * Gets the total video minutes of the participant.
-     * @returns The total video minutes of the participant.
-     */
-    getTotalVideoMinutes(): number;
-    /**
-     * Sets the total video minutes of the participant.
-     * @param value - The total video minutes of the participant.
-     */
-    setTotalVideoMinutes(value: number): void;
-    /**
-     * Gets the total duration in minutes of the participant.
-     * @returns The total duration in minutes of the participant.
-     */
-    getTotalDurationInMinutes(): number;
-    /**
-     * Sets the total duration in minutes of the participant.
-     * @param value - The total duration in minutes of the participant.
-     */
-    setTotalDurationInMinutes(value: number): void;
-    /**
-     * Gets the device ID of the participant.
-     * @returns The device ID of the participant.
-     */
-    getDeviceID(): string;
-    /**
-     * Sets the device ID of the participant.
-     * @param value - The device ID of the participant.
-     */
-    setDeviceID(value: string): void;
-    /**
-     * Gets whether the participant has joined the call or not.
-     * @returns Whether the participant has joined the call or not.
-     */
-    getHasJoined(): boolean;
-    /**
-     * Sets whether the participant has joined the call or not.
-     * @param value - Whether the participant has joined the call or not.
-     */
-    setHasJoined(value: boolean): void;
-    /**
-     * Gets the timestamp when the participant joined the call.
-     * @returns The timestamp when the participant joined the call.
-     */
-    getJoinedAt(): number;
-    /**
-     * Sets the timestamp when the participant joined the call.
-     * @param value - The timestamp when the participant joined the call.
-     */
-    setJoinedAt(value: number): void;
-    /**
-     * Gets the timestamp when the participant left the call.
-     * @returns The timestamp when the participant left the call.
-     */
-    getLeftAt(): number;
-    /**
-     * Sets the timestamp when the participant left the call.
-     * @param value - The timestamp when the participant left the call.
-     */
-    setLeftAt(value: number): void;
-    /**
-     * Gets the media ID of the participant.
-     * @returns The media ID of the participant.
-     */
-    getMid(): string;
-    /**
-     * Sets the media ID of the participant.
-     * @param value - The media ID of the participant.
-     */
-    setMid(value: string): void;
-    /**
-     * Gets the state of the participant.
-     * @returns The state of the participant.
-     */
-    getState(): string;
-    /**
-     * Sets the state of the participant.
-     * @param value - The state of the participant.
-     */
-    setState(value: string): void;
-    /**
-     * Creates a new instance of Participant from a JSON object.
-     * @param object - The JSON object containing the participant data.
-     * @returns A new instance of Participant.
-     */
-    static getParticipantFromJson(object: any): Participant;
-}