@cometchat/calls-sdk-javascript 5.0.0-beta.1 → 5.0.0

package/dist/index.d.ts

@@ -1,13 +1,17 @@
-import { AudioInputDevice } from '../../../calls-sdk-core';
-import { AudioOutputDevice } from '../../../calls-sdk-core';
 import * as v from 'valibot';
-import { VideoInputDevice } from '../../../calls-sdk-core';
 
 declare interface AnyProperties {
     [prop: string]: any;
 }
 
-declare type AudioInputDevice_2 = MediaDeviceInfo & {
+export declare type APIErrorResponse = {
+    message: string;
+    devMessage: string;
+    source: string;
+    code: string;
+};
+
+export declare type AudioInputDevice = MediaDeviceInfo & {
     kind: Extract<MediaDeviceKind, 'audioinput'>;
 };
 
@@ -19,7 +23,7 @@ declare type AudioMode = {
 
 declare type AudioModeType = 'BLUETOOTH' | 'EARPIECE' | 'HEADPHONES' | 'SPEAKER';
 
-declare type AudioOutputDevice_2 = MediaDeviceInfo & {
+export declare type AudioOutputDevice = MediaDeviceInfo & {
     kind: Extract<MediaDeviceKind, 'audiooutput'>;
 };
 
@@ -877,6 +881,14 @@ declare class CallSettingsBuilder {
      * @returns
      */
     setVirtualBackground(virtualBackground: VirtualBackground): this;
+    /**
+     *
+     * @param {MainVideoContainerSetting} mainVideoContainerSetting
+     * This method can be used to customize the main video container.
+     * @deprecated This method is deprecated and not supported.
+     * @returns
+     */
+    setMainVideoContainerSetting(_mainVideoContainerSetting: MainVideoContainerSetting): this;
     /**
      *
      * @param {boolean} showVirtualBackgroundSetting
@@ -952,6 +964,10 @@ export declare class CometChatCalls extends SessionMethods {
     };
     static CallLogRequestBuilder: typeof CallLogRequestBuilder;
     static CallLog: typeof CallLog;
+    /** @deprecated */
+    static MainVideoContainerSetting: typeof MainVideoContainerSetting;
+    /** @deprecated */
+    static CallSettings: typeof CallSettings;
     /**
      * @deprecated Use CometChatCalls.init passing object directly.
      */
@@ -1010,13 +1026,13 @@ export declare class CometChatCalls extends SessionMethods {
     static startSession(callToken: string, callSettings: CallSettings, container: HTMLElement): Promise<Result<void, VerifyTokenException>>;
     private static _connectToRoom;
     private static connectToRoom;
-    static joinSession(callToken: string, callSettings: SessionSettings, container: HTMLElement): Promise<Result<void, VerifyTokenException>>;
-    static getAudioInputDevices(): AudioInputDevice_2[];
-    static getVideoInputDevices(): VideoInputDevice_2[];
-    static getAudioOutputDevices(): AudioOutputDevice_2[];
-    static getCurrentAudioInputDevice(): AudioInputDevice_2 | undefined;
-    static getCurrentVideoInputDevice(): VideoInputDevice_2 | undefined;
-    static getCurrentAudioOutputDevice(): AudioOutputDevice_2 | undefined;
+    static joinSession(callToken: string, sessionSettings: SessionSettings, container: HTMLElement): Promise<Result<void, VerifyTokenException>>;
+    static getAudioInputDevices(): AudioInputDevice[];
+    static getVideoInputDevices(): VideoInputDevice[];
+    static getAudioOutputDevices(): AudioOutputDevice[];
+    static getCurrentAudioInputDevice(): AudioInputDevice | undefined;
+    static getCurrentVideoInputDevice(): VideoInputDevice | undefined;
+    static getCurrentAudioOutputDevice(): AudioOutputDevice | undefined;
 }
 
 declare namespace CometChatCallsDefault {
@@ -1057,7 +1073,6 @@ declare type ConfigStateBoth = {
     hideToggleVideoButton: boolean;
     hideParticipantListButton: boolean;
     hideChatButton: boolean;
-    hideScreenSharingButton: boolean;
     hideSessionTimer: boolean;
     hideNetworkIndicator: boolean;
     hideRecordingStatusIndicator: boolean;
@@ -1072,6 +1087,7 @@ declare type ConfigStateBoth = {
     enableSpotlightDrag: boolean;
     enableSpotlightSwap: boolean;
     isPeerCall: boolean;
+    enableNotifications: boolean;
 };
 
 declare type ConfigStateWeb = {
@@ -1079,7 +1095,16 @@ declare type ConfigStateWeb = {
     audioInputDeviceId?: string;
     audioOutputDeviceId?: string;
     videoInputDeviceId?: string;
+    hideScreenSharingButton: boolean;
     hideVirtualBackgroundButton: boolean;
+    /**
+     * @unstable This API may change or be removed in a future release.
+     * When enabled, the SDK renders only remote audio elements without any
+     * visual UI (no video tiles, controls, or overlays). This allows the
+     * host app to provide its own custom UI while the SDK handles the
+     * underlying call connection and audio playback.
+     */
+    unstable_renderAudioOnly: boolean;
 };
 
 /**
@@ -1338,6 +1363,45 @@ declare interface LoginListener {
     onLogoutFailure?: (error: CometChatException) => void;
 }
 
+declare class MainVideoContainerSetting {
+    /**
+     *
+     * @param {string} mainVideoAspectRatio
+     * This method is used to set the aspect ratio of main video.
+     * The default value is `contain`
+     * @returns
+     */
+    setMainVideoAspectRatio(_mainVideoAspectRatio: (typeof CallSettings.ASPECT_RATIO)[keyof typeof CallSettings.ASPECT_RATIO]): void;
+    /**
+     *
+     * @param {string} position
+     * @param {boolean} visibility
+     * This method is used to set the position & visibility parameter of the full screen button.
+     * By default the full screen button is visible in the `bottom-right` position.
+     * @returns
+     */
+    setFullScreenButtonParams(_position: (typeof CallSettings.POSITION)[keyof typeof CallSettings.POSITION], _visibility: boolean): void;
+    /**
+     *
+     * @param {string} position
+     * @param {boolean} visibility
+     * @param {string} backgroundColor
+     * This method is used to set the position, visibility & background color of the name label.
+     * By default the name label is visible in the `bottom-left` position with a background-color `rgba(27, 27, 27, 0.4)`
+     * @returns
+     */
+    setNameLabelParams(_position: (typeof CallSettings.POSITION)[keyof typeof CallSettings.POSITION], _visibility: boolean, _backgroundColor: string): void;
+    /**
+     *
+     * @param {string} position
+     * @param {boolean} visibility
+     * This method is used to set the position, visibility of the network label.
+     * By default the network label is visible in the `bottom-right` position.
+     * @returns
+     */
+    setNetworkLabelParams(_position: (typeof CallSettings.POSITION)[keyof typeof CallSettings.POSITION], _visibility: boolean): void;
+}
+
 declare type MobileSDKEvents = SDKEvents & {
     onAudioModeChanged: (payload: AudioMode['type']) => void;
     onCameraFacingChanged: (payload: CameraFacing) => void;
@@ -1697,7 +1761,7 @@ declare class Recording {
 
 declare type Region = _TRegion | Omit<string, _TRegion>;
 
-declare type Result<T, E = Error> = {
+export declare type Result<T, E = Error> = {
     data: T;
     error: null;
 } | {
@@ -1734,8 +1798,6 @@ declare class SessionMethods extends SessionMethodsCore {
     static hideSettingsDialog(): void;
     static showVirtualBackgroundDialog(): void;
     static hideVirtualBackgroundDialog(): void;
-    static enablePictureInPictureLayout(): void;
-    static disablePictureInPictureLayout(): void;
     static getAudioInputDevices(): AudioInputDevice[];
     static getAudioOutputDevices(): AudioOutputDevice[];
     static getVideoInputDevices(): VideoInputDevice[];
@@ -1784,6 +1846,11 @@ declare class SessionMethodsCore {
      * Unmutes the local user's audio during the call.
      */
     static unmuteAudio(): void;
+    /**
+     * Toggles the local user's audio mute state.
+     * If audio is muted, it will be unmuted, and vice versa.
+     */
+    static toggleAudio(): void;
     /**
      * Pauses the local user's video stream.
      */
@@ -1792,10 +1859,20 @@ declare class SessionMethodsCore {
      * Resumes the local user's video stream.
      */
     static resumeVideo(): void;
+    /**
+     * Toggles the local user's video stream.
+     * If video is paused, it will be resumed, and vice versa.
+     */
+    static toggleVideo(): void;
     /**
      * Local user leaves the current session.
      */
     static leaveSession(): void;
+    /**
+     * Ends the current session for all participants.
+     * This will terminate the conference and disconnect everyone.
+     */
+    static endSessionForAll(): void;
     /**
      * Raises the user's virtual hand in the call.
      */
@@ -1804,6 +1881,11 @@ declare class SessionMethodsCore {
      * Lowers the user's virtual hand in the call.
      */
     static lowerHand(): void;
+    /**
+     * Toggles the user's virtual hand state.
+     * If the hand is raised, it will be lowered, and vice versa.
+     */
+    static toggleHand(): void;
     /**
      * Switches between the front and rear camera.
      */
@@ -1821,6 +1903,11 @@ declare class SessionMethodsCore {
      * Stops the ongoing call recording.
      */
     static stopRecording(): void;
+    /**
+     * Toggles the call recording state.
+     * If recording is active, it will be stopped, and vice versa.
+     */
+    static toggleRecording(): void;
     /**
      * Pins a participant's video to focus on them.
      * @param participantId - The ID of the participant to pin.
@@ -1846,6 +1933,18 @@ declare class SessionMethodsCore {
      * @param count - The number of unread messages.
      */
     static setChatButtonUnreadCount(count: number): void;
+    /**
+     * Toggles the visibility of the participant list panel.
+     */
+    static toggleParticipantList(): void;
+    /**
+     * Shows the participant list panel.
+     */
+    static showParticipantList(): void;
+    /**
+     * Hides the participant list panel.
+     */
+    static hideParticipantList(): void;
     /**
      * @deprecated switchToVideoCall is deprecated and not supported.
      */
@@ -1915,7 +2014,7 @@ declare interface VerifyTokenException extends Error {
     details?: unknown;
 }
 
-declare type VideoInputDevice_2 = MediaDeviceInfo & {
+export declare type VideoInputDevice = MediaDeviceInfo & {
     kind: Extract<MediaDeviceKind, 'videoinput'>;
 };