@100mslive/hms-video-store 0.2.78 → 0.2.81

package/dist/core/IHMSActions.d.ts

@@ -1,7 +1,7 @@
 import { HMSConfig, HMSSimulcastLayer, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSLogLevel, HMSVideoPlugin, HMSAudioPlugin } from '@100mslive/hms-video';
 import { HMSMessageID, HMSPeerID, HMSRoleName, HMSTrackID, HMSTrackSource, IHMSPlaylistActions, HMSChangeMultiTrackStateParams } from './schema';
 import { HMSRoleChangeRequest } from './selectors';
-import { RTMPRecordingConfig, HMSPeerUpdateConfig } from './hmsSDKStore/sdkTypes';
+import { RTMPRecordingConfig } from './hmsSDKStore/sdkTypes';
 /**
  * The below interface defines our SDK API Surface for taking room related actions.
  * It talks to our 100ms backend and handles error reconnections, state managements
@@ -230,13 +230,15 @@ export interface IHMSActions {
      */
     stopRTMPAndRecording(): Promise<void>;
     /**
-     * If both name and data is undefined: Message is ignored.
-     * If data is undefined: Name of the peer is changed.
-     * If name is undefined: Metadata of the peer is updated.
-     * If both name and data is defined: Both name and metadata is updated.
-     * @alpha
+     * If you want to update the name of peer.
+     * @beta
      */
-    updatePeer(params: HMSPeerUpdateConfig): Promise<void>;
+    changeName(name: string): Promise<void>;
+    /**
+     * If you want to update the metadata of peer.
+     * @beta
+     */
+    changeMetadata(metadata: string): Promise<void>;
     /**
      * Set the type of logs from the SDK you want to be logged in the browser console.
      *

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

@@ -74,7 +74,8 @@ export declare class HMSSDKActions implements IHMSActions {
     removePeer(peerID: string, reason: string): Promise<void>;
     startRTMPOrRecording(params: sdkTypes.RTMPRecordingConfig): Promise<void>;
     stopRTMPAndRecording(): Promise<void>;
-    updatePeer(params: sdkTypes.HMSPeerUpdateConfig): Promise<void>;
+    changeName(name: string): Promise<void>;
+    changeMetadata(metadata: string): Promise<void>;
     setRemoteTrackEnabled(trackID: HMSTrackID | HMSTrackID[], enabled: boolean): Promise<void>;
     setRemoteTracksEnabled(params: HMSChangeMultiTrackStateParams): Promise<void>;
     setLogLevel(level: HMSLogLevel): void;

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, HMSRecording, HMSRTMP, HMSPeerUpdateConfig } 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, HMSPeerUpdateConfig, };
+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/notification.d.ts

@@ -25,6 +25,8 @@ export declare enum HMSNotificationTypes {
     TRACK_REMOVED = "TRACK_REMOVED",
     TRACK_MUTED = "TRACK_MUTED",
     TRACK_UNMUTED = "TRACK_UNMUTED",
+    TRACK_DEGRADED = "TRACK_DEGRADED",
+    TRACK_RESTORED = "TRACK_RESTORED",
     ROLE_CHANGE_REQUEST = "ROLE_CHANGE_REQUEST",
     ROLE_UPDATED = "ROLE_UPDATED",
     CHANGE_TRACK_STATE_REQUEST = "CHANGE_TRACK_STATE_REQUEST",

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

@@ -19,6 +19,11 @@ export interface HMSPeer {
     audioTrack?: HMSTrackID;
     auxiliaryTracks: HMSTrackID[];
     customerUserId?: string;
+    metadata?: string;
+    /**
+     * @deprecated
+     * Use metadata field instead.
+     */
     customerDescription?: string;
 }
 /**

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

@@ -1,4 +1,4 @@
-import { HMSRoleName, HMSStore, HMSTrack } from '../schema';
+import { HMSPeerID, HMSRoleName, HMSStore, HMSTrack } from '../schema';
 /**
  * StoreSelector is a function that takes in {@link HMSStore} as argument
  * and returns a part of the store that is queried using the selector.
@@ -119,4 +119,10 @@ export declare const selectMessagesUnreadCountByPeerID: (id?: string | undefined
  * @returns HMSPeer[]
  */
 export declare const selectPeersByRole: (role: HMSRoleName) => import("reselect").OutputSelector<HMSStore, import("../schema").HMSPeer[], (res: import("../schema").HMSPeer[]) => import("../schema").HMSPeer[]>;
+/**
+ * Selects the peer metadata for the passed in peer and returns it as JSON. If metadata is not present
+ * or conversion to JSON gives an error, an empty object is returned.
+ * Please directly use peer.metadata in case the metadata is not JSON by design.
+ */
+export declare const selectPeerMetadata: (peerId: HMSPeerID) => import("reselect").OutputSelector<HMSStore, any, (res: import("../schema").HMSPeer | null) => any>;
 export {};