@100mslive/hms-video-store 0.2.48 → 0.2.51

package/dist/core/hmsSDKStore/HMSPlaylist.d.ts

@@ -1,12 +1,14 @@
 import { HMSPlaylistItem, HMSPlaylistType, IHMSPlaylistActions } from '../schema';
 import { HMSPlaylistManager } from './sdkTypes';
+import { IHMSStore } from '../IHMSStore';
 export declare class HMSPlaylist implements IHMSPlaylistActions {
     private playlistManager;
     private syncPlaylistState;
+    private store;
     private type;
-    constructor(playlistManager: HMSPlaylistManager, type: HMSPlaylistType, syncPlaylistState: (action: string) => void);
+    constructor(playlistManager: HMSPlaylistManager, type: HMSPlaylistType, syncPlaylistState: (action: string) => void, store: IHMSStore);
     play(id: string): Promise<void>;
-    pause(id: string): Promise<void>;
+    pause(): Promise<void>;
     playNext(): Promise<void>;
     playPrevious(): Promise<void>;
     seek(seekValue: number): void;

package/dist/core/hmsSDKStore/HMSSDKActions.d.ts

@@ -1,11 +1,10 @@
-import { HMSMessage, HMSTrackID, HMSTrackSource } from '../schema';
+import { HMSMessage, HMSTrackID, HMSTrackSource, IHMSPlaylistActions } from '../schema';
 import { IHMSActions } from '../IHMSActions';
 import * as sdkTypes from './sdkTypes';
 import { HMSRoleChangeRequest } from '../selectors';
-import { HMSSdk, HMSVideoPlugin, HMSAudioPlugin, HMSTrack as SDKHMSTrack, HMSException as SDKHMSException, HMSChangeTrackStateRequest as SDKHMSChangeTrackStateRequest, HMSSimulcastLayer, HMSLogLevel } from '@100mslive/hms-video';
+import { HMSAudioPlugin, HMSChangeTrackStateRequest as SDKHMSChangeTrackStateRequest, HMSException as SDKHMSException, HMSLogLevel, HMSSdk, HMSSimulcastLayer, HMSTrack as SDKHMSTrack, HMSVideoPlugin } from '@100mslive/hms-video';
 import { IHMSStore } from '../IHMSStore';
 import { HMSNotifications } from './HMSNotifications';
-import { IHMSPlaylistActions } from '../schema';
 /**
  * This class implements the IHMSActions interface for 100ms SDK. It connects with SDK
  * and takes control of data management by letting every action pass through it. The
@@ -110,6 +109,11 @@ export declare class HMSSDKActions implements IHMSActions {
     protected onReconnected(): void;
     protected onReconnecting(sdkError: SDKHMSException): void;
     protected onError(sdkException: SDKHMSException): void;
+    /**
+     * the layer gets updated on addsink/removesink/preferlayer calls, for simulcast there
+     * can be multiple layers, while for non simulcast there will be None and High.
+     */
+    private updateVideoLayer;
     private handleTrackRemove;
     private setEnabledSDKTrack;
     private setSDKLocalVideoTrackSettings;

package/dist/core/hmsSDKStore/adapter.d.ts

@@ -38,4 +38,17 @@ export declare class SDKToHMS {
         };
     };
     private static getConvertedPlaylistType;
+    static convertRecordingRTMPState(recording: sdkTypes.HMSRecording | undefined, rtmp: sdkTypes.HMSRTMP | undefined): {
+        recording: {
+            browser: {
+                running: boolean;
+            };
+            server: {
+                running: boolean;
+            };
+        };
+        rtmp: {
+            running: boolean;
+        };
+    };
 }

package/dist/core/hmsSDKStore/sdkTypes.d.ts

