@100mslive/hms-video-store 0.3.4 → 0.4.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.4",
+  "version": "0.4.0",
   "license": "MIT",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
@@ -41,7 +41,7 @@
   "author": "100ms",
   "sideEffects": false,
   "dependencies": {
-    "@100mslive/hms-video": "0.2.4",
+    "@100mslive/hms-video": "0.3.0",
     "eventemitter2": "^6.4.5",
     "immer": "^9.0.6",
     "reselect": "4.0.0",
@@ -66,5 +66,5 @@
     "url": "https://github.com/100mslive/hms-video-store/issues"
   },
   "homepage": "https://github.com/100mslive/hms-video-store#readme",
-  "gitHead": "a209b16cf484791322b36f5499339e91f960d26b"
+  "gitHead": "8400a49ebabd0846321deefd63d103f20d2962bd"
 }

package/src/core/IHMSActions.ts

@@ -7,6 +7,7 @@ import {
   HMSVideoPlugin,
   HMSAudioPlugin,
   HMSPluginSupportResult,
+  HLSTimedMetadata,
 } from '@100mslive/hms-video';
 import {
   HMSMessageID,
@@ -315,6 +316,25 @@ export interface IHMSActions {
    */
   stopHLSStreaming(params?: HLSConfig): Promise<void>;
 
+  /**
+   * @alpha
+   * Used to define date range metadata in a media playlist.
+   * This api adds EXT-X-DATERANGE tags to the media playlist.
+   * It is useful for defining timed metadata for interstitial regions such as advertisements,
+   * but can be used to define any timed metadata needed by your stream.
+   * usage (e.g)
+   * const metadataList = [{
+   *  payload: "some string 1",
+   *  duration: 2
+   * },
+   * {
+   *  payload: "some string 2",
+   *  duration: 3
+   * }]
+   * sendHLSTimedMetadata(metadataList);
+   */
+  sendHLSTimedMetadata(metadataList: HLSTimedMetadata[]): Promise<void>;
+
   /**
    * If you want to update the name of peer.
    */

package/src/core/hmsSDKStore/HMSSDKActions.ts

@@ -66,7 +66,7 @@ import { HMSNotifications } from './HMSNotifications';
 import { NamedSetState } from './internalTypes';
 import { isRemoteTrack } from './sdkUtils/sdkUtils';
 import { HMSPlaylist } from './HMSPlaylist';
-import { ACTION_TYPES } from './common/mapping';
+import { PEER_NOTIFICATION_TYPES, TRACK_NOTIFICATION_TYPES } from './common/mapping';
 
 // import { ActionBatcher } from './sdkUtils/ActionBatcher';
 
@@ -376,10 +376,13 @@ export class HMSSDKActions implements IHMSActions {
 
   async detachVideo(trackID: string, videoElement: HTMLVideoElement) {
     const sdkTrack = this.hmsSDKTracks[trackID];
-    if (sdkTrack && sdkTrack.type === 'video') {
-      await (sdkTrack as SDKHMSVideoTrack).removeSink(videoElement);
+    if (sdkTrack?.type === 'video') {
+      (sdkTrack as SDKHMSVideoTrack).removeSink(videoElement);
       this.updateVideoLayer(trackID, 'detachVideo');
     } else {
+      if (videoElement) {
+        videoElement.srcObject = null; // so chrome can clean up
+      }
       this.logPossibleInconsistency('no video track found to remove sink');
     }
   }
@@ -550,6 +553,9 @@ export class HMSSDKActions implements IHMSActions {
     await this.sdk.stopHLSStreaming(params);
   }
 
+  async sendHLSTimedMetadata(metadataList: sdkTypes.HLSTimedMetadata[]): Promise<void> {
+    await this.sdk.sendHLSTimedMetadata(metadataList);
+  }
   async changeName(name: string) {
     await this.sdk.changeName(name);
   }
@@ -605,12 +611,12 @@ export class HMSSDKActions implements IHMSActions {
   }
 
   private resetState(reason = 'resetState') {
-    this.setState(store => {
-      Object.assign(store, createDefaultStoreState());
-    }, reason);
     this.isRoomJoinCalled = false;
     this.hmsSDKTracks = {};
     HMSLogger.cleanUp();
+    this.setState(store => {
+      Object.assign(store, createDefaultStoreState());
+    }, reason);
   }
 
   private sdkJoinWithListeners(config: sdkTypes.HMSConfig) {
@@ -670,8 +676,6 @@ export class HMSSDKActions implements IHMSActions {
         Object.assign(store.settings, this.getMediaSettings(this.hmsSDKPeers[localPeer?.id]));
       }
     }, 'deviceChange');
-    // sync is needed to update the current selected device
-    // this.syncRoomState('deviceChangeSync');
     // send notification only on device change - selection is present
     if (event.selection) {
       const notification = SDKToHMS.convertDeviceChangeUpdate(event);
@@ -731,7 +735,7 @@ export class HMSSDKActions implements IHMSActions {
   private async attachVideoInternal(trackID: string, videoElement: HTMLVideoElement) {
     const sdkTrack = this.hmsSDKTracks[trackID];
     if (sdkTrack && sdkTrack.type === 'video') {
-      await (sdkTrack as SDKHMSVideoTrack).addSink(videoElement);
+      (sdkTrack as SDKHMSVideoTrack).addSink(videoElement);
       this.updateVideoLayer(trackID, 'attachVideo');
     } else {
       this.logPossibleInconsistency('no video track found to add sink');
@@ -750,7 +754,8 @@ export class HMSSDKActions implements IHMSActions {
    * interested in with a new reference.
    * @protected
    */
-  protected syncRoomState(action?: string) {
+  protected syncRoomState(action: string) {
+    action = `${action}_fullSync`;
     HMSLogger.time(`store-sync-${action}`);
     const newHmsPeers: Record<HMSPeerID, Partial<HMSPeer>> = {};
     const newHmsPeerIDs: HMSPeerID[] = []; // to add in room.peers
@@ -846,11 +851,10 @@ export class HMSSDKActions implements IHMSActions {
     });
   }
 
-  //@ts-ignore
   protected onRoomUpdate(type: sdkTypes.HMSRoomUpdate, room: sdkTypes.HMSRoom) {
     this.setState(store => {
       Object.assign(store.room, SDKToHMS.convertRoom(room));
-    }, 'RoomUpdate');
+    }, type);
   }
 
   protected onPeerUpdate(type: sdkTypes.HMSPeerUpdate, sdkPeer: sdkTypes.HMSPeer | sdkTypes.HMSPeer[]) {
@@ -881,7 +885,7 @@ export class HMSSDKActions implements IHMSActions {
       this.hmsNotifications.sendTrackUpdate(type, track.trackId);
       this.handleTrackRemove(track, peer);
     } else {
-      const actionName = type === sdkTypes.HMSTrackUpdate.TRACK_ADDED ? 'trackAdded' : 'trackUpdate';
+      const actionName = TRACK_NOTIFICATION_TYPES[type] || 'trackUpdate';
       this.syncRoomState(actionName);
       this.hmsNotifications.sendTrackUpdate(type, track.trackId);
     }
@@ -1061,10 +1065,15 @@ export class HMSSDKActions implements IHMSActions {
   private updateVideoLayer(trackID: string, action: string) {
     const sdkTrack = this.hmsSDKTracks[trackID];
     if (sdkTrack && sdkTrack instanceof SDKHMSRemoteVideoTrack) {
-      this.setState(draft => {
-        draft.tracks[trackID].layer = sdkTrack.getSimulcastLayer();
-        draft.tracks[trackID].degraded = sdkTrack.degraded;
-      }, action);
+      const storeTrack = this.store.getState(selectTrackByID(trackID));
+      const hasFieldChanged =
+        storeTrack?.layer !== sdkTrack.getSimulcastLayer() || storeTrack?.degraded !== sdkTrack.degraded;
+      if (hasFieldChanged) {
+        this.setState(draft => {
+          draft.tracks[trackID].layer = sdkTrack.getSimulcastLayer();
+          draft.tracks[trackID].degraded = sdkTrack.degraded;
+        }, action);
+      }
     }
   }
 
@@ -1263,7 +1272,7 @@ export class HMSSDKActions implements IHMSActions {
 
   private sendPeerUpdateNotification = (type: sdkTypes.HMSPeerUpdate, sdkPeer: sdkTypes.HMSPeer) => {
     let peer = this.store.getState(selectPeerByID(sdkPeer.peerId));
-    const actionName = ACTION_TYPES[type];
+    const actionName = PEER_NOTIFICATION_TYPES[type] || 'peerUpdate';
     this.syncRoomState(actionName);
     // if peer wasn't available before sync(will happen if event is peer join)
     if (!peer) {

package/src/core/hmsSDKStore/common/mapping.ts

@@ -1,33 +1,23 @@
 import * as sdkTypes from '../sdkTypes';
 import { HMSNotificationTypes } from '../../schema';
 
-interface notifcationMap {
-  [key: number]: string;
-}
+type PeerNotificationMap = { [key in sdkTypes.HMSPeerUpdate]?: HMSNotificationTypes };
 
-export const PEER_NOTIFICATION_TYPES: notifcationMap = {
+export const PEER_NOTIFICATION_TYPES: PeerNotificationMap = {
   [sdkTypes.HMSPeerUpdate.PEER_JOINED]: HMSNotificationTypes.PEER_JOINED,
   [sdkTypes.HMSPeerUpdate.PEER_LEFT]: HMSNotificationTypes.PEER_LEFT,
   [sdkTypes.HMSPeerUpdate.ROLE_UPDATED]: HMSNotificationTypes.ROLE_UPDATED,
-  [sdkTypes.HMSPeerUpdate.AUDIO_TOGGLED]: 'PEER_AUDIO_UPDATED',
-  [sdkTypes.HMSPeerUpdate.VIDEO_TOGGLED]: 'PEER_VIDEO_UPDATED',
   [sdkTypes.HMSPeerUpdate.NAME_UPDATED]: HMSNotificationTypes.NAME_UPDATED,
   [sdkTypes.HMSPeerUpdate.METADATA_UPDATED]: HMSNotificationTypes.METADATA_UPDATED,
 };
 
-export const TRACK_NOTIFICATION_TYPES: notifcationMap = {
+type TrackNotificationMap = { [key in sdkTypes.HMSTrackUpdate]: HMSNotificationTypes };
+export const TRACK_NOTIFICATION_TYPES: TrackNotificationMap = {
   [sdkTypes.HMSTrackUpdate.TRACK_ADDED]: HMSNotificationTypes.TRACK_ADDED,
   [sdkTypes.HMSTrackUpdate.TRACK_REMOVED]: HMSNotificationTypes.TRACK_REMOVED,
   [sdkTypes.HMSTrackUpdate.TRACK_MUTED]: HMSNotificationTypes.TRACK_MUTED,
   [sdkTypes.HMSTrackUpdate.TRACK_UNMUTED]: HMSNotificationTypes.TRACK_UNMUTED,
   [sdkTypes.HMSTrackUpdate.TRACK_DEGRADED]: HMSNotificationTypes.TRACK_DEGRADED,
   [sdkTypes.HMSTrackUpdate.TRACK_RESTORED]: HMSNotificationTypes.TRACK_RESTORED,
-};
-
-export const ACTION_TYPES: notifcationMap = {
-  [sdkTypes.HMSPeerUpdate.PEER_JOINED]: 'peerJoined',
-  [sdkTypes.HMSPeerUpdate.PEER_LEFT]: 'peerLeft',
-  [sdkTypes.HMSPeerUpdate.NAME_UPDATED]: 'peerNameUpdated',
-  [sdkTypes.HMSPeerUpdate.ROLE_UPDATED]: 'peerRoleUpdated',
-  [sdkTypes.HMSPeerUpdate.METADATA_UPDATED]: 'peerMetadataUpdated',
+  [sdkTypes.HMSTrackUpdate.TRACK_DESCRIPTION_CHANGED]: HMSNotificationTypes.TRACK_DESCRIPTION_CHANGED,
 };

package/src/core/hmsSDKStore/sdkTypes.ts

@@ -34,6 +34,7 @@ import {
   HMSAudioPlugin,
   HLSConfig,
   HMSHLS,
+  HLSTimedMetadata,
   HMSPeerStats,
   HMSTrackStats,
   HMSLocalTrackStats,
@@ -82,6 +83,7 @@ export type {
   HMSVideoPlugin,
   HMSAudioPlugin,
   HLSConfig,
+  HLSTimedMetadata,
   HLSMeetingURLVariant,
   HMSHLS,
   HMSPeerStats,

package/src/core/index.ts

@@ -25,12 +25,7 @@ export type {
   HMSConfigInitialSettings,
   HMSAudioTrackSettings,
   HMSVideoTrackSettings,
-  HMSSimulcastLayer,
-  SimulcastLayerDefinition,
-  DeviceMap,
   RTMPRecordingConfig,
-  HMSRecording,
-  HMSRTMP,
   HMSPeerStats,
   HMSTrackStats,
   HMSLocalTrackStats,

package/src/core/schema/device-change.ts

@@ -1,6 +1,8 @@
 import { DeviceMap } from '../hmsSDKStore/sdkTypes';
 import { HMSException } from './error';
 
+export type { DeviceMap };
+
 /**
  * Test fails when adding InputDeviceInfo[error TS2304: Cannot find name 'InputDeviceInfo'.]
  * InputDeviceInfo extends MediaDeviceInfo. See https://w3c.github.io/mediacapture-main/#input-specific-device-info

package/src/core/schema/notification.ts

@@ -11,7 +11,6 @@ export interface HMSNotification {
 export enum HMSNotificationSeverity {
   INFO = 'info',
   ERROR = 'error',
-  CRITICAL = 'critical',
 }
 
 export enum HMSNotificationTypes {
@@ -28,7 +27,7 @@ export enum HMSNotificationTypes {
   TRACK_UNMUTED = 'TRACK_UNMUTED',
   TRACK_DEGRADED = 'TRACK_DEGRADED',
   TRACK_RESTORED = 'TRACK_RESTORED',
-  ROLE_CHANGE_REQUEST = 'ROLE_CHANGE_REQUEST',
+  TRACK_DESCRIPTION_CHANGED = 'TRACK_DESCRIPTION_CHANGED',
   ROLE_UPDATED = 'ROLE_UPDATED',
   CHANGE_TRACK_STATE_REQUEST = 'CHANGE_TRACK_STATE_REQUEST',
   CHANGE_MULTI_TRACK_STATE_REQUEST = 'CHANGE_MULTI_TRACK_STATE_REQUEST',

package/src/core/schema/peer.ts

@@ -1,8 +1,7 @@
-import { SimulcastLayerDefinition } from '@100mslive/hms-video';
-// noinspection ES6PreferShortImport
-import { HMSSimulcastLayer } from '../hmsSDKStore/sdkTypes';
+import { HMSSimulcastLayer, SimulcastLayerDefinition } from '../hmsSDKStore/sdkTypes';
 import { HMSRoleName } from './role';
 
+export type { SimulcastLayerDefinition, HMSSimulcastLayer };
 export type HMSPeerID = string;
 export type HMSTrackID = string;
 export type HMSTrackSource = 'regular' | 'screen' | 'plugin' | 'audioplaylist' | 'videoplaylist' | string;

package/src/core/schema/room.ts

@@ -1,6 +1,7 @@
-import { HMSRecording, HMSRTMP, HMSHLS } from '@100mslive/hms-video';
+import { HMSRecording, HMSRTMP, HMSHLS, HLSVariant } from '@100mslive/hms-video';
 import { HMSPeerID } from './peer';
 
+export type { HMSRecording, HMSRTMP, HMSHLS, HLSVariant };
 export type HMSRoomID = string;
 
 /**

package/src/test/unit/HMSNotifications.test.ts

@@ -58,11 +58,6 @@ describe('hms notifications tests', () => {
     expect(cb.mock.results[0].value.severity).toBe(HMSNotificationSeverity.INFO);
   });
 
-  test('when unhandled track event on Notification not to be called', () => {
-    notifications.sendTrackUpdate(sdkTypes.HMSTrackUpdate.TRACK_DESCRIPTION_CHANGED, track.id);
-    expect(cb.mock.calls.length).toBe(0);
-  });
-
   test('when track added on Notification to be called', () => {
     notifications.sendTrackUpdate(sdkTypes.HMSTrackUpdate.TRACK_ADDED, track.id);
     expect(cb.mock.calls.length).toBe(1);