@100mslive/react-native-hms 0.9.94 → 1.1.0

package/src/classes/HMSSDK.tsx

@@ -34,6 +34,8 @@ import type { HMSAudioDevice } from './HMSAudioDevice';
 import type { HMSAudioMode } from './HMSAudioMode';
 import type { HMSAudioMixingMode } from './HMSAudioMixingMode';
 import type { HMSLogSettings } from './HMSLogSettings';
+import { HMSMessageType } from './HMSMessageType';
+import { HMSPIPListenerActions } from './HMSPIPListenerActions';
 
 interface HmsViewProps {
   trackId: string;
@@ -43,6 +45,13 @@ interface HmsViewProps {
   setZOrderMediaOverlay?: boolean;
 }
 
+interface PIPConfig {
+  aspectRatio?: [number, number];
+  endButton?: boolean;
+  audioButton?: boolean;
+  videoButton?: boolean;
+}
+
 const {
   /**
    * @ignore
@@ -80,6 +89,7 @@ export class HMSSDK {
   private onRemoteAudioStatsDelegate?: any;
   private onRemoteVideoStatsDelegate?: any;
   private onAudioDeviceChangedDelegate?: any;
+  private onPIPRoomLeaveDelegate?: any;
 
   private constructor(id: string) {
     this.id = id;
@@ -254,6 +264,13 @@ export class HMSSDK {
       HMSUpdateListenerActions.ON_AUDIO_DEVICE_CHANGED,
       this.onAudioDeviceChangedListener
     );
+
+    if (Platform.OS === 'android') {
+      HmsEventEmitter.addListener(
+        HMSPIPListenerActions.ON_PIP_ROOM_LEAVE,
+        this.onPIPRoomLeaveListener
+      );
+    }
   };
 
   /**
@@ -356,6 +373,13 @@ export class HMSSDK {
       HMSUpdateListenerActions.ON_AUDIO_DEVICE_CHANGED,
       this.onAudioDeviceChangedListener
     );
+
+    if (Platform.OS === 'android') {
+      HmsEventEmitter.removeListener(
+        HMSPIPListenerActions.ON_PIP_ROOM_LEAVE,
+        this.onPIPRoomLeaveListener
+      );
+    }
   };
 
   /**
@@ -464,7 +488,10 @@ export class HMSSDK {
    * @param {message: string} and @param {type: string}
    * @memberof HMSSDK
    */
-  sendBroadcastMessage = async (message: string, type: string = 'chat') => {
+  sendBroadcastMessage = async (
+    message: string,
+    type: HMSMessageType = HMSMessageType.CHAT
+  ) => {
     logger?.verbose('#Function sendBroadcastMessage', {
       message,
       type: type || null,
@@ -488,7 +515,7 @@ export class HMSSDK {
   sendGroupMessage = async (
     message: string,
     roles: HMSRole[],
-    type: string = 'chat'
+    type: HMSMessageType = HMSMessageType.CHAT
   ) => {
     logger?.verbose('#Function sendGroupMessage', {
       message,
@@ -515,7 +542,7 @@ export class HMSSDK {
   sendDirectMessage = async (
     message: string,
     peer: HMSPeer,
-    type: string = 'chat'
+    type: HMSMessageType = HMSMessageType.CHAT
   ) => {
     logger?.verbose('#Function sendDirectMessage', {
       message,
@@ -612,6 +639,8 @@ export class HMSSDK {
   };
 
   /**
+   * @deprecated This function has been deprecated in favor of #Function changeRoleOfPeer
+   *
    * - This function can be used in a situation when we want to change role hence manipulate their
    * access and rights in the current room, it takes the peer {@link HMSPeer} whom role we want to change,
    * role {@link HMSRole} which will be the new role for that peer and weather to forcefully change
@@ -636,6 +665,58 @@ export class HMSSDK {
     return await HMSManager.changeRole(data);
   };
 
+  /**
+   * - This function can be used in a situation when we want to change role hence manipulate their
+   * access and rights in the current room, it takes the peer {@link HMSPeer} whom role we want to change,
+   * role {@link HMSRole} which will be the new role for that peer and weather to forcefully change
+   * the role or ask the to accept the role change request using a boolean force.
+   *
+   * - if we change the role forcefully the peer's role will be updated without asking the peer
+   * otherwise the user will get the roleChangeRequest in roleChangeRequest listener.
+   * for more information on this checkout {@link onRoleChangeRequestListener}
+   *
+   * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-role} for more info
+   *
+   * @memberof HMSSDK
+   */
+  changeRoleOfPeer = async (
+    peer: HMSPeer,
+    role: HMSRole,
+    force: boolean = false
+  ) => {
+    const data = {
+      peerId: peer.peerID,
+      role: role.name,
+      force: force,
+      id: this.id,
+    };
+    logger?.verbose('#Function changeRoleOfPeer', data);
+    return HMSManager.changeRoleOfPeer(data);
+  };
+
+  /**
+   * - This function can be used in a situation when we want to change role of multiple peers by specifying their roles.
+   * Hence manipulate their access and rights in the current room.
+   * It takes the list of roles {@link HMSRole} whom role we want to change
+   * and role {@link HMSRole} which will be the new role for peers.
+   *
+   * - Note that role will be updated without asking the peers.
+   * Meaning, Peers will not get the roleChangeRequest in roleChangeRequest listener.
+   *
+   * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-role} for more info
+   *
+   * @memberof HMSSDK
+   */
+  changeRoleOfPeersWithRoles = async (ofRoles: HMSRole[], toRole: HMSRole) => {
+    const data = {
+      ofRoles: ofRoles.map((ofRole) => ofRole.name).filter(Boolean),
+      toRole: toRole.name,
+      id: this.id,
+    };
+    logger?.verbose('#Function changeRoleOfPeersWithRoles', data);
+    return HMSManager.changeRoleOfPeersWithRoles(data);
+  };
+
   /**
    * - This function can be used to manipulate mute status of any track.
    * - Targeted peer affected by this action will get a callback in onChangeTrackStateRequestListener.
@@ -1188,6 +1269,24 @@ export class HMSSDK {
     }
   };
 
+  setSessionMetaData = async (sessionMetaData: string | null) => {
+    logger?.verbose('#Function setSessionMetaData', {
+      id: this.id,
+      sessionMetaData,
+    });
+    return await HMSManager.setSessionMetaData({
+      id: this.id,
+      sessionMetaData,
+    });
+  };
+
+  getSessionMetaData = async () => {
+    logger?.verbose('#Function getSessionMetaData', {
+      id: this.id,
+    });
+    return await HMSManager.getSessionMetaData({ id: this.id });
+  };
+
   /**
    * - This is a prototype event listener that takes action and listens for updates related to that particular action
    *
@@ -1195,7 +1294,10 @@ export class HMSSDK {
    * @param {*} callback
    * @memberof HMSSDK
    */
-  addEventListener = (action: HMSUpdateListenerActions, callback: any) => {
+  addEventListener = (
+    action: HMSUpdateListenerActions | HMSPIPListenerActions,
+    callback: any
+  ) => {
     logger?.verbose('#Function addEventListener', {
       action,
       id: this.id,
@@ -1258,6 +1360,9 @@ export class HMSSDK {
       case HMSUpdateListenerActions.ON_AUDIO_DEVICE_CHANGED:
         this.onAudioDeviceChangedDelegate = callback;
         break;
+      case HMSPIPListenerActions.ON_PIP_ROOM_LEAVE:
+        this.onPIPRoomLeaveDelegate = callback;
+        break;
       default:
     }
   };
@@ -1269,7 +1374,9 @@ export class HMSSDK {
    * @param {*} callback
    * @memberof HMSSDK
    */
-  removeEventListener = (action: HMSUpdateListenerActions) => {
+  removeEventListener = (
+    action: HMSUpdateListenerActions | HMSPIPListenerActions
+  ) => {
     logger?.verbose('#Function removeEventListener', { action, id: this.id });
     switch (action) {
       case HMSUpdateListenerActions.ON_PREVIEW:
@@ -1329,6 +1436,9 @@ export class HMSSDK {
       case HMSUpdateListenerActions.ON_AUDIO_DEVICE_CHANGED:
         this.onAudioDeviceChangedDelegate = null;
         break;
+      case HMSPIPListenerActions.ON_PIP_ROOM_LEAVE:
+        this.onPIPRoomLeaveDelegate = null;
+        break;
       default:
     }
   };
@@ -1352,6 +1462,7 @@ export class HMSSDK {
     this.onRoleChangeRequestDelegate = null;
     this.onChangeTrackStateRequestDelegate = null;
     this.onRemovedFromRoomDelegate = null;
+    this.onPIPRoomLeaveDelegate = null;
 
     logger?.verbose('#Function REMOVE_ALL_LISTENER', { id: this.id });
   };
@@ -1693,4 +1804,37 @@ export class HMSSDK {
       });
     }
   };
+
+  onPIPRoomLeaveListener = (data: { id: string }) => {
+    if (data.id !== this.id) {
+      return;
+    }
+    this.muteStatus = undefined;
+    this?.appStateSubscription?.remove();
+
+    if (this.onPIPRoomLeaveDelegate) {
+      logger?.verbose('#Listener onPIPRoomLeave_CALL', data);
+      this.onPIPRoomLeaveDelegate({
+        ...data,
+      });
+    }
+  };
+
+  async isPipModeSupported(): Promise<undefined | boolean> {
+    return HMSManager.handlePipActions('isPipModeSupported', { id: this.id });
+  }
+
+  async enablePipMode(data?: PIPConfig): Promise<undefined | boolean> {
+    return HMSManager.handlePipActions('enablePipMode', {
+      ...data,
+      id: this.id,
+    });
+  }
+
+  async setPipParams(data?: PIPConfig): Promise<undefined | boolean> {
+    return HMSManager.handlePipActions('setPictureInPictureParams', {
+      ...data,
+      id: this.id,
+    });
+  }
 }

package/src/classes/HmsView.tsx

@@ -46,6 +46,7 @@ export const HmsViewComponent = React.forwardRef<any, HmsComponentProps>(
     } = props;
 
     const hmsViewRef: any = useRef();
+    const timerRef = useRef<null | NodeJS.Timeout>(null);
     const [tempVal, setTempVal] = useState(0);
     const data = {
       trackId,
@@ -53,10 +54,23 @@ export const HmsViewComponent = React.forwardRef<any, HmsComponentProps>(
       mirror,
     };
 
+    useEffect(() => {
+      return () => {
+        if (timerRef.current) {
+          clearTimeout(timerRef.current);
+        }
+      };
+    }, []);
+
     const onChange = (values: any) => {
       console.log(values, 'values');
-      setTimeout(() => {
+      if (timerRef.current) {
+        clearTimeout(timerRef.current);
+      }
+
+      timerRef.current = setTimeout(() => {
         setTempVal(1);
+        timerRef.current = null;
       }, 2000);
     };
 

package/src/index.ts

@@ -73,6 +73,8 @@ export * from './classes/HMSAudioMixerSource';
 export * from './classes/HMSTrackSettingsInitState';
 export * from './classes/HMSLogSettings';
 export * from './classes/HMSLogAlarmManager';
+export * from './classes/HMSMessageType';
+export * from './classes/HMSPIPListenerActions';
 
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 export default HmsManager;

package/android/.idea/libraries/Gradle__com_facebook_fbjni_fbjni_java_only_0_2_2.xml

@@ -1,13 +0,0 @@
-<component name="libraryTable">
-  <library name="Gradle: com.facebook.fbjni:fbjni-java-only:0.2.2">
-    <CLASSES>
-      <root url="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/com.facebook.fbjni/fbjni-java-only/0.2.2/de5152e6b7ce18dd242be23994e702309e66e7da/fbjni-java-only-0.2.2.jar!/" />
-    </CLASSES>
-    <JAVADOC>
-      <root url="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/com.facebook.fbjni/fbjni-java-only/0.2.2/3ae63793d5de5510511fc9b06e9b0a962b0c0f1b/fbjni-java-only-0.2.2-javadoc.jar!/" />
-    </JAVADOC>
-    <SOURCES>
-      <root url="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/com.facebook.fbjni/fbjni-java-only/0.2.2/151550a3db34fafa434c02050086e78fa9c0b44f/fbjni-java-only-0.2.2-sources.jar!/" />
-    </SOURCES>
-  </library>
-</component>

package/android/.idea/libraries/Gradle__com_facebook_react_react_native_0_70_3_debug_aar.xml

@@ -1,14 +0,0 @@
-<component name="libraryTable">
-  <library name="Gradle: com.facebook.react:react-native:0.70.3:debug@aar">
-    <ANNOTATIONS>
-      <root url="jar://$USER_HOME$/.gradle/caches/transforms-3/573f2f2b52609e6becf85013f675e3c1/transformed/react-native-0.70.3-debug/annotations.zip!/" />
-    </ANNOTATIONS>
-    <CLASSES>
-      <root url="jar://$USER_HOME$/.gradle/caches/transforms-3/573f2f2b52609e6becf85013f675e3c1/transformed/react-native-0.70.3-debug/jars/classes.jar!/" />
-      <root url="file://$USER_HOME$/.gradle/caches/transforms-3/573f2f2b52609e6becf85013f675e3c1/transformed/react-native-0.70.3-debug/res" />
-      <root url="file://$USER_HOME$/.gradle/caches/transforms-3/573f2f2b52609e6becf85013f675e3c1/transformed/react-native-0.70.3-debug/AndroidManifest.xml" />
-    </CLASSES>
-    <JAVADOC />
-    <SOURCES />
-  </library>
-</component>