@100mslive/react-native-hms 1.10.7 → 1.10.8

package/lib/typescript/classes/HMSPIPConfig.d.ts

@@ -1,6 +1,9 @@
+import type { HMSVideoViewMode } from './HMSVideoViewMode';
 export interface HMSPIPConfig {
     autoEnterPipMode?: boolean;
     aspectRatio?: [number, number];
+    scaleType?: HMSVideoViewMode;
+    useActiveSpeaker?: boolean;
     endButton?: boolean;
     audioButton?: boolean;
     videoButton?: boolean;

package/lib/typescript/classes/HMSSDK.d.ts

@@ -23,6 +23,7 @@ import { HMSPeerListIterator } from './HMSPeerListIterator';
 import type { HMSPIPConfig } from './HMSPIPConfig';
 import { HMSInteractivityCenter } from './HMSInteractivityCenter';
 import type { HMSHLSTimedMetadata } from './HMSHLSTimedMetadata';
+import type { HMSVideoTrack } from './HMSVideoTrack';
 type HmsViewProps = Omit<HmsComponentProps, 'id'>;
 export declare class HMSSDK {
     id: string;
@@ -638,6 +639,8 @@ export declare class HMSSDK {
     isPipModeSupported(): Promise<undefined | boolean>;
     enterPipMode(data?: HMSPIPConfig): Promise<undefined | boolean>;
     setPipParams(data?: HMSPIPConfig): Promise<undefined | boolean>;
+    changeIOSPIPVideoTrack(track: HMSVideoTrack): Promise<any>;
+    setActiveSpeakerInIOSPIP(enable: boolean): Promise<any>;
     startRealTimeTranscription(): Promise<any>;
     stopRealTimeTranscription(): Promise<any>;
     get interactivityCenter(): HMSInteractivityCenter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "1.10.7",
+  "version": "1.10.8",
   "description": "Integrate Real Time Audio and Video conferencing, Interactive Live Streaming, and Chat in your apps with 100ms React Native SDK. With support for HLS and RTMP Live Streaming and Recording, Picture-in-Picture (PiP), one-to-one Video Call Modes, Audio Rooms, Video Player and much more, add immersive real-time communications to your apps.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/sdk-versions.json

@@ -1,7 +1,7 @@
 {
-  "ios": "1.12.0",
+  "ios": "1.13.0",
   "iOSBroadcastExtension": "0.0.9",
   "iOSHMSHLSPlayer": "0.0.2",
   "iOSNoiseCancellationModels": "1.0.0",
-  "android": "2.9.60"
+  "android": "2.9.62"
 }

package/src/classes/HMSPIPConfig.ts

@@ -1,7 +1,37 @@
+import type { HMSVideoViewMode } from './HMSVideoViewMode';
+
 export interface HMSPIPConfig {
+  /*
+   * Whether to automatically enter PIP mode when app enters background.
+   */
   autoEnterPipMode?: boolean;
+
+  /*
+   * The aspect ratio of the PIP window. Default is [9, 16]. Other values can be [3, 4], [1, 1], [4, 3], [16, 9].
+   */
   aspectRatio?: [number, number];
+
+  /*
+   * The scale type of the PIP window. Default is ASPECT_FILL. Other values can be ASPECT_FIT, ASPECT_BALANCED. iOS Only.
+   */
+  scaleType?: HMSVideoViewMode;
+
+  /*
+   * Whether to show the Active Speaker in the PIP window. Default is true. iOS only.
+   */
+  useActiveSpeaker?: boolean;
+  /*
+   * Whether to show the end button in the PIP window. Default is true. Android only.
+   */
   endButton?: boolean;
+
+  /*
+   * Whether to show the audio mute/unmute button in the PIP window. Default is true. Android only.
+   */
   audioButton?: boolean;
+
+  /*
+   * Whether to show the video mute/unmute button in the PIP window. Default is true. Android only.
+   */
   videoButton?: boolean;
 }

package/src/classes/HMSSDK.tsx

@@ -18,7 +18,6 @@ import type { HMSRole } from './HMSRole';
 import type { HMSTrack } from './HMSTrack';
 import type { HMSLogger } from './HMSLogger';
 import type { HMSPeer } from './HMSPeer';
-import type { HMSVideoViewMode } from './HMSVideoViewMode';
 import type { HMSTrackSettings } from './HMSTrackSettings';
 import type { HMSRTMPConfig } from './HMSRTMPConfig';
 import type { HMSHLSConfig } from './HMSHLSConfig';
@@ -48,6 +47,7 @@ import { HMSPeerListIterator } from './HMSPeerListIterator';
 import type { HMSPIPConfig } from './HMSPIPConfig';
 import { HMSInteractivityCenter } from './HMSInteractivityCenter';
 import type { HMSHLSTimedMetadata } from './HMSHLSTimedMetadata';
+import type { HMSVideoTrack } from './HMSVideoTrack';
 
 type HmsViewProps = Omit<HmsComponentProps, 'id'>;
 
@@ -1673,26 +1673,21 @@ export class HMSSDK {
         break;
       }
       case HMSPIPListenerActions.ON_PIP_MODE_CHANGED: {
-        if (Platform.OS === 'android') {
-          // Checking if we already have ON_PIP_MODE_CHANGED subscription
-          if (
-            !this.emitterSubscriptions[
-              HMSPIPListenerActions.ON_PIP_MODE_CHANGED
-            ]
-          ) {
-            const pipModeChangedSubscription =
-              HMSNativeEventListener.addListener(
-                this.id,
-                HMSPIPListenerActions.ON_PIP_MODE_CHANGED,
-                this.onPIPModeChangedListener
-              );
-            this.emitterSubscriptions[
-              HMSPIPListenerActions.ON_PIP_MODE_CHANGED
-            ] = pipModeChangedSubscription;
-          }
-          // Adding PIP mode changed Delegate listener
-          this.onPIPModeChangedDelegate = callback;
+        // Checking if we already have ON_PIP_MODE_CHANGED subscription
+        if (
+          !this.emitterSubscriptions[HMSPIPListenerActions.ON_PIP_MODE_CHANGED]
+        ) {
+          const pipModeChangedSubscription = HMSNativeEventListener.addListener(
+            this.id,
+            HMSPIPListenerActions.ON_PIP_MODE_CHANGED,
+            this.onPIPModeChangedListener
+          );
+          this.emitterSubscriptions[HMSPIPListenerActions.ON_PIP_MODE_CHANGED] =
+            pipModeChangedSubscription;
         }
+        // Adding PIP mode changed Delegate listener
+        this.onPIPModeChangedDelegate = callback;
+
         break;
       }
       default:
@@ -2520,6 +2515,9 @@ export class HMSSDK {
     }
   };
 
+  /*
+   * - This listener is fired when Room is left from the Picture in Picture mode. Android only.
+   */
   onPIPRoomLeaveListener = (data: { id: string }) => {
     if (data.id !== this.id) {
       return;
@@ -2535,6 +2533,9 @@ export class HMSSDK {
     }
   };
 
+  /*
+   * - Attach this listener to get notified when Picture in Picture mode is changed
+   */
   onPIPModeChangedListener = (data: { isInPictureInPictureMode: boolean }) => {
     if (this.onPIPModeChangedDelegate) {
       logger?.verbose('#Listener onPIPModeChanged_CALL', data);
@@ -2543,17 +2544,29 @@ export class HMSSDK {
     }
   };
 
+  /*
+   * - This function is used to check if Picture in Picture mode is supported on the device
+   */
   async isPipModeSupported(): Promise<undefined | boolean> {
-    return HMSManager.handlePipActions('isPipModeSupported', { id: this.id });
+    const data = { id: this.id };
+    logger?.verbose('#Function isPipModeSupported', data);
+    return HMSManager.handlePipActions('isPipModeSupported', data);
   }
 
+  /*
+   * - This function can be used to manually enter Picture in Picture mode
+   */
   async enterPipMode(data?: HMSPIPConfig): Promise<undefined | boolean> {
+    logger?.verbose('#Function enterPipMode', data);
     return HMSManager.handlePipActions('enterPipMode', {
       ...data,
       id: this.id,
     });
   }
 
+  /*
+   * - This function is to be used to configure the Picture in Picture window
+   */
   async setPipParams(data?: HMSPIPConfig): Promise<undefined | boolean> {
     return HMSManager.handlePipActions('setPictureInPictureParams', {
       ...data,
@@ -2561,6 +2574,30 @@ export class HMSSDK {
     });
   }
 
+  /*
+   * - Use this function to set Video Track for Picture in Picture mode. iOS Only.
+   */
+  async changeIOSPIPVideoTrack(track: HMSVideoTrack) {
+    const data = {
+      id: this.id,
+      trackId: track.trackId,
+    };
+    logger?.verbose('#Function changeIOSPIPVideoTrack', data);
+    return await HMSManager.changeIOSPIPVideoTrack(data);
+  }
+
+  /*
+   * - Use this function to automatically show the current Active Speaker Peer video in the PIP Mode window. iOS Only.
+   */
+  async setActiveSpeakerInIOSPIP(enable: boolean) {
+    const data = {
+      id: this.id,
+      enable,
+    };
+    logger?.verbose('#Function setActiveSpeakerInIOSPIP', data);
+    return await HMSManager.setActiveSpeakerInIOSPIP(data);
+  }
+
   async startRealTimeTranscription() {
     const data = {
       id: this.id,