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

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

@@ -1,279 +0,0 @@
-import { MainVideoContainerSetting, VirtualBackground } from "./CallSettings";
-import { OngoingCallListener } from "./Listener";
-export declare class PresenterSettings {
-    static POSITION_TOP_LEFT: string;
-    static POSITION_TOP_RIGHT: string;
-    static POSITION_BOTTOM_LEFT: string;
-    static POSITION_BOTTOM_RIGHT: string;
-    static POSITION: {
-        readonly TOP_LEFT: "top-left";
-        readonly TOP_RIGHT: "top-right";
-        readonly BOTTOM_LEFT: "bottom-left";
-        readonly BOTTOM_RIGHT: "bottom-right";
-    };
-    static ASPECT_RATIO_DEFAULT: string;
-    static ASPECT_RATIO_CONTAIN: string;
-    static ASPECT_RATIO_COVER: string;
-    static ASPECT_RATIO: {
-        readonly DEFAULT: "default";
-        readonly CONTAIN: "contain";
-        readonly COVER: "cover";
-    };
-    private defaultLayout;
-    private isAudioOnly;
-    private isPresenter;
-    private mode;
-    private ShowEndCallButton;
-    private ShowMuteAudioButton;
-    private ShowPauseVideoButton;
-    private ShowScreenShareButton;
-    private ShowSwitchModeButton;
-    private StartAudioMuted;
-    private StartVideoMuted;
-    private localizedObject;
-    private analyticsSettings;
-    private customCSS;
-    private ShowRecordingButton;
-    private idleTimeoutPeriod;
-    private StartRecordingOnCallStart;
-    private callListener;
-    private ShowSwitchToVideoCallButton;
-    private VirtualBackground;
-    private ShowVirtualBackgroundSetting;
-    private MainVideoContainerSetting;
-    constructor(builder?: PresenterSettingsBuilder);
-    getCallListener(): OngoingCallListener;
-    isRecordingButtonEnabled(): boolean;
-    getIdleTimeoutPeriod(): number;
-    shouldStartRecordingOnCallStart(): boolean;
-    getCustomCSS(): string;
-    isAudioOnlyCall(): boolean;
-    getIsPresenter(): boolean;
-    isDefaultLayoutEnabled(): boolean;
-    getMode(): "PRESENTER";
-    getStartWithAudioMuted(): boolean;
-    getStartWithVideoMuted(): boolean;
-    isEndCallButtonEnabled(): boolean;
-    isMuteAudioButtonEnabled(): boolean;
-    isPauseVideoButtonEnabled(): boolean;
-    isScreenShareButtonEnabled(): boolean;
-    isModeButtonEnabled(): boolean;
-    getLocalizedStringObject(): Object;
-    getAnalyticsSettings(): Object;
-    isAudioToVideoButtonEnabled(): boolean;
-    getVirtualBackground(): VirtualBackground;
-    isVirtualBackgroundSettingEnabled(): boolean;
-    getMainVideoContainerSetting(): MainVideoContainerSetting;
-}
-export declare class PresenterSettingsBuilder {
-    /** @private */ defaultLayout: boolean;
-    /** @private */ isAudioOnly: boolean;
-    /** @private */ isPresenter: boolean;
-    /** @private */ ShowEndCallButton: boolean;
-    /** @private */ ShowMuteAudioButton: boolean;
-    /** @private */ ShowPauseVideoButton: boolean;
-    /** @private */ ShowScreenShareButton: boolean;
-    /** @private */ ShowSwitchModeButton: boolean;
-    /** @private */ StartAudioMuted: boolean;
-    /** @private */ StartVideoMuted: boolean;
-    /** @private */ localizedObject: Object;
-    /** @private */ analyticsSettings: Object;
-    /** @private */ customCSS: string;
-    /** @private */ ShowRecordingButton: boolean;
-    /** @private */ idleTimeoutPeriod: number;
-    /** @private */ StartRecordingOnCallStart: boolean;
-    /** @private */ ShowSwitchToVideoCallButton: boolean;
-    /** @private */ virtualBackground: VirtualBackground;
-    /** @private */ ShowVirtualBackgroundSetting: boolean;
-    /** @private */ MainVideoContainerSetting: MainVideoContainerSetting;
-    /** @private */ callListener: OngoingCallListener;
-    /**
-     *
-     * @param {boolean} defaultLayout
-     * This methods shows/hides the default button layout.
-     * If set to true the default button layout will be shown.
-     * If set to false the default button layout will be hidden.
-     * Default value is true
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    enableDefaultLayout(defaultLayout: boolean): this;
-    /**
-     *
-     * @param {boolean} isAudioOnly
-     * This methods sets the type(audio/video) of the call.
-     * If set to true, the call will be strictly an audio call.
-     * If set to false, the call will be an audio-video call.
-     * Default value is false
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    setIsAudioOnlyCall(isAudioOnly: boolean): this;
-    /**
-     *
-     * @param {boolean} isPresenter
-     * This methods sets if the user is a presenter.
-     * If set to true, user will be a presenter.
-     * If set to false, user will not be a presenter.
-     * Default value is false
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    setIsPresenter(isPresenter: boolean): this;
-    /**
-     *
-     * @param {boolean} showEndCallButton
-     * This method shows/hides the end call button.
-     * If set to true it will display the end call button.
-     * If set to false it will hide the end call button.
-     * Default value is true.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    showEndCallButton(showEndCallButton: boolean): this;
-    /**
-     *
-     * @param {boolean} showMuteAudioButton
-     * This method shows/hides the mute audio button.
-     * If set to true it will display the mute audio button.
-     * If set to false it will hide the mute audio button.
-     * Default value is true.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    showMuteAudioButton(showMuteAudioButton: boolean): this;
-    /**
-     *
-     * @param {boolean} showPauseVideoButton
-     * This method shows/hides the pause video button.
-     * If set to true it will display the pause video button.
-     * If set to false it will hide the pause video button.
-     * Default value is true.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    showPauseVideoButton(showPauseVideoButton: boolean): this;
-    /**
-     *
-     * @param {boolean} showScreenShareButton
-     * This method shows/hides the screen share button.
-     * If set to true it will display the screen share button.
-     * If set to false it will hide the screen share button.
-     * Default value is true.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    showScreenShareButton(showScreenShareButton: boolean): this;
-    /**
-     *
-     * @param {boolean} showModeButton
-     * This method shows/hides the switch mode button.
-     * If set to true it will display the switch mode button.
-     * If set to false it will hide the switch mode button.
-     * Default value is true.
-     * @returns
-    */
-    showModeButton(showModeButton: boolean): this;
-    /**
-     *
-     * @param {Object} localizedStringObject
-     * This method will set the localized text in the call screen.
-     * @returns
-    */
-    setLocalizedStringObject(localizedStringObject: Object): this;
-    /**
-     * @private
-     * @param {Object} analyticsSettings
-     * This method will set the settings required for analytics.
-     * @returns
-    */
-    setAnalyticsSettings(analyticsSettings: Object): this;
-    /**
-     *
-     * @param {boolean} audioMuted
-     * This method allows the call to be started with audio muted.
-     * If set to true, the call will start with audio muted.
-     * Default value is false.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    startWithAudioMuted(audioMuted: boolean): this;
-    /**
-     *
-     * @param {boolean} videoMuted
-     * This method allows the call to be started with video muted.
-     * If set to true, the call will start with video muted.
-     * Default value is false.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    startWithVideoMuted(videoMuted: boolean): this;
-    /**
-     *
-     * @param {boolean} showRecordingButton
-     * This method shows/hides the recording button.
-     * If set to true it will display the recording button.
-     * If set to false it will hide the recording button.
-     * Default value is false.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    showRecordingButton(showRecordingButton: boolean): this;
-    /**
-     *
-     * @param {number} idleTimeoutPeriod
-     * This method sets the idle timeout period for the call.
-     * If set and you are the only one in call, the call will end
-     * after the idle timeout period, giving you the option to
-     * extend the call 60 seconds before the call ends.
-     * Default value is 180 seconds.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    setIdleTimeoutPeriod(idleTimeoutPeriod: number): this;
-    /**
-     *
-     * @param {boolean} startRecordingOnCallStart
-     * This method starts the recording as soon as the call start.
-     * If set to true it will start the recording as soon as the call start.
-     * Default value is false.
-     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
-    */
-    startRecordingOnCallStart(startRecordingOnCallStart: boolean): this;
-    /**
-     *
-     * @param {boolean} showAudioToVideoSwitchButton
-     * This method shows/hides the switch to video call button.
-     * If set to true it will display the switch to video call button.
-     * If set to false it will hide the switch to video call button.
-     * Default value is true.
-     * @returns
-    */
-    showSwitchToVideoCallButton(showAudioToVideoSwitchButton: boolean): this;
-    /**
-     *
-     * @param {VirtualBackground} virtualBackground
-     * This method will set the virtual background setting.
-     * This methods takes an Object of VirtualBackground Class.
-     * @returns
-    */
-    setVirtualBackground(virtualBackground: VirtualBackground): this;
-    /**
-     *
-     * @param {boolean} showVirtualBackgroundSetting
-     * This method shows/hides the virtual background setting button.
-     * If set to true it will display the virtual background setting button.
-     * If set to false it will hide the virtual background setting button.
-     * Default value is true.
-     * @returns
-    */
-    showVirtualBackgroundSetting(showVirtualBackgroundSetting: boolean): this;
-    /**
-     *
-     * @param {MainVideoContainerSetting} mainVideoContainerSetting
-     * This method can be used to customize the main video container.
-     * @returns
-    */
-    setMainVideoContainerSetting(mainVideoContainerSetting: MainVideoContainerSetting): this;
-    /**
-     *
-     * @param {OngoingCallListener} callListener
-     * This method can be used to subscribe to available callings events
-     * @returns
-    */
-    setCallListener(callListener: OngoingCallListener): this;
-    /**
-     * This method will return an object of the PresenterSettings class.
-     * @returns {PresenterSettings} Returns the PresenterSettings instance
-    */
-    build(): PresenterSettings;
-}

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