@@ -1,2 +1,2 @@
-import { HMSException, HMSSimulcastLayer, HMSPeerUpdate, HMSRoomUpdate, HMSTrackUpdate, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSPeer, HMSRoom, HMSMessage, HMSConfig, HMSSpeaker, HMSRole, HMSLocalPeer, HMSRemotePeer, SimulcastLayerDefinition, DeviceMap, HMSLogLevel, HMSDeviceChangeEvent, HMSPlaylistItem, HMSPlaylistManager, HMSPlaylistProgressEvent, RTMPRecordingConfig } from '@100mslive/hms-video';
-export { HMSPeer, HMSRoom, HMSMessage, HMSSpeaker, HMSConfig, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSException, HMSSimulcastLayer, HMSRoomUpdate, HMSPeerUpdate, HMSTrackUpdate, HMSRole, HMSLocalPeer, HMSRemotePeer, HMSLogLevel, SimulcastLayerDefinition, DeviceMap, HMSDeviceChangeEvent, HMSPlaylistItem, HMSPlaylistManager, HMSPlaylistProgressEvent, RTMPRecordingConfig, };
+import { HMSException, HMSSimulcastLayer, HMSPeerUpdate, HMSRoomUpdate, HMSTrackUpdate, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSPeer, HMSRoom, HMSMessage, HMSConfig, HMSSpeaker, HMSRole, HMSLocalPeer, HMSRemotePeer, SimulcastLayerDefinition, DeviceMap, HMSLogLevel, HMSDeviceChangeEvent, HMSPlaylistItem, HMSPlaylistManager, HMSPlaylistProgressEvent, RTMPRecordingConfig, HMSRecording, HMSRTMP } from '@100mslive/hms-video';
+export { HMSPeer, HMSRoom, HMSMessage, HMSSpeaker, HMSConfig, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSException, HMSSimulcastLayer, HMSRoomUpdate, HMSPeerUpdate, HMSTrackUpdate, HMSRole, HMSLocalPeer, HMSRemotePeer, HMSLogLevel, SimulcastLayerDefinition, DeviceMap, HMSDeviceChangeEvent, HMSPlaylistItem, HMSPlaylistManager, HMSPlaylistProgressEvent, RTMPRecordingConfig, HMSRecording, HMSRTMP, };

package/dist/core/schema/playlist.d.ts

@@ -36,40 +36,39 @@ export interface HMSPlaylist<T> {
 }
 export interface IHMSPlaylistActions {
     /**
-     * Play audio/video passing url and type
+     * Pass the id of the item to be played
      * @param {string} id - id of playlist item
      */
     play(id: string): Promise<void>;
     /**
-     * Pause audio/video passing url and type
-     * @param {string} id - id of playlist item
+     * Pauses current playing item
      */
-    pause(id: string): Promise<void>;
+    pause(): Promise<void>;
     /**
-     * PlayNext audio/video passing type
+     * PlayNext
      */
     playNext(): Promise<void>;
     /**
-     * PlayPrevious audio/video passing type
+     * PlayPrevious
      */
     playPrevious(): Promise<void>;
     /**
-     * seek audio/video passing seekValue and type - this is relative to current position
+     * seek passing seekValue - this is relative to current position
      * @param {number} seekValue - number in seconds to move forwards(pass negative values to move backwards)
      */
     seek(seekValue: number): void;
     /**
-     * seek audio/video passing seekValue and type - seekValue will be absolute
+     * seek passing seekValue  - seekValue will be absolute
      * @param {number} seekValue - value in seconds of absolute position in the playlist item duration
      */
     seekTo(seekValue: number): void;
     /**
-     * set audio/video volume passing volume and type
+     * set volume passing volume
      * @param {number} volume - number between 0-100
      */
     setVolume(volume: number): void;
     /**
-     * pass list and type to set audio/video playlist
+     * pass list to set playlist
      * @param {HMSPlaylistItem[]} - list of playlist items
      */
     setList<T>(list: HMSPlaylistItem<T>[]): void;

package/dist/core/schema/room.d.ts

@@ -16,4 +16,15 @@ export interface HMSRoom {
     shareableLink: string;
     hasWaitingRoom: boolean;
     roomState: HMSRoomState;
+    recording: {
+        browser: {
+            running: boolean;
+        };
+        server: {
+            running: boolean;
+        };
+    };
+    rtmp: {
+        running: boolean;
+    };
 }

package/dist/core/selectors/selectors.d.ts

@@ -179,3 +179,23 @@ export declare const selectPermissions: import("reselect").OutputSelector<HMSSto
     mute: boolean;
     changeRole: boolean;
 } | undefined>;
+export declare const selectRecordingState: import("reselect").OutputSelector<HMSStore, {
+    browser: {
+        running: boolean;
+    };
+    server: {
+        running: boolean;
+    };
+}, (res: HMSRoom) => {
+    browser: {
+        running: boolean;
+    };
+    server: {
+        running: boolean;
+    };
+}>;
+export declare const selectRTMPState: import("reselect").OutputSelector<HMSStore, {
+    running: boolean;
+}, (res: HMSRoom) => {
+    running: boolean;
+}>;

package/dist/hms-video-store.cjs.development.js

@@ -885,7 +885,18 @@ var createDefaultStoreState = function createDefaultStoreState() {
       peers: [],
       shareableLink: '',
       hasWaitingRoom: false,
-      roomState: exports.HMSRoomState.Disconnected
+      roomState: exports.HMSRoomState.Disconnected,
+      recording: {
+        browser: {
+          running: false
+        },
+        server: {
+          running: false
+        }
+      },
+      rtmp: {
+        running: false
+      }
     },
     peers: {},
     tracks: {},
