@100mslive/hms-video-store 0.2.56 → 0.2.59

package/dist/core/IHMSActions.d.ts

@@ -1,5 +1,5 @@
 import { HMSConfig, HMSSimulcastLayer, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSLogLevel, HMSVideoPlugin, HMSAudioPlugin } from '@100mslive/hms-video';
-import { HMSPeerID, HMSRoleName, HMSTrackSource, IHMSPlaylistActions } from './schema';
+import { HMSMessageID, HMSPeerID, HMSRoleName, HMSTrackID, HMSTrackSource, IHMSPlaylistActions, HMSChangeMultiTrackStateRequest } from './schema';
 import { HMSRoleChangeRequest } from './selectors';
 import { RTMPRecordingConfig } from './hmsSDKStore/sdkTypes';
 /**
@@ -55,7 +55,7 @@ export interface IHMSActions {
      * This method removes the track from the local peer's list of auxiliary tracks and unpublishes it.
      * @param trackId string - ID of the track to be removed
      */
-    removeTrack(trackId: string): Promise<void>;
+    removeTrack(trackId: HMSTrackID): Promise<void>;
     /**
      * @deprecated The method should not be used
      * @see sendBroadcastMessage
@@ -93,21 +93,22 @@ export interface IHMSActions {
      * @param readStatus boolean value which you want to set as read flag for message/messages.
      * @param messageId message id whose read falg you want to set.
      */
-    setMessageRead(readStatus: boolean, messageId?: string): void;
+    setMessageRead(readStatus: boolean, messageId?: HMSMessageID): void;
     /**
-     * These functions can be used to mute/unmute the local peer's audio and video
-     * @param enabled boolean
+     * This function can be used to enable/disable(unmute/mute) local audio track
+     * @param enabled boolean - true to unmute, false to mute
      */
     setLocalAudioEnabled(enabled: boolean): Promise<void>;
     /**
-     * @see setLocalAudioEnabled
+     * This function can be used to enable/disable(unmute/mute) local video track
+     * @param enabled boolean - true to unmute, false to mute
      */
     setLocalVideoEnabled(enabled: boolean): Promise<void>;
     /**
      * @param trackId string - ID of the track whose mute status needs to be set
      * @param enabled boolean - true when we want to unmute the track and false when we want to unmute it
      */
-    setEnabledTrack(trackId: string, enabled: boolean): Promise<void>;
+    setEnabledTrack(trackId: HMSTrackID, enabled: boolean): Promise<void>;
     /**
      * Change settings of the local peer's audio track
      * @param settings HMSAudioTrackSettings
@@ -121,25 +122,25 @@ export interface IHMSActions {
      */
     setVideoSettings(settings: Partial<HMSVideoTrackSettings>): Promise<void>;
     /**
-     * If you're not using our Video Component you can use the below functions directly
+     * You can use the attach and detach video function
      * to add/remove video from an element for a track ID. The benefit of using this
      * instead of removing the video yourself is that it'll also auto unsubscribe to
      * the stream coming from server saving significant bandwidth for the user.
-     * @param trackID trackID as stored in the store for the peer
+     * @param localTrackID trackID as stored in the store for the peer
      * @param videoElement HTML native element where the video has to be shown
      */
-    attachVideo(trackID: string, videoElement: HTMLVideoElement): Promise<void>;
+    attachVideo(localTrackID: HMSTrackID, videoElement: HTMLVideoElement): Promise<void>;
     /**
      * @see attachVideo
      */
-    detachVideo(trackID: string, videoElement: HTMLVideoElement): Promise<void>;
+    detachVideo(localTrackID: HMSTrackID, videoElement: HTMLVideoElement): Promise<void>;
     /**
      * Set the output volume of audio tracks(overall/particular audio track)
      * @param value number between 0-100
      * @param trackId string If undefined sets the overall volume(of every audio track in the room); If valid - set the volume of particular audio track
      *
      */
-    setVolume(value: number, trackId?: string): void;
+    setVolume(value: number, trackId?: HMSTrackID): void;
     /**
      * Set the audio output(speaker) device
      * @param deviceId string deviceId of the audio output device
@@ -150,7 +151,7 @@ export interface IHMSActions {
      * @param trackId
      * @param layer
      */
-    setPreferredLayer(trackId: string, layer: HMSSimulcastLayer): void;
+    setPreferredLayer(trackId: HMSTrackID, layer: HMSSimulcastLayer): void;
     /**
      * Add or remove a video plugin from/to the local peer video track. Eg. Virtual Background, Face Filters etc.
      * Video plugins can be added/removed at any time after the join is successful.
@@ -172,7 +173,7 @@ export interface IHMSActions {
      * @param toRole The name of the new role.
      * @param [force] this being true would mean that user won't get a request to accept role change
      */
