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

package/src/classes/HMSEncoder.ts

@@ -41,6 +41,7 @@ import { HMSSimulcastLayerDefinition } from './HMSSimulcastLayerDefinition';
 import { HMSQualityLimitationReasons } from './HMSQualityLimitationReasons';
 import { HMSTrackType } from './HMSTrackType';
 import { HMSHLSPlaylistType } from './HMSHLSPlaylistType';
+import type { Transcriptions } from './transcriptions';
 
 interface InitialData {
   roles: Record<string, HMSRole>;
@@ -700,4 +701,38 @@ export class HMSEncoder {
 
     return transformed;
   }
+
+  static encodeTranscriptions(data: Array<any>): Array<Transcriptions> {
+    if (Array.isArray(data)) {
+      data.forEach((transcriptions: Transcriptions) => {
+        if ('initialisedAt' in transcriptions) {
+          transcriptions.initialisedAt = this.encodeDate(
+            transcriptions.initialisedAt
+          );
+        }
+        if ('startedAt' in transcriptions) {
+          transcriptions.startedAt = this.encodeDate(transcriptions.startedAt);
+        }
+        if ('stoppedAt' in transcriptions) {
+          transcriptions.stoppedAt = this.encodeDate(transcriptions.stoppedAt);
+        }
+        if ('updatedAt' in transcriptions) {
+          transcriptions.updatedAt = this.encodeDate(transcriptions.updatedAt);
+        }
+      });
+      return data as Array<Transcriptions>;
+    } else {
+      return [];
+    }
+  }
+
+  static transformTranscripts(data: Array<any>) {
+    data.forEach((encodedTranscript) => {
+      if ('peerId' in encodedTranscript) {
+        encodedTranscript.peer = HMSEncoder.encodeHmsPeer({
+          peerID: encodedTranscript.peerId,
+        });
+      }
+    });
+  }
 }

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/HMSPeer.ts