@@ -1,18 +0,0 @@
-export declare class RTCUser {
-    private uid;
-    private avatar;
-    private name;
-    private jwt;
-    private resource;
-    constructor(uid: any);
-    setUID(uid: string): void;
-    getUID(): string;
-    setName(name: string): void;
-    getName(): string;
-    setAvatar(avatar: string): void;
-    getAvatar(): string;
-    setJWT(jwt: string): void;
-    getJWT(): string;
-    setResource(resource: string): void;
-    getResource(): string;
-}

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

@@ -1,86 +0,0 @@
-/**
- * Represents a recording object.
- */
-export declare class Recording {
-    /**
-     * The recording ID.
-     */
-    private rid;
-    /**
-     * The URL of the recording.
-     */
-    private recording_url;
-    /**
-     * The start time of the recording.
-     */
-    private startTime;
-    /**
-     * The end time of the recording.
-     */
-    private endTime;
-    /**
-     * The duration of the recording.
-     */
-    private duration;
-    /**
-     * Creates a new instance of the Recording class.
-     * @param data - The data to initialize the recording object.
-     */
-    constructor(data: any);
-    /**
-     * Gets the recording ID.
-     * @returns The recording ID.
-     */
-    getRid(): string;
-    /**
-     * Sets the recording ID.
-     * @param value - The recording ID to set.
-     */
-    setRid(value: string): void;
-    /**
-     * Gets the recording URL.
-     * @returns The recording URL.
-     */
-    getRecordingURL(): string;
-    /**
-     * Sets the recording URL.
-     * @param value - The recording URL to set.
-     */
-    setRecordingURL(value: string): void;
-    /**
-     * Gets the start time of the recording.
-     * @returns The start time of the recording.
-     */
-    getStartTime(): number;
-    /**
-     * Sets the start time of the recording.
-     * @param value - The start time of the recording to set.
-     */
-    setStartTime(value: number): void;
-    /**
-     * Gets the end time of the recording.
-     * @returns The end time of the recording.
-     */
-    getEndTime(): number;
-    /**
-     * Sets the end time of the recording.
-     * @param value - The end time of the recording to set.
-     */
-    setEndTime(value: number): void;
-    /**
-     * Gets the duration of the recording.
-     * @returns The duration of the recording.
-     */
-    getDuration(): number;
-    /**
-     * Sets the duration of the recording.
-     * @param value - The duration of the recording to set.
-     */
-    setDuration(value: number): void;
-    /**
-     * Creates a new Recording object from the given JSON data.
-     * @param data - The JSON data to create the Recording object from.
-     * @returns A new Recording object.
-     */
-    static getRecordingFromJson(data: any): Recording;
-}

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

