@100mslive/react-native-hms 1.8.0 → 1.9.1-beta.0

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

@@ -18,13 +18,10 @@ import type { HMSAudioMode } from './HMSAudioMode';
 import type { HMSAudioMixingMode } from './HMSAudioMixingMode';
 import type { HMSLogSettings } from './HMSLogSettings';
 import { HMSPIPListenerActions } from './HMSPIPListenerActions';
+import type { HMSPeerListIteratorOptions } from './HMSPeerListIteratorOptions';
+import { HMSPeerListIterator } from './HMSPeerListIterator';
+import type { HMSPIPConfig } from './HMSPIPConfig';
 type HmsViewProps = Omit<HmsComponentProps, 'id'>;
-interface PIPConfig {
-    aspectRatio?: [number, number];
-    endButton?: boolean;
-    audioButton?: boolean;
-    videoButton?: boolean;
-}
 export declare class HMSSDK {
     id: string;
     private muteStatus;
@@ -33,6 +30,7 @@ export declare class HMSSDK {
     private onJoinDelegate?;
     private onRoomDelegate?;
     private onPeerDelegate?;
+    private onPeerListUpdatedDelegate?;
     private onTrackDelegate?;
     private onErrorDelegate?;
     private onMessageDelegate?;
@@ -50,6 +48,7 @@ export declare class HMSSDK {
     private onAudioDeviceChangedDelegate?;
     private onSessionStoreAvailableDelegate?;
     private onPIPRoomLeaveDelegate?;
+    private onPIPModeChangedDelegate?;
     private emitterSubscriptions;
     private constructor();
     /**
@@ -525,6 +524,40 @@ export declare class HMSSDK {
     getRemoteVideoTrackFromTrackId: (trackId: string) => Promise<import("./HMSRemoteVideoTrack").HMSRemoteVideoTrack>;
     getRemoteAudioTrackFromTrackId: (trackId: string) => Promise<import("./HMSRemoteAudioTrack").HMSRemoteAudioTrack>;
     getPeerFromPeerId: (peerId: string) => HMSPeer | undefined;
+    /**
+     * - This function is used to raise hand for the local peer
+     * @memberof HMSSDK
+     */
+    raiseLocalPeerHand: () => Promise<any>;
+    /**
+     * - This function is used to lower hand for the local peer
+     * @memberof HMSSDK
+     */
+    lowerLocalPeerHand: () => Promise<any>;
+    /**
+     * - This function is used to lower hand for the remote peer
+     * @param peer
+     */
+    lowerRemotePeerHand: (peer: HMSPeer) => Promise<any>;
+    /**
+     * `getPeerListIterator` method returns an instance of `HMSPeerListIterator` class
+     *
+     * @param options options for configuring iterator
+     * @returns instance of HMSPeerListIterator class
+     *
+     * Example usage:
+     * ```
+     * const peerListIterator =  hmsInstance.getPeerListIterator();
+     * ```
+     * OR
+     * ```
+     * const peerListIterator =  hmsInstance.getPeerListIterator({
+     *    limit: 10,
+     *    byRoleName: 'viewer-realtime',
+     * });
+     * ```
+     */
+    getPeerListIterator: (options?: HMSPeerListIteratorOptions) => HMSPeerListIterator;
     /**
      * - This is a prototype event listener that takes action and listens for updates related to that particular action
      *
@@ -565,6 +598,9 @@ export declare class HMSSDK {
     onJoinListener: (data: any) => void;
     onRoomListener: (data: any) => void;
     onPeerListener: (peerData: any) => void;
+    private sendPeerUpdate;
+    private sendPeerUpdateWhenPeerLeaves;
+    onPeerListUpdatedListener: (data: any) => void;
     onTrackListener: (data: any) => void;
     onMessageListener: (data: any) => void;
     onSpeakerListener: (data: any) => void;
@@ -590,9 +626,12 @@ export declare class HMSSDK {
     onPIPRoomLeaveListener: (data: {
         id: string;
     }) => void;
+    onPIPModeChangedListener: (data: {
+        isInPictureInPictureMode: boolean;
+    }) => void;
     isPipModeSupported(): Promise<undefined | boolean>;
-    enablePipMode(data?: PIPConfig): Promise<undefined | boolean>;
-    setPipParams(data?: PIPConfig): Promise<undefined | boolean>;
+    enterPipMode(data?: HMSPIPConfig): Promise<undefined | boolean>;
+    setPipParams(data?: HMSPIPConfig): Promise<undefined | boolean>;
     /**
      * - Returns the instance of logger which can be used to manipulate log levels.
      * @returns @instance HMSLogger

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

@@ -25,5 +25,6 @@ export declare enum HMSUpdateListenerActions {
     ON_REMOTE_VIDEO_STATS = "ON_REMOTE_VIDEO_STATS",
     ON_AUDIO_DEVICE_CHANGED = "ON_AUDIO_DEVICE_CHANGED",
     ON_SESSION_STORE_AVAILABLE = "ON_SESSION_STORE_AVAILABLE",
-    ON_SESSION_STORE_CHANGED = "ON_SESSION_STORE_CHANGED"
+    ON_SESSION_STORE_CHANGED = "ON_SESSION_STORE_CHANGED",
+    ON_PEER_LIST_UPDATED = "ON_PEER_LIST_UPDATED"
 }

package/lib/typescript/components/HMSHLSPlayer/hooks.d.ts

@@ -2,6 +2,7 @@ import type { DependencyList } from 'react';
 import type { HMSHLSPlayerStatsUpdateEventData } from '../../types';
 import type { HMSHLSPlayerCue, HMSHLSPlayerPlaybackError, HMSHLSPlayerStatsError } from '../../stores/types';
 export declare const useHMSHLSPlayerPlaybackState: () => import("../../types").HMSHLSPlayerPlaybackState;
+export declare const useHMSHLSPlayerResolution: () => import("../../stores/types").HMSHLSPlayerResolution;
 export declare const useHMSHLSPlayerStats: () => {
     stats: HMSHLSPlayerStatsUpdateEventData;
     error: HMSHLSPlayerStatsError;
@@ -11,6 +12,7 @@ export declare const useHMSHLSPlayerStatsError: (callback: (error: NonNullable<H
 export declare const useHMSHLSPlayerPlaybackError: (callback: (error: NonNullable<HMSHLSPlayerPlaybackError>) => void, deps: DependencyList) => void;
 export declare const useHMSHLSPlayerCue: (callback: (error: NonNullable<HMSHLSPlayerCue>) => void, deps: DependencyList) => void;
 export declare const setHMSHLSPlayerPlaybackState: (playbackState: import("../../types").HMSHLSPlayerPlaybackState) => void;
+export declare const setHMSHLSPlayerResolution: (resolution: import("../../stores/types").HMSHLSPlayerResolution) => void;
 export declare const setHMSHLSPlayerCue: (cue: import("../../stores/types").HMSHLSPlayerPlaybackCue) => void;
 export declare const setHMSHLSPlayerPlaybackError: (error: HMSHLSPlayerPlaybackError) => void;
 export declare const setHMSHLSPlayerStats: (stats: HMSHLSPlayerStatsUpdateEventData) => void;

package/lib/typescript/components/HMSHLSPlayer/index.d.ts

@@ -1,2 +1,2 @@
 export * from './HMSHLSPlayer';
-export { useHMSHLSPlayerPlaybackState, useHMSHLSPlayerCue, useHMSHLSPlayerPlaybackError, useHMSHLSPlayerStats, useHMSHLSPlayerStat, useHMSHLSPlayerStatsError, } from './hooks';
+export { useHMSHLSPlayerPlaybackState, useHMSHLSPlayerCue, useHMSHLSPlayerPlaybackError, useHMSHLSPlayerStats, useHMSHLSPlayerStat, useHMSHLSPlayerStatsError, useHMSHLSPlayerResolution, } from './hooks';

package/lib/typescript/hooks/hmsviews.d.ts

@@ -0,0 +1,3 @@
+import type { TrackId } from '../stores/types';
+export declare const useHmsViewsResolutionsState: (trackId?: TrackId) => import("../stores/types").Resolution | undefined;
+export declare const setHmsViewsResolutionsState: (trackId: string, resolution: import("../stores/types").Resolution) => void;

package/lib/typescript/index.d.ts

@@ -82,10 +82,12 @@ export * from './classes/HMSCameraControl';
 export * from './classes/HMSIOSAudioMode';
 export type { HMSSessionStore, HMSSessionStoreValue, } from './classes/HMSSessionStore';
 export type { HmsViewComponent as HMSView, HmsComponentProps as HMSViewProps, } from './classes/HmsView';
+export type { HMSPIPConfig } from './classes/HMSPIPConfig';
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 export { default as HMSManagerModule } from './classes/HMSManagerModule';
 export * from './components/HMSHLSPlayer';
 export * from './hooks/useHMSPeerUpdates';
+export { useHmsViewsResolutionsState } from './hooks/hmsviews';
 export * from './types';
 export * from './stores/types';
 export default HmsManager;

package/lib/typescript/stores/hms-store.d.ts

@@ -1,7 +1,8 @@
-export declare const useHMSStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<import("./types").HMSHLSPlayerPlaybackSlice>, "subscribe"> & {
+import type { HMSStore } from './types';
+export declare const useHMSStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<HMSStore>, "subscribe"> & {
     subscribe: {
-        (listener: (selectedState: import("./types").HMSHLSPlayerPlaybackSlice, previousSelectedState: import("./types").HMSHLSPlayerPlaybackSlice) => void): () => void;
-        <U>(selector: (state: import("./types").HMSHLSPlayerPlaybackSlice) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
+        (listener: (selectedState: HMSStore, previousSelectedState: HMSStore) => void): () => void;
+        <U>(selector: (state: HMSStore) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
             equalityFn?: ((a: U, b: U) => boolean) | undefined;
             fireImmediately?: boolean | undefined;
         } | undefined): () => void;

package/lib/typescript/stores/hmsviews-slice.d.ts

@@ -0,0 +1,5 @@
+import type { StateCreator } from 'zustand';
+import type { HMSViewsSlice, HMSStore } from './types';
+export declare const createHMSViewsSlice: StateCreator<HMSStore, [
+], [
+], HMSViewsSlice>;

package/lib/typescript/stores/types.d.ts

@@ -1,18 +1,30 @@
-import type { HMSHLSPlayerPlaybackState, HMSHLSPlayerPlaybackCueEventData, HMSHLSPlayerPlaybackFailureEventData, HMSHLSPlayerStatsErrorEventData, HMSHLSPlayerStatsUpdateEventData } from '../types';
-export type HMSStore = HMSHLSPlayerPlaybackSlice;
+import type { HMSHLSPlayerPlaybackState, HMSHLSPlayerPlaybackCueEventData, HMSHLSPlayerPlaybackFailureEventData, HMSHLSPlayerPlaybackResolutionChangeEventData, HMSHLSPlayerStatsErrorEventData, HMSHLSPlayerStatsUpdateEventData } from '../types';
+export type HMSStore = HMSHLSPlayerPlaybackSlice & HMSViewsSlice;
 export type HMSHLSPlayerStatsStore = HMSHLSPlayerStatsSlice;
+export type TrackId = string;
+export type Resolution = {
+    width: number;
+    height: number;
+};
+export interface HMSViewsSlice {
+    hmsviewsResolutions: Record<TrackId, Resolution | undefined>;
+    setHmsviewsResolutions(trackId: TrackId, resolution: Resolution): void;
+}
 export interface HMSHLSPlayerPlaybackCue extends Omit<HMSHLSPlayerPlaybackCueEventData, 'endDate' | 'startDate'> {
     endDate?: Date;
     startDate: Date;
 }
 export type HMSHLSPlayerCue = HMSHLSPlayerPlaybackCue | undefined;
 export type HMSHLSPlayerPlaybackError = HMSHLSPlayerPlaybackFailureEventData['error'] | undefined;
+export type HMSHLSPlayerResolution = HMSHLSPlayerPlaybackResolutionChangeEventData | undefined;
 export interface HMSHLSPlayerPlaybackSlice {
     cue: HMSHLSPlayerCue;
     playbackState: HMSHLSPlayerPlaybackState;
+    resolution: HMSHLSPlayerResolution;
     error: HMSHLSPlayerPlaybackError;
     setCue(cue: HMSHLSPlayerPlaybackCue): void;
     setPlaybackState(playbackState: HMSHLSPlayerPlaybackState): void;
+    setResolution(resolution: HMSHLSPlayerResolution): void;
     setPlaybackError(error: HMSHLSPlayerPlaybackError): void;
 }
 export type HMSHLSPlayerStats = HMSHLSPlayerStatsUpdateEventData;

package/lib/typescript/types.d.ts

@@ -5,7 +5,8 @@ type HMSHLSPlayerEvent<T extends string, U> = {
 export declare enum HMSHLSPlayerPlaybackEventTypes {
     ON_PLAYBACK_CUE_EVENT = "ON_PLAYBACK_CUE_EVENT",
     ON_PLAYBACK_FAILURE_EVENT = "ON_PLAYBACK_FAILURE_EVENT",
-    ON_PLAYBACK_STATE_CHANGE_EVENT = "ON_PLAYBACK_STATE_CHANGE_EVENT"
+    ON_PLAYBACK_STATE_CHANGE_EVENT = "ON_PLAYBACK_STATE_CHANGE_EVENT",
+    ON_PLAYBACK_RESOLUTION_CHANGE_EVENT = "ON_PLAYBACK_RESOLUTION_CHANGE_EVENT"
 }
 export type HMSHLSPlayerPlaybackCueEventData = {
     id?: string;
@@ -26,17 +27,20 @@ export declare enum HMSHLSPlayerPlaybackState {
     PAUSED = "paused",
     PLAYING = "playing",
     STOPPED = "stopped",
-    UNKNOWN = "unknown",
-    onVideoSizeChanged = "onVideoSizeChanged"
+    UNKNOWN = "unknown"
 }
 export type HMSHLSPlayerPlaybackStateChangeEventData = {
     state: HMSHLSPlayerPlaybackState;
-    aspectRatio: number | undefined;
+};
+export type HMSHLSPlayerPlaybackResolutionChangeEventData = {
+    width: number;
+    height: number;
 };
 type HMSHLSPlayerPlaybackCueEvent = HMSHLSPlayerEvent<HMSHLSPlayerPlaybackEventTypes.ON_PLAYBACK_CUE_EVENT, HMSHLSPlayerPlaybackCueEventData>;
 type HMSHLSPlayerPlaybackFailureEvent = HMSHLSPlayerEvent<HMSHLSPlayerPlaybackEventTypes.ON_PLAYBACK_FAILURE_EVENT, HMSHLSPlayerPlaybackFailureEventData>;
 type HMSHLSPlayerPlaybackStateChangeEvent = HMSHLSPlayerEvent<HMSHLSPlayerPlaybackEventTypes.ON_PLAYBACK_STATE_CHANGE_EVENT, HMSHLSPlayerPlaybackStateChangeEventData>;
-export type HMSHLSPlayerPlaybackEvent = HMSHLSPlayerPlaybackCueEvent | HMSHLSPlayerPlaybackFailureEvent | HMSHLSPlayerPlaybackStateChangeEvent;
+type HMSHLSPLayerPlaybackResolutionChangeEvent = HMSHLSPlayerEvent<HMSHLSPlayerPlaybackEventTypes.ON_PLAYBACK_RESOLUTION_CHANGE_EVENT, HMSHLSPlayerPlaybackResolutionChangeEventData>;
+export type HMSHLSPlayerPlaybackEvent = HMSHLSPlayerPlaybackCueEvent | HMSHLSPlayerPlaybackFailureEvent | HMSHLSPlayerPlaybackStateChangeEvent | HMSHLSPLayerPlaybackResolutionChangeEvent;
 export declare enum HMSHLSPlayerStatsEventTypes {
     ON_STATS_EVENT_ERROR = "ON_STATS_EVENT_ERROR",
     ON_STATS_EVENT_UPDATE = "ON_STATS_EVENT_UPDATE"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "1.8.0",
+  "version": "1.9.1-beta.0",
   "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",
@@ -17,6 +17,8 @@
     "sdk-versions.json",
     "!lib/typescript/example",
     "!android/build",
+    "!android/.gradle",
+    "!android/.idea",
     "!ios/build",
     "!**/__tests__",
     "!**/__fixtures__",

package/sdk-versions.json

@@ -1,6 +1,6 @@
 {
-  "ios": "0.9.12",
+  "ios": "1.1.0",
   "iOSBroadcastExtension": "0.0.9",
   "iOSHMSHLSPlayer": "0.0.2",
-  "android": "2.7.6"
+  "android": "2.7.9"
 }

package/src/classes/HMSPIPConfig.ts

@@ -0,0 +1,7 @@
+export interface HMSPIPConfig {
+  autoEnterPipMode?: boolean;
+  aspectRatio?: [number, number];
+  endButton?: boolean;
+  audioButton?: boolean;
+  videoButton?: boolean;
+};

package/src/classes/HMSPIPListenerActions.ts

@@ -1,3 +1,4 @@
 export enum HMSPIPListenerActions {
+  ON_PIP_MODE_CHANGED = 'ON_PIP_MODE_CHANGED',
   ON_PIP_ROOM_LEAVE = 'ON_PIP_ROOM_LEAVE',
 }

package/src/classes/HMSPeer.ts

@@ -13,6 +13,7 @@ export class HMSPeer {
   private _customerUserID: string | undefined;
   private _metadata: string | undefined;
   private _role: HMSRole | undefined;
+  private _isHandRaised: boolean = false;
 
   private _updateIsLocal(value: boolean) {
     // If `_isLocal` is outdated, update it
@@ -21,6 +22,13 @@ export class HMSPeer {
     }
   }
 
+  private _updateIsHandRaised(value: boolean) {
+    // If `_isHandRaised` is outdated, update it
+    if (this._isHandRaised !== value) {
+      this._isHandRaised = value;
+    }
+  }
+
   private _updateCustomerUserID(value: string) {
     // If `_customerUserID` is outdated, update it
     if (this._customerUserID !== value) {
@@ -64,6 +72,23 @@ export class HMSPeer {
     return value ?? this._isLocal;
   }
 
+  get isHandRaised(): boolean {
+    const hmsPeersCache = getHmsPeersCache();
+
+    const value = hmsPeersCache
+      ? hmsPeersCache.getProperty(this.peerID, 'isHandRaised')
+      : getPeerPropertyFromNative(
+          HMSConstants.DEFAULT_SDK_ID,
+          this.peerID,
+          'isHandRaised'
+        );
+
+    if (typeof value === 'boolean') {
+      this._updateIsHandRaised(value);
+    }
+    return value ?? this._isHandRaised;
+  }
+
   get networkQuality(): HMSNetworkQuality | undefined {
     const hmsPeersCache = getHmsPeersCache();
 

package/src/classes/HMSPeerListIterator.ts

@@ -0,0 +1,60 @@
+// import type { HMSException } from "./HMSException";
+import type { HMSPeer } from './HMSPeer';
+import HMSManagerModule from './HMSManagerModule';
+import { HMSEncoder, logger } from '@100mslive/react-native-hms';
+import { HMSConstants } from './HMSConstants';
+import { getHmsPeersCache } from './HMSPeersCache';
+
+export class HMSPeerListIterator {
+  private readonly uniqueId: string;
+  private _totalCount: number = 0;
+
+  get totalCount() {
+    return this._totalCount;
+  }
+
+  constructor(uniqueId: string, totalCount: number) {
+    this.uniqueId = uniqueId;
+    this._totalCount = totalCount;
+  }
+
+  async hasNext(): Promise<boolean> {
+    logger?.verbose('#Function HMSPeerListIterator#hasNext', this.uniqueId);
+    try {
+      return HMSManagerModule.peerListIteratorHasNext({
+        id: HMSConstants.DEFAULT_SDK_ID,
+        uniqueId: this.uniqueId,
+      });
+    } catch (e) {
+      logger?.error('#Error in #Function HMSPeerListIterator#hasNext ', e);
+      return Promise.reject(e);
+    }
+  }
+
+  async next(): Promise<HMSPeer[]> {
+    logger?.verbose('#Function HMSPeerListIterator#next', this.uniqueId);
+    try {
+      const { totalCount, peers } = await HMSManagerModule.peerListIteratorNext({
+        id: HMSConstants.DEFAULT_SDK_ID,
+        uniqueId: this.uniqueId,
+      });
+
+      this._totalCount = totalCount;
+
+      if (Array.isArray(peers) && peers.length > 0) {
+        const hmsPeersCache = getHmsPeersCache();
+
+        if (hmsPeersCache) {
+          peers.forEach(peer => {
+            hmsPeersCache.updatePeerCache(peer.peerID, peer);
+          });
+        }
+      }
+
+      return HMSEncoder.encodeHmsPeers(peers);
+    } catch (e) {
+      logger?.error('#Error in #Function HMSPeerListIterator#next ', e);
+      return Promise.reject(e);
+    }
+  }
+}

package/src/classes/HMSPeerListIteratorOptions.ts

@@ -0,0 +1,26 @@
+/**
+ * options for creating `HMSPeerListIterator` instance
+ *
+ * ```
+ * const peerListIterator =  hmsInstance.getPeerListIterator({
+ *   limit: 10,
+ *   byRoleName: 'viewer-realtime',
+ * });
+ * ```
+ */
+export interface HMSPeerListIteratorOptions {
+  /**
+   * filter by role of the peers
+   */
+  byRoleName?: string;
+
+  /**
+   * `peerID`s of the peers you want to fetch with iterator.
+   */
+  byPeerIds?: string[];
+
+  /**
+   * number of peers fetched by the iterator in `next` method call. Default value is `10`
+   */
+  limit?: number;
+}

package/src/classes/HMSPeerUpdate.ts

@@ -5,6 +5,7 @@ export enum HMSPeerUpdate {
   ROLE_CHANGED = 'ROLE_CHANGED',
   NAME_CHANGED = 'NAME_CHANGED',
   NETWORK_QUALITY_UPDATED = 'NETWORK_QUALITY_UPDATED',
+  HAND_RAISED_CHANGED = 'HAND_RAISED_CHANGED',
 }
 
 export const HMSPeerUpdateOrdinals = new Map([
@@ -14,4 +15,5 @@ export const HMSPeerUpdateOrdinals = new Map([
   ['5', HMSPeerUpdate.NAME_CHANGED],
   ['6', HMSPeerUpdate.METADATA_CHANGED],
   ['7', HMSPeerUpdate.NETWORK_QUALITY_UPDATED],
+  ['8', HMSPeerUpdate.HAND_RAISED_CHANGED],
 ]);

package/src/classes/HMSPeersCache.ts

@@ -39,6 +39,7 @@ export type HMSPeerCacheProps = {
   audioTrack?: HMSAudioTrack | undefined;
   videoTrack?: HMSVideoTrack | undefined;
   auxiliaryTracks?: HMSTrack[] | undefined;
+  isHandRaised?: boolean | undefined;
 };
 
 export class HMSPeersCache {
@@ -206,6 +207,10 @@ export class HMSPeersCache {
         updatedObj.name = data.name;
         break;
       }
+      case HMSPeerUpdate.HAND_RAISED_CHANGED: {
+        updatedObj.isHandRaised = data.isHandRaised;
+        break;
+      }
       default: {
         updatedObj = { ...updatedObj, ...data };
         break;
@@ -256,6 +261,8 @@ export function getPeerPropertyFromNative<T extends keyof HMSPeerCacheProps>(
         : undefined;
   } else if (property === 'name') {
     value = data?.[property];
+  } else if (property === 'isHandRaised') {
+    value = data ? data[property] : false;
   } else {
     value = data ? data[property] : undefined;
   }