@100mslive/react-native-hms 1.9.12 → 1.10.1

package/lib/typescript/classes/polls/DecodedPollLeaderboardResponse.d.ts

@@ -0,0 +1,37 @@
+import type { HMSPollLeaderboardEntry } from './HMSPollLeaderboardEntry';
+import type { HMSPollLeaderboardSummary } from './HMSPollLeaderboardSummary';
+import type { PollLeaderboardResponse } from './PollLeaderboardResponse';
+type NumberString = string;
+export interface DecodedPollLeaderboardResponse extends Pick<PollLeaderboardResponse, 'hasNext'> {
+    entries?: DecodedHMSPollLeaderboardEntry[];
+    summary?: DecodedHMSPollLeaderboardSummary;
+}
+export interface DecodedHMSPollLeaderboardEntry extends Pick<HMSPollLeaderboardEntry, 'peer'> {
+    /**
+     * convert this value to number
+     */
+    duration?: NumberString | number;
+    /**
+     * convert this value to number
+     */
+    totalResponses?: NumberString | number;
+    /**
+     * convert this value to number
+     */
+    correctResponses?: NumberString | number;
+    /**
+     * convert this value to number
+     */
+    position?: NumberString | number;
+    /**
+     * convert this value to number
+     */
+    score?: NumberString | number;
+}
+export interface DecodedHMSPollLeaderboardSummary extends Omit<HMSPollLeaderboardSummary, 'averageTime'> {
+    /**
+     * convert this value to number
+     */
+    averageTime?: NumberString | number;
+}
+export {};

package/lib/typescript/classes/polls/HMSPoll.d.ts

@@ -5,13 +5,6 @@ import type { HMSRole } from '../HMSRole';
 import type { HMSPollUserTrackingMode } from './HMSPollUserTrackingMode';
 import type { HMSPollType } from './HMSPollType';
 import type { HMSPeer } from '../HMSPeer';