@@ -1,10 +0,0 @@
-import { ListenerHandlers } from "./ListnerHandler";
-export declare const addCallEventListener: typeof ListenerHandlers.addCallEventListener;
-export declare const removeCallEventListener: typeof ListenerHandlers.removeCallEventListener;
-export * from "./CallSettings";
-export * from "./CallsAppSettings";
-export * from "./CometChatCalls";
-export * from "./ErrorModel";
-export * from "./RTCUser";
-export * from "./CometChatCallsException";
-export * from "./CometChatCallLogs";

package/pack/src/types/ICallSettings.d.ts

@@ -1,62 +0,0 @@
-import { CallConstants } from "../constants";
-import { TColor, TPosition } from "./common";
-export interface ICallsettings {
-    screenShareMode?: "default" | "presenter";
-    ShowEndCallButton?: boolean;
-    ShowRecordingButton?: boolean;
-    idleTimeoutPeriod?: number;
-    StartRecordingOnCallStart?: boolean;
-    ShowMuteAudioButton?: boolean;
-    ShowPauseVideoButton?: boolean;
-    ShowScreenShareButton?: boolean;
-    ShowSwitchToVideoCallButton?: boolean;
-    defaultLayout?: boolean;
-    isAudioCall?: boolean;
-    isAudioOnly?: boolean;
-    user: {
-        name: string;
-        avatar?: string;
-        uid: string;
-        jwt?: string;
-    };
-    mode?: typeof CallConstants.MODE[keyof typeof CallConstants.MODE];
-    StartAudioMuted?: boolean;
-    StartVideoMuted?: boolean;
-    ShowSwitchModeButton?: boolean;
-    ShowVirtualBackgroundSetting?: boolean;
-    VirtualBackground?: {
-        AllowBackgroundBlur?: boolean;
-        AllowUserImages?: boolean;
-        ShowDefaultImages?: boolean;
-        SetImages?: string[];
-        EnforceBackgroundBlur?: 0 | 1 | 2;
-        EnforceBackgroundImage?: string;
-    };
-    AvatarMode?: "circle";
-    MainVideoContainerSetting?: {
-        videoFit?: "contain" | "cover";
-        zoomButton?: {
-            visible?: boolean;
-            visibility?: boolean;
-            position?: TPosition;
-        };
-        nameLabel?: {
-            visible?: boolean;
-            visibility?: boolean;
-            position?: TPosition;
-            color?: TColor;
-        };
-        network?: {
-            visible?: boolean;
-            visibility?: boolean;
-            position?: TPosition;
-        };
-    };
-    customCSS?: string;
-    analyticsSettings?: {
-        ANALYTICS_HOST?: string;
-        ANALYTICS_VERSION?: string;
-        ANALYTICS_PING_DISABLED?: boolean;
-        ANALYTICS_USE_SSL?: boolean;
-    };
-}