-    changeRole(forPeerId: string, toRole: string, force?: boolean): Promise<void>;
+    changeRole(forPeerId: HMSPeerID, toRole: HMSRoleName, force?: boolean): Promise<void>;
     /**
      * Accept the role change request received
      * @param {HMSRoleChangeRequest} request The original request that was received
@@ -189,9 +190,17 @@ export interface IHMSActions {
      * @param forRemoteTrackID The track ID or array of track IDs for which you want to change the state
      * @param enabled `true` if you wish to enable(unmute permission is required) the track, `false` if you wish to disable(mute permission is required) the track
      */
-    setRemoteTrackEnabled(forRemoteTrackID: string | string[], enabled: boolean): Promise<void>;
+    setRemoteTrackEnabled(forRemoteTrackID: HMSTrackID | HMSTrackID[], enabled: boolean): Promise<void>;
+    /**
+     * Use this to mute/unmute multipe tracks by source, role or type
+     * @param {HMSChangeMultiTrackStateRequest} params
+     */
+    setRemoteTracksEnabled(params: HMSChangeMultiTrackStateRequest): Promise<void>;
     /**
      * Method to be called with some UI interaction after autoplay error is received
+     * Most browsers have limitations where an audio can not be played if there was no user interaction.
+     * SDK throws an autoplay error in this case, this method can be called after an UI interaction
+     * to resolve the autoplay error
      */
     unblockAudio: () => Promise<void>;
     /**
@@ -201,12 +210,12 @@ export interface IHMSActions {
     endRoom: (lock: boolean, reason: string) => Promise<void>;
     /**
      * If you have **removeOthers** permission, you can remove a peer from the room.
-     * @param peerID peerID of the peer to be removed from the remove
+     * @param peerID peerID of the peer to be removed from the room
      * @param reason a string explaining why the peer is removed from the room.
      * This string could be used to notify the user before they're removed from the room
      * using the `REMOVED_FROM_ROOM` type of notification
      */