-type HMSPeerSubset = {
-    peerID: HMSPeer['peerID'];
-    name: HMSPeer['name'];
-};
-type HMSRoleSubset = {
-    name: HMSRole['name'];
-};
 export interface HMSPoll {
     /**
      The unique identifier of the poll.
@@ -36,23 +29,23 @@ export interface HMSPoll {
     /**
      The roles that can vote in the poll.
      */
-    rolesThatCanVote?: HMSRoleSubset[];
+    rolesThatCanVote?: HMSRole[];
     /**
      The roles that can view the poll responses.
      */
-    rolesThatCanViewResponses?: HMSRoleSubset[];
+    rolesThatCanViewResponses?: HMSRole[];
     /**
      The peer who started the poll.
      */
-    startedBy?: HMSPeerSubset;
+    startedBy?: HMSPeer;
     /**
      The peer who stopped the poll.
      */
-    stoppedBy?: HMSPeerSubset;
+    stoppedBy?: HMSPeer;
     /**
      The peer who created the poll.
      */
-    createdBy?: HMSPeerSubset;
+    createdBy?: HMSPeer;
     /**
      The date and time when the poll was started.
      */
@@ -78,4 +71,3 @@ export interface HMSPoll {
      */
     result?: HMSPollResult;
 }
-export {};

package/lib/typescript/classes/polls/HMSPollCreateParams.d.ts

@@ -1,9 +1,6 @@
-import type { HMSRole } from '../HMSRole';
 import type { HMSPoll } from './HMSPoll';
 import type { HMSPollQuestionCreateParams } from './HMSPollQuestionCreateParams';
-export interface HMSPollCreateParams extends Pick<HMSPoll, 'title' | 'type' | 'duration' | 'anonymous' | 'mode'> {
+export interface HMSPollCreateParams extends Pick<HMSPoll, 'title' | 'type' | 'duration' | 'anonymous' | 'mode' | 'rolesThatCanVote' | 'rolesThatCanViewResponses'> {
     pollId?: HMSPoll['pollId'];
     questions?: HMSPollQuestionCreateParams[];
-    rolesThatCanVote?: HMSRole[];
-    rolesThatCanViewResponses?: HMSRole[];
 }

package/lib/typescript/classes/polls/HMSPollLeaderboardEntry.d.ts

@@ -0,0 +1,9 @@
+import type { HMSPollResponsePeerInfo } from './HMSPollResponsePeerInfo';
+export interface HMSPollLeaderboardEntry {
+    duration?: number;
+    totalResponses?: number;
+    correctResponses?: number;
+    position?: number;
+    score?: number;
+    peer?: HMSPollResponsePeerInfo;
+}

package/lib/typescript/classes/polls/HMSPollLeaderboardSummary.d.ts

@@ -0,0 +1,7 @@
+export interface HMSPollLeaderboardSummary {
+    averageScore?: number;
+    averageTime?: number;
+    respondedCorrectlyPeersCount?: number;
+    respondedPeersCount?: number;
+    totalPeersCount?: number;
+}

package/lib/typescript/classes/polls/PollLeaderboardResponse.d.ts

@@ -0,0 +1,7 @@
+import type { HMSPollLeaderboardEntry } from './HMSPollLeaderboardEntry';
+import type { HMSPollLeaderboardSummary } from './HMSPollLeaderboardSummary';
+export interface PollLeaderboardResponse {
+    entries?: HMSPollLeaderboardEntry[];
+    hasNext?: boolean;
+    summary?: HMSPollLeaderboardSummary;
+}

package/lib/typescript/index.d.ts

@@ -96,6 +96,9 @@ export { HMSPollQuestion } from './classes/polls/HMSPollQuestion';
 export { HMSPollQuestionOption } from './classes/polls/HMSPollQuestionOption';
 export { HMSPollQuestionAnswer } from './classes/polls/HMSPollQuestionAnswer';
 export { HMSPollQuestionResponse } from './classes/polls/HMSPollQuestionResponse';
+export { PollLeaderboardResponse } from './classes/polls/PollLeaderboardResponse';
+export { HMSPollLeaderboardEntry } from './classes/polls/HMSPollLeaderboardEntry';
+export { HMSPollLeaderboardSummary } from './classes/polls/HMSPollLeaderboardSummary';
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 export { default as HMSManagerModule } from './modules/HMSManagerModule';
 export * from './components/HMSHLSPlayer';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "1.9.12",
+  "version": "1.10.1",
   "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,6 +1,6 @@
 {
-  "ios": "1.5.1",
+  "ios": "1.6.0",
   "iOSBroadcastExtension": "0.0.9",
   "iOSHMSHLSPlayer": "0.0.2",
-  "android": "2.9.3"
+  "android": "2.9.51"
 }

package/src/classes/HMSHLSTimedMetadata.ts

@@ -0,0 +1,4 @@
+export interface HMSHLSTimedMetadata {
+  payload: string;
+  duration: number;
+}

package/src/classes/HMSInteractivityCenter.ts

@@ -10,6 +10,8 @@ import HMSNativeEventListener from './HMSNativeEventListener';
 import type { HMSEventSubscription } from './HMSNativeEventEmitter';
 import { HMSInteractivityEncoder } from './HMSInteractivityEncoder';
 import { HMSHelper } from './HMSHelper';
+import type { PollLeaderboardResponse } from './polls/PollLeaderboardResponse';
+import type { DecodedPollLeaderboardResponse } from './polls/DecodedPollLeaderboardResponse';
 
 type PollUpdateListener = (data: {
   updatedPoll: HMSPoll;
@@ -134,4 +136,32 @@ export class HMSInteractivityCenter {
     logger?.verbose('#Function stop', JSON.stringify(data));
     return HMSManager.stopPoll(data);
   }
+
+  /**
+   * Fetches the leaderboard for a poll
+   * @param pollId - The id of the poll
+   * @param count - The number of entries to fetch
+   * @param startIndex - The index to start fetching from
+   * @param includeCurrentPeer - Whether to include the current peer in the fetched leaderboard entries
+   * @returns Promise<PollLeaderboardResponse>
+   */
+  async fetchLeaderboard(
+    pollId: string,
+    count: number,
+    startIndex: number,
+    includeCurrentPeer: boolean
+  ): Promise<PollLeaderboardResponse> {
+    const data = {
+      id: HMSConstants.DEFAULT_SDK_ID,
+      pollId,
+      count,
+      startIndex,
+      includeCurrentPeer,
+    };
+    logger?.verbose('#Function fetchLeaderboard', data);
+
+    const response: DecodedPollLeaderboardResponse =
+      await HMSManager.fetchLeaderboard(data);
+    return HMSInteractivityEncoder.transformPollLeaderboardResponse(response);
+  }
 }

package/src/classes/HMSInteractivityEncoder.ts

@@ -1,4 +1,7 @@
+import { HMSEncoder } from './HMSEncoder';
+import type { DecodedPollLeaderboardResponse } from './polls/DecodedPollLeaderboardResponse';
 import type { HMSPoll } from './polls/HMSPoll';
+import type { PollLeaderboardResponse } from './polls/PollLeaderboardResponse';
 
 export class HMSInteractivityEncoder {
   static transformPoll(poll: HMSPoll): HMSPoll {
@@ -20,10 +23,62 @@ export class HMSInteractivityEncoder {
         poll.stoppedAt = new Date(dateNum);
       }
     }
-    // poll.rolesThatCanVote: HMSRole[];
-    // poll.rolesThatCanViewResponses: HMSRole[];
+    if (poll.createdBy) {
+      poll.createdBy = HMSEncoder.encodeHmsPeer(poll.createdBy);
+    }
+    if (poll.startedBy) {
+      poll.startedBy = HMSEncoder.encodeHmsPeer(poll.startedBy);
+    }
+    if (poll.stoppedBy) {
+      poll.stoppedBy = HMSEncoder.encodeHmsPeer(poll.stoppedBy);
+    }
+    if (poll.rolesThatCanVote) {
+      poll.rolesThatCanVote = poll.rolesThatCanVote.map((role) =>
+        HMSEncoder.encodeHmsRole(role)
+      );
+    }
+    if (poll.rolesThatCanViewResponses) {
+      poll.rolesThatCanViewResponses = poll.rolesThatCanViewResponses.map(
+        (role) => HMSEncoder.encodeHmsRole(role)
+      );
+    }
+
     // --- poll.questions: HMSPollQuestion[]
     // --- poll.result: HMSPollResult
     return poll;
   }
+
+  static transformPollLeaderboardResponse(
+    decodedPollLeaderboardResponse: DecodedPollLeaderboardResponse
+  ): PollLeaderboardResponse {
+    const summary = decodedPollLeaderboardResponse.summary;
+    if (summary) {
+      if (typeof summary.averageTime === 'string') {
+        summary.averageTime = parseInt(summary.averageTime);
+      }
+    }
+
+    const entries = decodedPollLeaderboardResponse.entries;
+    if (entries) {
+      entries.forEach((entry) => {
+        if (typeof entry.duration === 'string') {
+          entry.duration = parseInt(entry.duration);
+        }
+        if (typeof entry.totalResponses === 'string') {
+          entry.totalResponses = parseInt(entry.totalResponses);
+        }
+        if (typeof entry.correctResponses === 'string') {
+          entry.correctResponses = parseInt(entry.correctResponses);
+        }
+        if (typeof entry.position === 'string') {
+          entry.position = parseInt(entry.position);
+        }
+        if (typeof entry.score === 'string') {
+          entry.score = parseInt(entry.score);
+        }
+      });
+    }
+
+    return decodedPollLeaderboardResponse as PollLeaderboardResponse;
+  }
 }

package/src/classes/HMSSDK.tsx

@@ -47,6 +47,7 @@ import type { HMSPeerListIteratorOptions } from './HMSPeerListIteratorOptions';
 import { HMSPeerListIterator } from './HMSPeerListIterator';
 import type { HMSPIPConfig } from './HMSPIPConfig';
 import { HMSInteractivityCenter } from './HMSInteractivityCenter';
+import type { HMSHLSTimedMetadata } from './HMSHLSTimedMetadata';
 
 type HmsViewProps = Omit<HmsComponentProps, 'id'>;
 
@@ -430,6 +431,19 @@ export class HMSSDK {
     return await HMSManager.stopHLSStreaming({ id: this.id });
   };
 
+  /**
+   * send timed metadata for HLS player
+   * @param metadata list of {@link HMSHLSTimedMetadata} to be sent
+   * @returns Promise<boolean>
+   */
+  sendHLSTimedMetadata = async (
+    metadata: HMSHLSTimedMetadata[]
+  ): Promise<boolean> => {
+    const data = { metadata, id: this.id };
+    logger?.verbose('#Function sendHLSTimedMetadata', data);
+    return await HMSManager.sendHLSTimedMetadata(data);
+  };
+
   /**
    * @deprecated This function has been deprecated in favor of #Function changeRoleOfPeer
    *
@@ -991,8 +1005,7 @@ export class HMSSDK {
   };
 
   /**
-   * Android Only
-   * - This wrapper function used to switch output to device other than the default, currently available only for android.
+   * - This wrapper function used to switch output to device other than the default route.
    *
    * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#switch-audio-focus-to-another-device} for more info
    *
@@ -1004,12 +1017,8 @@ export class HMSSDK {
       id: this.id,
       audioDevice,
     });
-    if (Platform.OS === 'android') {
-      return HMSManager.switchAudioOutput({ id: this.id, audioDevice });
-    } else {
-      console.log('API currently not available for iOS');
-      return 'API currently not available for iOS';
-    }
+
+    return HMSManager.switchAudioOutput({ id: this.id, audioDevice });
   };
 
   switchAudioOutputUsingIOSUI = () => {
@@ -1200,6 +1209,19 @@ export class HMSSDK {
     return new HMSPeerListIterator(data.uniqueId, data.totalCount);
   };
 
+  /**
+   * - This function allows the user to set the screen on always.
+   * - This is useful when the user wants to keep the screen on while the app is in the foreground.
+   * @param enabled boolean value to enable or disable the always screen on
+   */
+  setAlwaysScreenOn = async (enabled: boolean) => {
+    logger?.verbose('#Function toggleAlwaysScreenOn', {
+      id: this.id,
+      enabled,
+    });
+    return HMSManager.setAlwaysScreenOn({ id: this.id, enabled });
+  };
+
   /**
    * - This is a prototype event listener that takes action and listens for updates related to that particular action
    *

package/src/classes/polls/DecodedPollLeaderboardResponse.ts

@@ -0,0 +1,43 @@
+import type { HMSPollLeaderboardEntry } from './HMSPollLeaderboardEntry';
+import type { HMSPollLeaderboardSummary } from './HMSPollLeaderboardSummary';
+import type { PollLeaderboardResponse } from './PollLeaderboardResponse';
+
+type NumberString = string;
+
+export interface DecodedPollLeaderboardResponse
+  extends Pick<PollLeaderboardResponse, 'hasNext'> {
+  entries?: DecodedHMSPollLeaderboardEntry[];
+  summary?: DecodedHMSPollLeaderboardSummary;
+}
+
+export interface DecodedHMSPollLeaderboardEntry
+  extends Pick<HMSPollLeaderboardEntry, 'peer'> {
+  /**
+   * convert this value to number
+   */
+  duration?: NumberString | number;
+  /**
+   * convert this value to number
+   */
+  totalResponses?: NumberString | number;
+  /**
+   * convert this value to number
+   */
+  correctResponses?: NumberString | number;
+  /**
+   * convert this value to number
+   */
+  position?: NumberString | number;
+  /**
+   * convert this value to number
+   */
+  score?: NumberString | number;
+}
+
+export interface DecodedHMSPollLeaderboardSummary
+  extends Omit<HMSPollLeaderboardSummary, 'averageTime'> {
+  /**
+   * convert this value to number
+   */
+  averageTime?: NumberString | number;
+}

package/src/classes/polls/HMSPoll.ts

@@ -6,15 +6,6 @@ import type { HMSPollUserTrackingMode } from './HMSPollUserTrackingMode';
 import type { HMSPollType } from './HMSPollType';
 import type { HMSPeer } from '../HMSPeer';
 
-type HMSPeerSubset = {
-  peerID: HMSPeer['peerID'];
-  name: HMSPeer['name'];
-};
-
-type HMSRoleSubset = {
-  name: HMSRole['name'];
-};
-
 export interface HMSPoll {
   /**
    The unique identifier of the poll.
@@ -44,27 +35,27 @@ export interface HMSPoll {
   /**
    The roles that can vote in the poll.
    */
-  rolesThatCanVote?: HMSRoleSubset[];
+  rolesThatCanVote?: HMSRole[];
 
   /**
    The roles that can view the poll responses.
    */
-  rolesThatCanViewResponses?: HMSRoleSubset[];
+  rolesThatCanViewResponses?: HMSRole[];
 
   /**
    The peer who started the poll.
    */
-  startedBy?: HMSPeerSubset;
+  startedBy?: HMSPeer;
 
   /**
    The peer who stopped the poll.
    */
-  stoppedBy?: HMSPeerSubset;
+  stoppedBy?: HMSPeer;
 
   /**
    The peer who created the poll.
    */
-  createdBy?: HMSPeerSubset;
+  createdBy?: HMSPeer;
 
   /**
    The date and time when the poll was started.

package/src/classes/polls/HMSPollCreateParams.ts

@@ -1,4 +1,3 @@
-import type { HMSRole } from '../HMSRole';
 import type { HMSPoll } from './HMSPoll';
 import type { HMSPollQuestionCreateParams } from './HMSPollQuestionCreateParams';
 
@@ -12,9 +11,9 @@ export interface HMSPollCreateParams
     // | 'visibility'
     // | 'locked'
     | 'mode'
+    | 'rolesThatCanVote'
+    | 'rolesThatCanViewResponses'
   > {
   pollId?: HMSPoll['pollId'];
   questions?: HMSPollQuestionCreateParams[];
-  rolesThatCanVote?: HMSRole[];
-  rolesThatCanViewResponses?: HMSRole[];
 }

package/src/classes/polls/HMSPollLeaderboardEntry.ts

@@ -0,0 +1,10 @@
+import type { HMSPollResponsePeerInfo } from './HMSPollResponsePeerInfo';
+
+export interface HMSPollLeaderboardEntry {
+  duration?: number;
+  totalResponses?: number;
+  correctResponses?: number;
+  position?: number;
+  score?: number;
+  peer?: HMSPollResponsePeerInfo;
+}

package/src/classes/polls/HMSPollLeaderboardSummary.ts

@@ -0,0 +1,7 @@
+export interface HMSPollLeaderboardSummary {
+  averageScore?: number;
+  averageTime?: number;
+  respondedCorrectlyPeersCount?: number;
+  respondedPeersCount?: number;
+  totalPeersCount?: number;
+}

package/src/classes/polls/PollLeaderboardResponse.ts

@@ -0,0 +1,8 @@
+import type { HMSPollLeaderboardEntry } from './HMSPollLeaderboardEntry';
+import type { HMSPollLeaderboardSummary } from './HMSPollLeaderboardSummary';
+
+export interface PollLeaderboardResponse {
+  entries?: HMSPollLeaderboardEntry[];
+  hasNext?: boolean;
+  summary?: HMSPollLeaderboardSummary;
+}

package/src/components/HMSHLSPlayer/HMSHLSPlayer.tsx

@@ -1,4 +1,4 @@
-import React, { useImperativeHandle, useRef, useState } from 'react';
+import React, { useImperativeHandle, useRef } from 'react';
 import { View, StyleSheet, UIManager, findNodeHandle } from 'react-native';
 import type { StyleProp, ViewStyle } from 'react-native';
 
@@ -56,8 +56,6 @@ const _HMSHLSPlayer: React.ForwardRefRenderFunction<
 ) => {
   const hmsHlsPlayerRef = useRef<RCTHMSHLSPlayerRef | null>(null);
 
-  const [aspectRatio, setAspectRatio] = useState(16 / 9);
-
   useImperativeHandle(
     ref,
     () => ({
@@ -204,12 +202,6 @@ const _HMSHLSPlayer: React.ForwardRefRenderFunction<
       HMSHLSPlayerPlaybackEventTypes.ON_PLAYBACK_RESOLUTION_CHANGE_EVENT
     ) {
       setHMSHLSPlayerResolution({ ...data });
-
-      const aspectRatio = data.width / data.height;
-
-      if (typeof aspectRatio === 'number' && !isNaN(aspectRatio)) {
-        setAspectRatio(aspectRatio);
-      }
     } else {
       setHMSHLSPlayerPlaybackState(data.state);
     }
@@ -232,10 +224,7 @@ const _HMSHLSPlayer: React.ForwardRefRenderFunction<
         <RCTHMSHLSPlayer
           ref={hmsHlsPlayerRef}
           url={url}
-          style={[
-            styles.player,
-            { aspectRatio: aspectRatio, flex: aspectRatio < 1 ? 1 : undefined },
-          ]}
+          style={styles.player}
           enableStats={enableStats}
           enableControls={enableControls}
           onHmsHlsPlaybackEvent={handleHLSPlaybackEvent}
@@ -264,7 +253,7 @@ const styles = StyleSheet.create({
   },
   player: {
     width: '100%',
-    aspectRatio: 16 / 9,
+    height: '100%',
     flex: 1,
   },
 });

package/src/index.ts

@@ -106,6 +106,9 @@ export { HMSPollQuestion } from './classes/polls/HMSPollQuestion';
 export { HMSPollQuestionOption } from './classes/polls/HMSPollQuestionOption';
 export { HMSPollQuestionAnswer } from './classes/polls/HMSPollQuestionAnswer';
 export { HMSPollQuestionResponse } from './classes/polls/HMSPollQuestionResponse';
+export { PollLeaderboardResponse } from './classes/polls/PollLeaderboardResponse';
+export { HMSPollLeaderboardEntry } from './classes/polls/HMSPollLeaderboardEntry';
+export { HMSPollLeaderboardSummary } from './classes/polls/HMSPollLeaderboardSummary';
 
 import { HMSSDK as HmsManager } from './classes/HMSSDK';