package/pack/src/types/ICallsAppSettings.d.ts

@@ -1,6 +0,0 @@
-import { Host, Region } from "./common";
-export interface ICallsAppSettings {
-    appId: string;
-    region: Region;
-    host?: Host;
-}

package/pack/src/types/RTCUser.d.ts

@@ -1,6 +0,0 @@
-export interface IRTCUser {
-    name: string;
-    avatar: string;
-    joinnedAt: string;
-    uid: string;
-}

package/pack/src/types/callEvents.d.ts

@@ -1,84 +0,0 @@
-import { AnyProperties } from "./common";
-export type CallingEventsInternal = "initialDeviceList" | "onDeviceChange" | "onUserJoined" | "onUserLeft" | "onUserListChanged" | "SCREEN_SHARE_STARTED" | "SCREEN_SHARE_ENDED" | "SCREEN_SHARE_ENDED" | "hangup" | "onSessionTimeout" | "onCallSwitchedToVideo" | "onRecordingToggled" | "onCallEndButtonPressed" | "onUserMuted" | "onUserUnMuted";
-interface IAVDevice {
-    deviceId: string;
-    kind: string;
-    label: string;
-    groupId: string;
-}
-interface IUserWithExtraData {
-    name: string;
-    avatar: string;
-    status: string;
-    isVideoMuted: string;
-    isAudioMuted: string;
-    showVideo: string;
-    isLocalUser: string;
-    audioTrack: string;
-    id: string;
-    uid: string;
-    joinedAt: string;
-    videoTrack: string;
-    stats: string;
-}
-interface User extends AnyProperties {
-    name: string;
-    avatar: string;
-    uid: string;
-}
-export interface ICallEventsData {
-    onUserJoined: User;
-    onUserLeft: User;
-    onUserUnMuted: User;
-    onUserMuted: {
-        muted: {
-            name: string;
-            avatar?: string;
-            isVideoMuted: boolean;
-            isAudioMuted: boolean;
-            uid: string;
-            joinedAt: string;
-        };
-        mutedBy: {
-            name: string;
-            avatar?: string;
-            isAudioMuted: boolean;
-            isVideoMuted: boolean;
-            uid: string;
-            joinedAt: string;
-        };
-    };
-    onUserListUpdated: Array<User>;
-    onScreenShareStarted: {};
-    onScreenShareStopped: {};
-    onRecordingStarted: {
-        user: Pick<IUserWithExtraData, "name" | "uid">;
-    };
-    onMediaDeviceListUpdated: {
-        videoInputDevices: IAVDevice[];
-        audioInputDevices: IAVDevice[];
-        audioOutputDevices: IAVDevice[];
-    };
-    onCallEnded: {};
-    onSessionTimeout: {};
-    onCallSwitchedToVideo: {
-        sessionId: string;
-        initiator: {
-            name: string;
-            avatar?: string;
-            isVideoMuted: boolean;
-            isAudioMuted: boolean;
-            uid: string;
-            joinedAt: string;
-        };
-        responder: {
-            name: string;
-            avatar?: string;
-            isVideoMuted: boolean;
-            isAudioMuted: boolean;
-            uid: string;
-            joinedAt: string;
-        };
-    };
-}
-export {};

