@cometchat/calls-sdk-react-native 5.0.3 → 5.0.4

package/dist/index.d.mts

@@ -127,6 +127,8 @@ declare const EVENT_LISTENER_METHODS: {
     readonly onVideoResumed: "onVideoResumed";
     readonly onRecordingStarted: "onRecordingStarted";
     readonly onRecordingStopped: "onRecordingStopped";
+    readonly onStreamingStarted: "onStreamingStarted";
+    readonly onStreamingStopped: "onStreamingStopped";
     readonly onScreenShareStarted: "onScreenShareStarted";
     readonly onScreenShareStopped: "onScreenShareStopped";
   };
@@ -143,6 +145,8 @@ declare const EVENT_LISTENER_METHODS: {
     readonly onParticipantStoppedScreenShare: "onParticipantStoppedScreenShare";
     readonly onParticipantStartedRecording: "onParticipantStartedRecording";
     readonly onParticipantStoppedRecording: "onParticipantStoppedRecording";
+    readonly onParticipantStartedStreaming: "onParticipantStartedStreaming";
+    readonly onParticipantStoppedStreaming: "onParticipantStoppedStreaming";
     readonly onDominantSpeakerChanged: "onDominantSpeakerChanged";
     readonly onParticipantListChanged: "onParticipantListChanged";
   };
@@ -178,6 +182,8 @@ declare const EVENT_LISTENER_METHODS_WEB: {
     readonly onVideoResumed: "onVideoResumed";
     readonly onRecordingStarted: "onRecordingStarted";
     readonly onRecordingStopped: "onRecordingStopped";
+    readonly onStreamingStarted: "onStreamingStarted";
+    readonly onStreamingStopped: "onStreamingStopped";
     readonly onScreenShareStarted: "onScreenShareStarted";
     readonly onScreenShareStopped: "onScreenShareStopped";
   };
@@ -205,6 +211,8 @@ declare const EVENT_LISTENER_METHODS_WEB: {
     readonly onParticipantStoppedScreenShare: "onParticipantStoppedScreenShare";
     readonly onParticipantStartedRecording: "onParticipantStartedRecording";
     readonly onParticipantStoppedRecording: "onParticipantStoppedRecording";
+    readonly onParticipantStartedStreaming: "onParticipantStartedStreaming";
+    readonly onParticipantStoppedStreaming: "onParticipantStoppedStreaming";
     readonly onDominantSpeakerChanged: "onDominantSpeakerChanged";
     readonly onParticipantListChanged: "onParticipantListChanged";
   };
@@ -237,6 +245,8 @@ declare const EVENT_LISTENER_METHODS_MOBILE: {
     readonly onVideoResumed: "onVideoResumed";
     readonly onRecordingStarted: "onRecordingStarted";
     readonly onRecordingStopped: "onRecordingStopped";
+    readonly onStreamingStarted: "onStreamingStarted";
+    readonly onStreamingStopped: "onStreamingStopped";
     readonly onScreenShareStarted: "onScreenShareStarted";
     readonly onScreenShareStopped: "onScreenShareStopped";
   };
@@ -284,6 +294,8 @@ declare const EVENT_LISTENER_METHODS_MOBILE: {
     readonly onParticipantStoppedScreenShare: "onParticipantStoppedScreenShare";
     readonly onParticipantStartedRecording: "onParticipantStartedRecording";
     readonly onParticipantStoppedRecording: "onParticipantStoppedRecording";
+    readonly onParticipantStartedStreaming: "onParticipantStartedStreaming";
+    readonly onParticipantStoppedStreaming: "onParticipantStoppedStreaming";
     readonly onDominantSpeakerChanged: "onDominantSpeakerChanged";
     readonly onParticipantListChanged: "onParticipantListChanged";
   };
@@ -466,6 +478,7 @@ type ConferenceState = {
     initiator?: any;
   };
   isRecording: boolean;