@@ -9,7 +9,7 @@ import { HMSPeerType } from './HMSPeerType';
 
 export class HMSPeer {
   peerID: string;
-  name: string;
+  private _name: string | undefined;
   private _isLocal: boolean | undefined;
   private _customerUserID: string | undefined;
   private _metadata: string | undefined;
@@ -17,6 +17,13 @@ export class HMSPeer {
   private _isHandRaised: boolean = false;
   private _type: HMSPeerType = HMSPeerType.REGULAR;
 
+  private _updateName(value: string) {
+    // If `_isLocal` is outdated, update it
+    if (this._name !== value) {
+      this._name = value;
+    }
+  }
+
   private _updateIsLocal(value: boolean) {
     // If `_isLocal` is outdated, update it
     if (this._isLocal !== value) {
@@ -61,7 +68,27 @@ export class HMSPeer {
 
   constructor(params: { peerID: string; name: string }) {
     this.peerID = params.peerID;
-    this.name = params.name;
+    this._name = params.name;
+  }
+
+  get name(): string | undefined {
+    if (this._name) {
+      return this._name;
+    }
+    const hmsPeersCache = getHmsPeersCache();
+
+    const value = hmsPeersCache
+      ? hmsPeersCache.getProperty(this.peerID, 'name')
+      : getPeerPropertyFromNative(
+          HMSConstants.DEFAULT_SDK_ID,
+          this.peerID,
+          'name'
+        );
+
+    if (typeof value === 'string') {
+      this._updateName(value);
+    }
+    return value ?? this._name;
   }
 
   get isLocal(): boolean | undefined {

package/src/classes/HMSPermissions.ts

@@ -1,9 +1,16 @@
+import type { TranscriptionsMode } from './transcriptions';
+
 export interface HMSWhiteboardPermission {
   admin?: boolean;
   write?: boolean;
   read?: boolean;
 }
 
+export interface HMSTranscriptionPermissions {
+  admin: boolean;
+  mode?: TranscriptionsMode;
+}
+
 export class HMSPermissions {
   endRoom?: boolean;
   removeOthers?: boolean;
@@ -16,6 +23,7 @@ export class HMSPermissions {
   pollRead?: boolean;
   pollWrite?: boolean;
   whiteboard?: HMSWhiteboardPermission;
+  transcriptions?: Array<HMSTranscriptionPermissions>;
 
   constructor(params?: {
     endRoom?: boolean;
@@ -29,6 +37,7 @@ export class HMSPermissions {
     pollRead?: boolean;
     pollWrite?: boolean;
     whiteboard?: HMSWhiteboardPermission;
+    transcriptions?: Array<HMSTranscriptionPermissions>;
   }) {
     if (params) {
       this.endRoom = params.endRoom;
@@ -42,6 +51,7 @@ export class HMSPermissions {
       this.pollRead = params.pollRead;
       this.pollWrite = params.pollWrite;
       this.whiteboard = params.whiteboard;
+      this.transcriptions = params.transcriptions;
     }
   }
 }

package/src/classes/HMSRoom.ts

@@ -7,6 +7,7 @@ import type { HMSHLSRecordingState } from './HMSHLSRecordingState';
 import type { HMSLocalPeer } from './HMSLocalPeer';
 import { getHmsRoomCache, getHMSRoomPropertyFromNative } from './HMSRoomCache';
 import { HMSConstants } from './HMSConstants';
+import type { Transcriptions } from './transcriptions/Transcriptions';
 
 export class HMSRoom {
   id: string;
@@ -166,4 +167,17 @@ export class HMSRoom {
       'isLargeRoom'
     );
   }
+
+  get transcriptions(): Array<Transcriptions> {
+    const hmsRoomCache = getHmsRoomCache();
+
+    if (hmsRoomCache) {
+      return hmsRoomCache.getProperty('transcriptions');
+    }
+
+    return getHMSRoomPropertyFromNative(
+      HMSConstants.DEFAULT_SDK_ID,
+      'transcriptions'
+    );
+  }
 }

package/src/classes/HMSRoomCache.ts

@@ -99,6 +99,13 @@ export class HMSRoomCache {
         );
         break;
       }
+      case HMSRoomUpdate.TRANSCRIPTIONS_UPDATED: {
+        this._data.set(
+          'transcriptions',
+          encodeHMSRoomProperty(this.id, 'transcriptions', data)
+        );
+        break;
+      }
       default: {
         for (const key in data) {
           const property = key as keyof HMSRoomCacheProps;
@@ -153,6 +160,8 @@ function encodeHMSRoomProperty<T extends keyof HMSRoomCacheProps>(
     value = HMSEncoder.encodeHLSStreamingState(data.hlsStreamingState);
   } else if (property === 'hlsRecordingState') {
     value = HMSEncoder.encodeHLSRecordingState(data.hlsRecordingState);
+  } else if (property === 'transcriptions') {
+    value = HMSEncoder.encodeTranscriptions(data.transcriptions);
   } else if (property === 'localPeer') {
     value = HMSEncoder.encodeHmsLocalPeer(data.localPeer, id);
   } else if (property === 'peerCount') {

package/src/classes/HMSRoomUpdate.ts

@@ -7,4 +7,5 @@ export enum HMSRoomUpdate {
   HLS_STREAMING_STATE_UPDATED = 'HLS_STREAMING_STATE_UPDATED',
   HLS_RECORDING_STATE_UPDATED = 'HLS_RECORDING_STATE_UPDATED',
   ROOM_PEER_COUNT_UPDATED = 'ROOM_PEER_COUNT_UPDATED',
+  TRANSCRIPTIONS_UPDATED = 'TRANSCRIPTIONS_UPDATED',
 }

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'>;
 
@@ -63,6 +63,7 @@ export class HMSSDK {
   private onPreviewDelegate?: any;
   private onJoinDelegate?: any;
   private onRoomDelegate?: any;
+  private onTranscriptsDelegate?: any;
   private onPeerDelegate?: any;
   private onPeerListUpdatedDelegate?: any;
   private onTrackDelegate?: any;
@@ -1288,6 +1289,24 @@ export class HMSSDK {
         this.onRoomDelegate = callback;
         break;
       }
+      case HMSUpdateListenerActions.ON_TRANSCRIPTS: {
+        // Checking if we already have ON_TRANSCRIPTS subscription
+        if (
+          !this.emitterSubscriptions[HMSUpdateListenerActions.ON_TRANSCRIPTS]
+        ) {
+          // Adding ON_TRANSCRIPTS native listener
+          const transcriptsSubscription = HMSNativeEventListener.addListener(
+            this.id,
+            HMSUpdateListenerActions.ON_TRANSCRIPTS,
+            this.onTranscriptsListener
+          );
+          this.emitterSubscriptions[HMSUpdateListenerActions.ON_TRANSCRIPTS] =
+            transcriptsSubscription;
+        }
+        // Adding App Delegate listener
+        this.onTranscriptsDelegate = callback;
+        break;
+      }
       case HMSUpdateListenerActions.ON_PEER_UPDATE: {
         // Checking if we already have ON_PEER_UPDATE subscription
         if (
@@ -1654,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:
@@ -1734,6 +1748,20 @@ export class HMSSDK {
         this.onRoomDelegate = null;
         break;
       }
+      case HMSUpdateListenerActions.ON_TRANSCRIPTS: {
+        const subscription =
+          this.emitterSubscriptions[HMSUpdateListenerActions.ON_TRANSCRIPTS];
+        // Removing ON_TRANSCRIPTS native listener
+        if (subscription) {
+          subscription.remove();
+
+          this.emitterSubscriptions[HMSUpdateListenerActions.ON_TRANSCRIPTS] =
+            undefined;
+        }
+        // Removing App Delegate listener
+        this.onTranscriptsDelegate = null;
+        break;
+      }
       case HMSUpdateListenerActions.ON_PEER_UPDATE: {
         const subscription =
           this.emitterSubscriptions[HMSUpdateListenerActions.ON_PEER_UPDATE];
@@ -2139,6 +2167,18 @@ export class HMSSDK {
     }
   };
 
+  onTranscriptsListener = (data: any) => {
+    if (data.id !== this.id) {
+      return;
+    }
+    HMSEncoder.transformTranscripts(data.transcripts);
+
+    if (this.onTranscriptsDelegate) {
+      logger?.verbose('#Listener ON_TRANSCRIPTS_LISTENER_CALL', data);
+      this.onTranscriptsDelegate(data);
+    }
+  };
+
   onPeerListener = (peerData: any) => {
     const data: { peer: any; type: any } = {
       peer: peerData,
@@ -2475,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;
@@ -2490,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);
@@ -2498,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,
@@ -2516,6 +2574,48 @@ 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,
+      action: 'start',
+    };
+    logger?.verbose('#Function startRealTimeTranscription', data);
+    return HMSManager.handleRealTimeTranscription(data);
+  }
+
+  async stopRealTimeTranscription() {
+    const data = {
+      id: this.id,
+      action: 'stop',
+    };
+    logger?.verbose('#Function stopRealTimeTranscription', data);
+    return HMSManager.handleRealTimeTranscription(data);
+  }
+
   get interactivityCenter() {
     if (!this._interactivityCenter) {
       this._interactivityCenter = new HMSInteractivityCenter();

package/src/classes/HMSUpdateListenerActions.ts

@@ -27,4 +27,5 @@ export enum HMSUpdateListenerActions {
   ON_SESSION_STORE_AVAILABLE = 'ON_SESSION_STORE_AVAILABLE',
   ON_SESSION_STORE_CHANGED = 'ON_SESSION_STORE_CHANGED',
   ON_PEER_LIST_UPDATED = 'ON_PEER_LIST_UPDATED',
+  ON_TRANSCRIPTS = 'ON_TRANSCRIPTS',
 }

package/src/classes/transcriptions/HMSTranscript.ts

@@ -0,0 +1,13 @@
+import type { HMSPeer } from '../HMSPeer';
+
+export interface HMSTranscript {
+  transcript: string;
+
+  peer: HMSPeer;
+
+  end: number;
+
+  start: number;
+
+  isFinal: boolean;
+}

package/src/classes/transcriptions/OnTranscriptionError.ts

@@ -0,0 +1,5 @@
+export interface OnTranscriptionError {
+  code?: number;
+
+  message?: string;
+}

package/src/classes/transcriptions/TranscriptionState.ts

@@ -0,0 +1,6 @@
+export enum TranscriptionState {
+  FAILED = 'FAILED',
+  INITIALIZED = 'INITIALIZED',
+  STARTED = 'STARTED',
+  STOPPED = 'STOPPED',
+}

package/src/classes/transcriptions/Transcriptions.ts

@@ -0,0 +1,19 @@
+import type { OnTranscriptionError } from './OnTranscriptionError';
+import type { TranscriptionState } from './TranscriptionState';
+import type { TranscriptionsMode } from './TranscriptionsMode';
+
+export interface Transcriptions {
+  error?: OnTranscriptionError;
+
+  mode?: TranscriptionsMode;
+
+  state?: TranscriptionState;
+
+  initialisedAt?: Date;
+
+  startedAt?: Date;
+
+  stoppedAt?: Date;
+
+  updatedAt?: Date;
+}

package/src/classes/transcriptions/TranscriptionsMode.ts

@@ -0,0 +1,4 @@
+export enum TranscriptionsMode {
+  CAPTION = 'CAPTION',
+  LIVE = 'LIVE',
+}

package/src/classes/transcriptions/index.ts

@@ -0,0 +1,5 @@
+export * from './OnTranscriptionError';
+export * from './TranscriptionState';
+export * from './TranscriptionsMode';
+export * from './Transcriptions';
+export * from './HMSTranscript';

package/src/index.ts

@@ -114,6 +114,8 @@ export { PollLeaderboardResponse } from './classes/polls/PollLeaderboardResponse
 export { HMSPollLeaderboardEntry } from './classes/polls/HMSPollLeaderboardEntry';
 export { HMSPollLeaderboardSummary } from './classes/polls/HMSPollLeaderboardSummary';
 
+export * from './classes/transcriptions';
+
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 
 // 100ms React Native Module