-    removePeer(peerID: string, reason: string): Promise<void>;
+    removePeer(peerID: HMSPeerID, reason: string): Promise<void>;
     /**
      * If you want to start RTMP streaming or recording.
      * @param params.meetingURL This is the meeting url which is opened in a headless chrome instance for streaming and recording.

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

@@ -1,7 +1,7 @@
 import { IHMSNotifications } from '../IHMSNotifications';
 import { IHMSStore } from '../IHMSStore';
 import * as sdkTypes from './sdkTypes';
-import { HMSNotification, HMSPeer, HMSException, HMSMessage, HMSChangeTrackStateRequest, HMSLeaveRoomRequest, HMSDeviceChangeEvent } from '../schema';
+import { HMSNotification, HMSPeer, HMSException, HMSMessage, HMSChangeTrackStateRequest, HMSChangeMultiTrackStateRequest, HMSLeaveRoomRequest, HMSDeviceChangeEvent } from '../schema';
 export declare class HMSNotifications implements IHMSNotifications {
     private id;
     private eventEmitter;
@@ -17,6 +17,7 @@ export declare class HMSNotifications implements IHMSNotifications {
     sendReconnecting(error: HMSException): void;
     sendReconnected(): void;
     sendChangeTrackStateRequest(request: HMSChangeTrackStateRequest): void;
+    sendChangeMultiTrackStateRequest(request: HMSChangeMultiTrackStateRequest): void;
     private emitEvent;
     private createNotification;
 }

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

@@ -1,8 +1,8 @@
-import { HMSMessage, HMSTrackID, HMSTrackSource, IHMSPlaylistActions } from '../schema';
+import { HMSMessage, HMSTrackID, HMSTrackSource, HMSChangeMultiTrackStateParams, IHMSPlaylistActions } from '../schema';
 import { IHMSActions } from '../IHMSActions';
 import * as sdkTypes from './sdkTypes';
 import { HMSRoleChangeRequest } from '../selectors';
-import { HMSAudioPlugin, HMSChangeTrackStateRequest as SDKHMSChangeTrackStateRequest, HMSException as SDKHMSException, HMSLogLevel, HMSSdk, HMSSimulcastLayer, HMSTrack as SDKHMSTrack, HMSVideoPlugin } from '@100mslive/hms-video';
+import { HMSAudioPlugin, HMSException as SDKHMSException, HMSLogLevel, HMSChangeTrackStateRequest as SDKHMSChangeTrackStateRequest, HMSChangeMultiTrackStateRequest as SDKHMSChangeMultiTrackStateRequest, HMSSdk, HMSSimulcastLayer, HMSTrack as SDKHMSTrack, HMSVideoPlugin } from '@100mslive/hms-video';
 import { IHMSStore } from '../IHMSStore';
 import { HMSNotifications } from './HMSNotifications';
 /**
@@ -75,6 +75,7 @@ export declare class HMSSDKActions implements IHMSActions {
     startRTMPOrRecording(params: sdkTypes.RTMPRecordingConfig): Promise<void>;
     stopRTMPAndRecording(): Promise<void>;
     setRemoteTrackEnabled(trackID: HMSTrackID | HMSTrackID[], enabled: boolean): Promise<void>;
+    setRemoteTracksEnabled(params: HMSChangeMultiTrackStateParams): Promise<void>;
     setLogLevel(level: HMSLogLevel): void;
     private resetState;
     private sdkJoinWithListeners;
@@ -106,6 +107,7 @@ export declare class HMSSDKActions implements IHMSActions {
     protected onHMSMessage(hmsMessage: HMSMessage): void;
     protected onAudioLevelUpdate(sdkSpeakers: sdkTypes.HMSSpeaker[]): void;
     protected onChangeTrackStateRequest(request: SDKHMSChangeTrackStateRequest): void;
+    protected onChangeMultiTrackStateRequest(request: SDKHMSChangeMultiTrackStateRequest): void;
     protected onReconnected(): void;
     protected onReconnecting(sdkError: SDKHMSException): void;
     protected onError(sdkException: SDKHMSException): void;

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

@@ -39,16 +39,7 @@ 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;
-        };
+        recording: sdkTypes.HMSRecording;
+        rtmp: sdkTypes.HMSRTMP;
     };
 }

package/dist/core/index.d.ts

@@ -4,4 +4,4 @@ export { IHMSNotifications as HMSNotifications } from './IHMSNotifications';
 export { HMSReactiveStore } from './hmsSDKStore/HMSReactiveStore';
 export * from './schema';
 export * from './selectors';
-export { HMSConfig, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSSimulcastLayer, SimulcastLayerDefinition, DeviceMap, HMSLogLevel, RTMPRecordingConfig, } from './hmsSDKStore/sdkTypes';
+export { HMSConfig, HMSAudioTrackSettings, HMSVideoTrackSettings, HMSSimulcastLayer, SimulcastLayerDefinition, DeviceMap, HMSLogLevel, RTMPRecordingConfig, HMSRecording, HMSRTMP, } from './hmsSDKStore/sdkTypes';

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

@@ -3,7 +3,6 @@ export * from './room';
 export * from './peer';
 export * from './message';
 export * from './settings';
-export * from './ui';
 export * from './notification';
 export * from './role';
 export * from './error';

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

@@ -27,6 +27,7 @@ export declare enum HMSNotificationTypes {
     ROLE_CHANGE_REQUEST = "ROLE_CHANGE_REQUEST",
     ROLE_UPDATED = "ROLE_UPDATED",
     CHANGE_TRACK_STATE_REQUEST = "CHANGE_TRACK_STATE_REQUEST",
+    CHANGE_MULTI_TRACK_STATE_REQUEST = "CHANGE_MULTI_TRACK_STATE_REQUEST",
     ROOM_ENDED = "ROOM_ENDED",
     REMOVED_FROM_ROOM = "REMOVED_FROM_ROOM",
     DEVICE_CHANGE_UPDATE = "DEVICE_CHANGE_UPDATE"

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

@@ -1,3 +1,4 @@
+import { HMSTrackSource } from '.';
 import { HMSPeer, HMSPeerID, HMSTrack } from './peer';
 import { HMSRoleName } from './role';
 export interface HMSRoleChangeStoreRequest {
@@ -10,6 +11,19 @@ export interface HMSChangeTrackStateRequest {
     track: HMSTrack;
     enabled: boolean;
 }
+export interface HMSChangeMultiTrackStateRequest {
+    requestedBy: HMSPeer;
+    tracks: HMSTrack[];
+    enabled: boolean;
+    type?: 'audio' | 'video';
+    source?: HMSTrackSource;
+}
+export interface HMSChangeMultiTrackStateParams {
+    enabled: boolean;
+    roles?: HMSRoleName[];
+    type?: 'audio' | 'video';
+    source?: HMSTrackSource;
+}
 export interface HMSLeaveRoomRequest {
     requestedBy: HMSPeer;
     reason: string;

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

@@ -1,4 +1,5 @@
 import { HMSPeerID } from './peer';
+import { HMSRecording, HMSRTMP } from '@100mslive/hms-video';
 export declare type HMSRoomID = string;
 export declare enum HMSRoomState {
     Disconnected = "Disconnected",
@@ -17,15 +18,6 @@ export interface HMSRoom {
     shareableLink: string;
     hasWaitingRoom: boolean;
     roomState: HMSRoomState;
-    recording: {
-        browser: {
-            running: boolean;
-        };
-        server: {
-            running: boolean;
-        };
-    };
-    rtmp: {
-        running: boolean;
-    };
+    recording: HMSRecording;
+    rtmp: HMSRTMP;
 }

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

@@ -179,23 +179,5 @@ 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;
-}>;
+export declare const selectRecordingState: import("reselect").OutputSelector<HMSStore, import("@100mslive/hms-video/dist/interfaces/room").HMSRecording, (res: HMSRoom) => import("@100mslive/hms-video/dist/interfaces/room").HMSRecording>;
+export declare const selectRTMPState: import("reselect").OutputSelector<HMSStore, import("@100mslive/hms-video/dist/interfaces/room").HMSRTMP, (res: HMSRoom) => import("@100mslive/hms-video/dist/interfaces/room").HMSRTMP>;