@@ -1268,6 +1279,24 @@ var SDKToHMS = /*#__PURE__*/function () {
     };
   };
 
+  SDKToHMS.convertRecordingRTMPState = function convertRecordingRTMPState(recording, rtmp) {
+    var _recording$server;
+
+    return {
+      recording: {
+        browser: {
+          running: !!(recording != null && recording.browser.running)
+        },
+        server: {
+          running: !!(recording != null && (_recording$server = recording.server) != null && _recording$server.running)
+        }
+      },
+      rtmp: {
+        running: !!(rtmp != null && rtmp.running)
+      }
+    };
+  };
+
   return SDKToHMS;
 }();
 
@@ -1722,6 +1751,12 @@ var selectIsAllowedToSubscribe = /*#__PURE__*/reselect.createSelector([selectLoc
 var selectPermissions = /*#__PURE__*/reselect.createSelector(selectLocalPeerRole, function (role) {
   return role == null ? void 0 : role.permissions;
 });
+var selectRecordingState = /*#__PURE__*/reselect.createSelector(selectRoom, function (room) {
+  return room.recording;
+});
+var selectRTMPState = /*#__PURE__*/reselect.createSelector(selectRoom, function (room) {
+  return room.rtmp;
+});
 
 /**
  * @internal
@@ -2380,9 +2415,10 @@ function isRemoteTrack(track) {
 }
 
 var HMSPlaylist = /*#__PURE__*/function () {
-  function HMSPlaylist(playlistManager, type, syncPlaylistState) {
+  function HMSPlaylist(playlistManager, type, syncPlaylistState, store) {
     this.playlistManager = playlistManager;
     this.syncPlaylistState = syncPlaylistState;
+    this.store = store;
     this.type = type;
   }
 
@@ -2399,7 +2435,7 @@ var HMSPlaylist = /*#__PURE__*/function () {
                 break;
               }
 
-              HMSLogger.w('Please pass id and type to pause');
+              HMSLogger.w('Please pass id to play');
               return _context.abrupt("return");
 
             case 3:
@@ -2425,27 +2461,31 @@ var HMSPlaylist = /*#__PURE__*/function () {
   }();
 
   _proto.pause = /*#__PURE__*/function () {
-    var _pause = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(id) {
+    var _pause = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2() {
+      var selector, selection;
       return runtime_1.wrap(function _callee2$(_context2) {
         while (1) {
           switch (_context2.prev = _context2.next) {
             case 0:
-              if (id) {
-                _context2.next = 3;
+              selector = this.type === exports.HMSPlaylistType.audio ? selectAudioPlaylist : selectVideoPlaylist;
+              selection = this.store.getState(selector.selection);
+
+              if (selection.id) {
+                _context2.next = 5;
                 break;
               }
 
-              HMSLogger.w('Please pass id and type to pause');
+              HMSLogger.w('No item is currently playing to pause');
               return _context2.abrupt("return");
 
-            case 3:
-              _context2.next = 5;
+            case 5:
+              _context2.next = 7;
               return this.playlistManager.setEnabled(false, {
-                id: id,
+                id: selection.id,
                 type: this.type
               });
 
-            case 5:
+            case 7:
             case "end":
               return _context2.stop();
           }
@@ -2453,7 +2493,7 @@ var HMSPlaylist = /*#__PURE__*/function () {
       }, _callee2, this);
     }));
 
-    function pause(_x2) {
+    function pause() {
       return _pause.apply(this, arguments);
     }
 
@@ -2664,7 +2704,7 @@ var HMSSDKActions = /*#__PURE__*/function () {
     if (track) {
       if (track instanceof sdkTypes.HMSRemoteVideoTrack) {
         track.preferLayer(layer);
-        this.syncRoomState('setPreferredLayer');
+        this.updateVideoLayer(trackId, 'setPreferredLayer');
       } else {
         HMSLogger.w("track " + trackId + " is not an video track");
       }
@@ -3307,7 +3347,7 @@ var HMSSDKActions = /*#__PURE__*/function () {
               sdkTrack = this.hmsSDKTracks[trackID];
 
               if (!(sdkTrack && sdkTrack.type === 'video')) {
-                _context17.next = 6;
+                _context17.next = 7;
                 break;
               }
 
@@ -3315,13 +3355,14 @@ var HMSSDKActions = /*#__PURE__*/function () {
               return sdkTrack.removeSink(videoElement);
 
             case 4:
-              _context17.next = 7;
+              this.updateVideoLayer(trackID, 'detachVideo');
+              _context17.next = 8;
               break;
 
-            case 6:
+            case 7:
               this.logPossibleInconsistency('no video track found to remove sink');
 
-            case 7:
+            case 8:
             case "end":
               return _context17.stop();
           }
@@ -3920,14 +3961,7 @@ var HMSSDKActions = /*#__PURE__*/function () {
               return sdkTrack.addSink(videoElement);
 
             case 4:
-              // Update layer as it is updated in addSink
-              if (sdkTrack instanceof sdkTypes.HMSRemoteVideoTrack && sdkTrack.getSimulcastDefinitions().length > 0) {
-                this.setState(function (draft) {
-                  var layer = sdkTrack.getSimulcastLayer();
-                  draft.tracks[trackID].layer = layer;
-                }, 'updateLayerOnAttach');
-              }
-
+              this.updateVideoLayer(trackID, 'attachVideo');
               _context32.next = 8;
               break;
 
@@ -3996,11 +4030,13 @@ var HMSSDKActions = /*#__PURE__*/function () {
       if (hmsPeer.isLocal) {
         Object.assign(newMediaSettings, this.getMediaSettings(sdkPeer));
       }
-    } // then merge them carefully with our store so if something hasn't changed
+    }
+
+    var recording = this.sdk.getRecordingState();
+    var rtmp = this.sdk.getRTMPState(); // then merge them carefully with our store so if something hasn't changed
     // the reference shouldn't change. Note that the draftStore is an immer draft
     // object.
 
-
     this.setState(function (draftStore) {
       draftStore.room.peers = newHmsPeerIDs;
       var draftPeers = draftStore.peers;
@@ -4012,6 +4048,7 @@ var HMSSDKActions = /*#__PURE__*/function () {
       _this8.hmsSDKTracks = newHmsSDkTracks;
       Object.assign(draftStore.roles, SDKToHMS.convertRoles(_this8.sdk.getRoles()));
       Object.assign(draftStore.playlist, SDKToHMS.convertPlaylist(_this8.sdk.getPlaylistManager()));
+      Object.assign(draftStore.room, SDKToHMS.convertRecordingRTMPState(recording, rtmp));
     }, action);
   };
 
@@ -4026,8 +4063,8 @@ var HMSSDKActions = /*#__PURE__*/function () {
   _proto.onJoin = function onJoin(sdkRoom) {
     var _this9 = this;
 
-    this.audioPlaylist = new HMSPlaylist(this.sdk.getPlaylistManager(), exports.HMSPlaylistType.audio, this.syncPlaylistState.bind(this));
-    this.videoPlaylist = new HMSPlaylist(this.sdk.getPlaylistManager(), exports.HMSPlaylistType.video, this.syncRoomState.bind(this));
+    this.audioPlaylist = new HMSPlaylist(this.sdk.getPlaylistManager(), exports.HMSPlaylistType.audio, this.syncPlaylistState.bind(this), this.store);
+    this.videoPlaylist = new HMSPlaylist(this.sdk.getPlaylistManager(), exports.HMSPlaylistType.video, this.syncRoomState.bind(this), this.store);
     this.syncRoomState('joinSync');
     this.setState(function (store) {
       Object.assign(store.room, SDKToHMS.convertRoom(sdkRoom));
@@ -4207,6 +4244,21 @@ var HMSSDKActions = /*#__PURE__*/function () {
 
     this.hmsNotifications.sendError(error);
     HMSLogger.e('received error from sdk', error);
+  }
+  /**
+   * the layer gets updated on addsink/removesink/preferlayer calls, for simulcast there
+   * can be multiple layers, while for non simulcast there will be None and High.
+   */
+  ;
+
+  _proto.updateVideoLayer = function updateVideoLayer(trackID, action) {
+    var sdkTrack = this.hmsSDKTracks[trackID];
+
+    if (sdkTrack && sdkTrack instanceof sdkTypes.HMSRemoteVideoTrack) {
+      this.setState(function (draft) {
+        draft.tracks[trackID].layer = sdkTrack.getSimulcastLayer();
+      }, action);
+    }
   };
 
   _proto.handleTrackRemove = function handleTrackRemove(sdkTrack, sdkPeer) {
@@ -5023,6 +5075,8 @@ exports.selectPeersMap = selectPeersMap;
 exports.selectPeersScreenSharing = selectPeersScreenSharing;
 exports.selectPeersWithAudioStatus = selectPeersWithAudioStatus;
 exports.selectPermissions = selectPermissions;
+exports.selectRTMPState = selectRTMPState;
+exports.selectRecordingState = selectRecordingState;
 exports.selectRemotePeers = selectRemotePeers;
 exports.selectRoleByRoleName = selectRoleByRoleName;
 exports.selectRoleChangeRequest = selectRoleChangeRequest;