package/pack/src/types/common.d.ts

@@ -1,14 +0,0 @@
-export type TPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right";
-export type TRGB = `rgb(${number}, ${number}, ${number})`;
-export type TRGBA = `rgba(${number}, ${number}, ${number}, ${number})`;
-export type THEX = `#${string}`;
-type _TColor = TRGB | TRGBA | THEX;
-export type TColor = _TColor | Omit<string, _TColor>;
-type _TRegion = "eu" | "us" | "in";
-export type Region = _TRegion | Omit<string, _TRegion>;
-type _TDomain = `${string}.call-${_TRegion}.cometchat.io/v3.0/`;
-export type Host = _TDomain | Omit<string, _TDomain>;
-export interface AnyProperties {
-    [prop: string]: any;
-}
-export {};

package/pack/src/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./ICallsAppSettings";
-export * from "./ICallSettings";

package/pack/src/util/parseJwt.d.ts

@@ -1 +0,0 @@
-export declare function parseJwt(token: string): any;

package/pack/src/util/verifyCallSettings.d.ts

@@ -1,4 +0,0 @@
-import { CallSettings } from "../models";
-import { PresenterSettings } from "../models/PresenterSettings";
-export declare const verifyCallSettings: (callSettings: CallSettings) => void;
-export declare const verifyPresenterSettings: (presenterSettings: PresenterSettings) => void;