+  isStreaming: boolean;
 };
 type Actions$4 = {
   reset: () => void;
@@ -474,7 +487,6 @@ type Actions$4 = {
   lowerHand: (participantId: string) => void;
   leaveConference: () => Promise<void>;
   endConference: () => Promise<void>;
-  stopRecording: () => Promise<void>;
 };
 declare const useConferenceStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<ConferenceState & Actions$4>, "subscribe"> & {
   subscribe: {
@@ -490,9 +502,12 @@ declare function raisedHandLocal(): void;
 declare function lowerHandLocal(): void;
 declare function toggleRaiseHand(): void;
 declare const useIsRecording: () => boolean;
+declare const useIsStreaming: () => boolean;
 declare function startRecording(): Promise<void>;
 declare function stopRecording(): Promise<void>;
 declare function toggleRecording(): Promise<void>;
+declare function startStreaming(streamUrl: string, streamKey: string): Promise<void>;
+declare function stopStreaming(): Promise<void>;
 declare const getIsConferenceJoined: () => boolean;
 //#endregion
 //#region calls-sdk-core/store/config.d.ts
@@ -538,6 +553,20 @@ type ConfigStateMobile = {
    * @default true
    */
   enableSpotlightSwap: boolean;
+  /**
+   * iOS only (React Native). When enabled, the call automatically enters the
+   * system Picture-in-Picture window when the app moves to the background,
+   * showing the active speaker's video (or the active screen share), and
+   * returns to the app automatically when it is foregrounded.
+   *
+   * Requires iOS 15+ and the "Audio, AirPlay, and Picture in Picture"
+   * background mode capability in the host app. Ignored on Android and on
+   * older iOS versions. Not related to `enablePictureInPictureLayout()`,
+   * which shrinks the in-app call UI to a tile.
+   *
+   * @default false
+   */
+  enableIOSPictureInPicture: boolean;
 };
 /**
  * Configuration that only applies on the web platform.
@@ -637,6 +666,29 @@ type ConfigStateBoth = {
    * @default true
    */
   hideRecordingButton: boolean;
+  /**
+   * Hides the streaming button from the call controls, preventing the user
+   * from manually starting or stopping a live stream from within the SDK UI.
+   *
+   * @default true
+   */
+  hideStreamingButton: boolean;
+  /**
+   * The RTMP URL to stream to when the user starts a live stream from the
+   * call controls. When set, pressing the start-streaming button skips the
+   * confirmation dialog (which normally asks for a URL and key) and starts
+   * streaming to this URL immediately.
+   *
+   * @default undefined — the user is asked for a URL when starting a stream
+   */
+  streamUrl?: string;
+  /**
+   * The stream key sent along with `streamUrl` when a live stream is
+   * started. Ignored when `streamUrl` is not set.
+   *
+   * @default undefined
+   */
+  streamKey?: string;
   /**
    * Hides the entire bottom control bar (mic, camera, leave, and every other
    * call control). Useful when the host app provides its own controls.
@@ -723,6 +775,13 @@ type ConfigStateBoth = {
    * @default false
    */
   hideRecordingStatusIndicator: boolean;
+  /**
+   * Hides the "streaming live" badge shown while the session is being
+   * streamed. The stream itself is unaffected.
+   *
+   * @default false
+   */
+  hideStreamingStatusIndicator: boolean;
   /**
    * Hides the button that switches between the front and rear cameras.
    * Mainly relevant on mobile devices with more than one camera.
@@ -1058,6 +1117,7 @@ declare const getMainParticipantFromState: (state: {
   dominantSpeakers: string[];
   localParticipant: HumanParticipant;
 }) => Participant$2;
+declare const getParticipantMediaType: (participant?: Participant$2) => "video" | "screenshare";
 //#endregion
 //#region calls-sdk-core/store/toast.d.ts
 interface ToastAction {
@@ -1155,6 +1215,7 @@ declare const useMainParticipant: () => Participant$2;
 declare const getMainParticipant: () => Participant$2;
 declare const useIsReconnecting: () => boolean;
 declare const useHideRecordingButton: () => boolean;
+declare const useHideStreamingButton: () => boolean;
 declare const useHideVirtualBackgroundButton: () => boolean;
 declare const useLayout: () => Layout;
 declare const useEnableParticipantContextMenu: () => boolean;
@@ -1176,9 +1237,15 @@ declare const switchCamera: () => void;
 //#region calls-sdk-core/utils/session-methods-core.d.ts
 declare class SessionMethodsCore {
   /**
-   * Mutes the local user's audio during the call.
+   * Mutes or unmutes the local user's audio during the call.
+   *
+   * The boolean parameter exists for backward compatibility with the v4 SDK,
+   * where `muteAudio(false)` was the way to unmute. New code should prefer
+   * {@link SessionMethodsCore.unmuteAudio} for clarity.
+   *
+   * @param muteAudio - `true` (default) mutes the local audio track, `false` unmutes it.
    */
-  static muteAudio(): void;
+  static muteAudio(muteAudio?: boolean): void;
   /**
    * Unmutes the local user's audio during the call.
    */
@@ -1189,9 +1256,15 @@ declare class SessionMethodsCore {
    */
   static toggleAudio(): void;
   /**
-   * Pauses the local user's video stream.
+   * Pauses or resumes the local user's video stream.
+   *
+   * The boolean parameter exists for backward compatibility with the v4 SDK,
+   * where `pauseVideo(false)` was the way to resume. New code should prefer
+   * {@link SessionMethodsCore.resumeVideo} for clarity.
+   *
+   * @param pauseVideo - `true` (default) pauses the local video track, `false` resumes it.
    */
-  static pauseVideo(): void;
+  static pauseVideo(pauseVideo?: boolean): void;
   /**
    * Resumes the local user's video stream.
    */
@@ -1232,6 +1305,16 @@ declare class SessionMethodsCore {
    * @param layout - The type of layout to set (tile, sidebar or spotlight).
    */
   static setLayout(layout: Layout): void;
+  /**
+   * Starts streaming the call to the given RTMP destination.
+   * @param streamUrl - The RTMP ingest URL (e.g., "rtmp://a.rtmp.youtube.com/live2").
+   * @param streamKey - The stream key for the destination (e.g., "xxxx-xxxx-xxxx-xxxx-xxxx").
+   */
+  static startStreaming(streamUrl: string, streamKey: string): void;
+  /**
+   * Stops the ongoing call streaming.
+   */
+  static stopStreaming(): void;
   /**
    * Starts recording the call.
    */
@@ -1323,6 +1406,7 @@ type AudioMode = {
   type: AudioModeType;
   selected: boolean;
   uid?: string;
+  name?: string;
 };
 type CameraFacingInternal = ValueOf<typeof CAMERA_FACING_INTERNAL>;
 type CameraFacing = ValueOf<typeof CAMERA_FACING>;
@@ -1565,6 +1649,16 @@ declare namespace controlPanel {
     let cancel_1: string;
     export { cancel_1 as cancel };
   }
+  namespace streaming {
+    export let startStreaming: string;
+    export let stopStreaming: string;
+    export let startStreamingConfirmation: string;
+    export let stopStreamingConfirmation: string;
+    export let streamUrlPlaceholder: string;
+    export let streamKeyPlaceholder: string;
+    let cancel_2: string;
+    export { cancel_2 as cancel };
+  }
   let raiseHand: string;
   let lowerHand: string;
   let startScreenSharing: string;
@@ -1606,19 +1700,39 @@ declare namespace virtualBackground {
   export let addBackground: string;
   export let noCameraFeed: string;
   export namespace buttons_2 {
-    let cancel_2: string;
-    export { cancel_2 as cancel };
+    let cancel_3: string;
+    export { cancel_3 as cancel };
     let done_1: string;
     export { done_1 as done };
   }
   export { buttons_2 as buttons };
 }
+declare namespace indicators {
+  export namespace recording_1 {
+    let label: string;
+    let tooltip: string;
+  }
+  export { recording_1 as recording };
+  export namespace streaming_1 {
+    let label_1: string;
+    export { label_1 as label };
+    let tooltip_1: string;
+    export { tooltip_1 as tooltip };
+  }
+  export { streaming_1 as streaming };
+}
+declare namespace notifications {
+  let recordingStarted: string;
+  let recordingStopped: string;
+  let streamingStarted: string;
+  let streamingStopped: string;
+}
 declare namespace general {
   let error: string;
 }
 declare let other: {};
 declare namespace __json_default_export {
-  export { header, controlPanel, idealTimeout, participantList, virtualBackground, general, other };
+  export { header, controlPanel, idealTimeout, participantList, virtualBackground, indicators, notifications, general, other };
 }
 //#endregion
 //#region calls-sdk-core/i18n/state.d.ts
@@ -1651,6 +1765,11 @@ declare const useTranslationStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi
 }>;
 //#endregion
 //#region calls-sdk-core/i18n/hook.d.ts
+/**
+ * Non-hook variant of `t` for code that runs outside React (stores,
+ * event subscribers). Reads the translation store imperatively.
+ */
+declare function translate(key: Paths<TranslationResource>): string;
 declare const useTranslation: () => {
   t: (key: Paths<TranslationResource>) => string;
   currentLocale: "en-US" | Omit<string, "en-US">;
@@ -1721,6 +1840,15 @@ declare const useTranslation: () => {
         stopRecordingConfirmation: string;
         cancel: string;
       };
+      streaming: {
+        startStreaming: string;
+        stopStreaming: string;
+        startStreamingConfirmation: string;
+        stopStreamingConfirmation: string;
+        streamUrlPlaceholder: string;
+        streamKeyPlaceholder: string;
+        cancel: string;
+      };
       raiseHand: string;
       lowerHand: string;
       startScreenSharing: string;
@@ -1759,6 +1887,22 @@ declare const useTranslation: () => {
         done: string;
       };
     };
+    indicators: {
+      recording: {
+        label: string;
+        tooltip: string;
+      };
+      streaming: {
+        label: string;
+        tooltip: string;
+      };
+    };
+    notifications: {
+      recordingStarted: string;
+      recordingStopped: string;
+      streamingStarted: string;
+      streamingStopped: string;
+    };
     general: {
       error: string;
     };
@@ -3444,10 +3588,22 @@ declare class CallLog {
    * The time the call was initiated at.
    */
   private initiatedAt;
+  /**
+   * The time the call started at. Sent by the calls host in place of
+   * `initiatedAt`; read {@link getStartedAt} and fall back to
+   * {@link getInitiatedAt} when only one of the two is present.
+   */
+  private startedAt;
   /**
    * The call category of the call log.
    */
   private callCategory;
+  /**
+   * The mode of the call log. Sent by the calls host in place of
+   * `callCategory`; read {@link getMode} and fall back to
+   * {@link getCallCategory} when only one of the two is present.
+   */
+  private mode;
   /**
    * @type {CallUser}
    * The initiator of the call log.
@@ -3561,6 +3717,26 @@ declare class CallLog {
    * @param value - The time the call was initiated at.
    */
   setInitiatedAt(value: number): void;
+  /**
+   * Gets the time the call started at.
+   * @returns The time the call started at.
+   */
+  getStartedAt(): number;
+  /**
+   * Sets the time the call started at.
+   * @param value - The time the call started at.
+   */
+  setStartedAt(value: number): void;
+  /**
+   * Gets the mode of the call log.
+   * @returns The mode of the call log.
+   */
+  getMode(): string;
+  /**
+   * Sets the mode of the call log.
+   * @param value - The mode to set.
+   */
+  setMode(value: string): void;
   /**
    * Gets the call category of the call log.
    * @returns The call category of the call log.
@@ -3789,6 +3965,16 @@ declare class CallLogRequest {
    * @returns A promise that resolves to an array of CallLog objects, or an empty array if there are no previous pages, or rejects with a CometChatCallsException if there was an error..
    */
   fetchPrevious(): Promise<CallLog[] | []>;
+  /**
+   * Gets the page the cursor currently sits on.
+   * @returns The current page, or `0` before the first successful fetch.
+   */
+  getCurrentPage(): number;
+  /**
+   * Gets the number of pages the server reported.
+   * @returns The total page count, or `0` before the first successful fetch.
+   */
+  getTotalPages(): number;
   /**
    * Makes an API call to fetch call logs.
    * @param isFetchNext Whether to fetch the next page of call logs.
@@ -4402,6 +4588,8 @@ declare class CometChatCalls extends SessionMethodsCore {
   static CallSettingsBuilder: typeof CallSettingsBuilder;
   static CallAppSettingsBuilder: typeof CallAppSettingsBuilder;
   static Component: typeof AppReactNativeSDK;
+  static CallLogRequestBuilder: typeof CallLogRequestBuilder;
+  static CallLog: typeof CallLog;
   /**
    * Initializes the CometChat Calls SDK with the provided app settings.
    * Must be called before any other SDK methods.