@100mslive/hms-video-store 0.2.82 → 0.2.83

package/src/core/schema/peer.ts

@@ -1,78 +0,0 @@
-import { SimulcastLayerDefinition } from '@100mslive/hms-video';
-// noinspection ES6PreferShortImport
-import { HMSSimulcastLayer } from '../hmsSDKStore/sdkTypes';
-import { HMSRoleName } from './role';
-
-export type HMSPeerID = string;
-export type HMSTrackID = string;
-export type HMSTrackSource =
-  | 'regular'
-  | 'screen'
-  | 'plugin'
-  | 'audioplaylist'
-  | 'videoplaylist'
-  | string;
-export type HMSTrackType = 'audio' | 'video';
-export type HMSTrackDisplaySurface = 'application' | 'browser' | 'monitor' | 'window';
-
-/**
- * HMSPeer stores the details of individual participants in the room
- */
-export interface HMSPeer {
-  id: HMSPeerID;
-  name: string;
-  roleName?: HMSRoleName;
-  isLocal: boolean;
-  isStarred?: boolean;
-  videoTrack?: HMSTrackID;
-  audioTrack?: HMSTrackID;
-  auxiliaryTracks: HMSTrackID[];
-  customerUserId?: string;
-  metadata?: string;
-  /**
-   * @deprecated
-   * Use metadata field instead.
-   */
-  customerDescription?: string;
-}
-
-/**
- * HMS Track stores details about individual tracks of the room. This object is
- * not meant to be used normally for UI interfaces, as interactions with this object
- * should be kept to bare minimum.
- * enabled - tells the real track enabled status, use this to call attach/detach video
- * displayEnabled - can be used to give immediate feedback to the user on button click
- * deviceID - this is the ID of the source device for the track. This can be a dummy ID when track is on mute.
- * degraded - tells whether the track has been degraded(receiving lower video quality/no video) due to bad network locally
- */
-export interface HMSTrack {
-  id: HMSTrackID;
-  source?: HMSTrackSource;
-  type: HMSTrackType;
-  enabled: boolean;
-  height?: number;
-  width?: number;
-  peerId?: string;
-  deviceID?: string;
-  plugins?: string[];
-  displayEnabled?: boolean;
-  volume?: number;
-  layer?: HMSSimulcastLayer;
-  layerDefinitions?: SimulcastLayerDefinition[];
-  degraded?: boolean;
-  displaySurface?: HMSTrackDisplaySurface;
-}
-
-/**
- * HMS Speaker stores the details of peers speaking at any point of time along with
- * their audio levels. This can be used to current speakers or highlight videotiles.
- *
- * @privateRemarks
- * This is a separate interface instead of being part of the HMSPeer interface as the
- * corresponding update is high frequency.
- */
-export interface HMSSpeaker {
-  peerID: HMSPeerID;
-  trackID: HMSTrackID;
-  audioLevel: number;
-}

package/src/core/schema/playlist.ts

@@ -1,114 +0,0 @@
-import { HMSStore } from '../schema';
-
-export enum HMSPlaylistType {
-  audio = 'audio',
-  video = 'video',
-}
-export interface HMSPlaylistItem<T> {
-  name: string;
-  id: string;
-  metadata?: T;
-  url: string;
-  type: HMSPlaylistType;
-  duration?: number;
-  playing: boolean;
-  selected: boolean;
-}
-
-export interface HMSPlaylistSelection {
-  id: string;
-  hasPrevious: boolean;
-  hasNext: boolean;
-}
-
-export interface HMSPlaylist<T> {
-  audio: {
-    list: Record<string, HMSPlaylistItem<T>>;
-    selection: HMSPlaylistSelection;
-    progress: number;
-    volume: number;
-    currentTime: number;
-    playbackRate: number;
-  };
-  video: {
-    list: Record<string, HMSPlaylistItem<T>>;
-    selection: HMSPlaylistSelection;
-    progress: number;
-    volume: number;
-    currentTime: number;
-    playbackRate: number;
-  };
-}
-
-export interface IHMSPlaylistActions {
-  /**
-   * Pass the id of the item to be played
-   * @param {string} id - id of playlist item
-   */
-  play(id: string): Promise<void>;
-  /**
-   * Pauses current playing item
-   */
-  pause(): Promise<void>;
-  /**
-   * PlayNext
-   */
-  playNext(): Promise<void>;
-  /**
-   * PlayPrevious
-   */
-  playPrevious(): Promise<void>;
-  /**
-   * 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 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 volume passing volume
-   * @param {number} volume - number between 0-100
-   */
-  setVolume(volume: number): void;
-  /**
-   * pass list to set playlist
-   * @param {HMSPlaylistItem[]} - list of playlist items
-   */
-  setList<T>(list: HMSPlaylistItem<T>[]): void;
-  /**
-   * Stop the current playback and remove the tracks
-   */
-  stop(): Promise<void>;
-  /**
-   * set whether to autoplay next item in playlist after the current one ends
-   * @param {boolean} autoplay
-   */
-  setIsAutoplayOn(autoplay: boolean): void;
-  /**
-   * Control the playback speed - 1.0 being normal, less than 1.0 will play it slowly
-   * and more than 1.0 will play it faster.
-   * @param playbackRate - value from 0.25 and 2.0
-   */
-  setPlaybackRate(playbackRate: number): void;
-}
-
-export interface HMSPlaylistSelector {
-  list: <T>(store: HMSStore) => HMSPlaylistItem<T>[];
-  /**
-   * This returns playlist selection with id, hasNext, hasPrev
-   * @returns {HMSPlaylistSelection}
-   */
-  selection: (store: HMSStore) => HMSPlaylistSelection;
-  /**
-   * This returns playlist item for corresponding Id in selection
-   * @returns {HMSPlaylistItem}
-   */
-  selectedItem: <T>(store: HMSStore) => HMSPlaylistItem<T>;
-  progress: (store: HMSStore) => number;
-  volume: (store: HMSStore) => number;
-  currentTime: (store: HMSStore) => number;
-  playbackRate: (store: HMSStore) => number;
-}

package/src/core/schema/requests.ts

@@ -1,36 +0,0 @@
-import { HMSTrackSource } from '.';
-import { HMSPeer, HMSPeerID, HMSTrack } from './peer';
-import { HMSRoleName } from './role';
-
-export interface HMSRoleChangeStoreRequest {
-  requestedBy: HMSPeerID;
-  roleName: HMSRoleName;
-  token: string;
-}
-
-export interface HMSChangeTrackStateRequest {
-  requestedBy: HMSPeer;
-  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;
-  roomEnded: boolean;
-}

package/src/core/schema/role.ts

@@ -1,5 +0,0 @@
-import { HMSRole } from '@100mslive/hms-video';
-
-export type HMSRoleName = string;
-
-export { HMSRole };

package/src/core/schema/room.ts

@@ -1,26 +0,0 @@
-import { HMSRecording, HMSRTMP } from '@100mslive/hms-video';
-import { HMSPeerID } from './peer';
-
-export type HMSRoomID = string;
-
-export enum HMSRoomState {
-  Disconnected = 'Disconnected',
-  Preview = 'Preview',
-  Connecting = 'Connecting',
-  Connected = 'Connected',
-  Reconnecting = 'Reconnecting',
-  Failed = 'Failed',
-}
-
-export interface HMSRoom {
-  id: HMSRoomID;
-  name: string;
-  isConnected?: boolean;
-  peers: HMSPeerID[];
-  localPeer: HMSPeerID;
-  shareableLink: string;
-  hasWaitingRoom: boolean;
-  roomState: HMSRoomState;
-  recording: HMSRecording;
-  rtmp: HMSRTMP;
-}

package/src/core/schema/schema.ts

@@ -1,94 +0,0 @@
-import { HMSPeer, HMSPeerID, HMSTrackID, HMSTrack, HMSSpeaker } from './peer';
-import { HMSMessage, HMSMessageID } from './message';
-import { HMSRoom, HMSRoomState } from './room';
-import { HMSMediaSettings } from './settings';
-import { DeviceMap } from '../hmsSDKStore/sdkTypes';
-import { HMSRole } from './role';
-import { HMSRoleChangeStoreRequest } from './requests';
-import { HMSException } from './error';
-import { HMSPlaylist } from './playlist';
-
-/*
- * Defines the schema of the central store. UI Components are aware of the presence
- * of this central store. This is the global state - the single source of immutable truth.
- */
-export interface HMSStore {
-  room: HMSRoom;
-  peers: Record<HMSPeerID, HMSPeer>;
-  speakers: Record<HMSTrackID, HMSSpeaker>;
-  tracks: Record<HMSTrackID, HMSTrack>;
-  playlist: HMSPlaylist<any>;
-  messages: {
-    byID: Record<HMSMessageID, HMSMessage>;
-    allIDs: HMSMessageID[];
-  };
-  settings: HMSMediaSettings;
-  devices: DeviceMap;
-  roles: Record<string, HMSRole>;
-  roleChangeRequests: HMSRoleChangeStoreRequest[];
-  errors: HMSException[]; // for the convenience of debugging and seeing any error in devtools
-}
-
-/**
- * @internal
- */
-export const createDefaultStoreState = (): HMSStore => {
-  return {
-    room: {
-      id: '',
-      isConnected: false,
-      name: '',
-      peers: [],
-      shareableLink: '',
-      localPeer: '',
-      hasWaitingRoom: false,
-      roomState: HMSRoomState.Disconnected,
-      recording: {
-        browser: {
-          running: false,
-        },
-        server: {
-          running: false,
-        },
-      },
-      rtmp: {
-        running: false,
-      },
-    },
-    peers: {},
-    tracks: {},
-    playlist: {
-      audio: {
-        list: {},
-        selection: { id: '', hasPrevious: false, hasNext: false },
-        progress: 0,
-        volume: 0,
-        currentTime: 0,
-        playbackRate: 1.0,
-      },
-      video: {
-        list: {},
-        selection: { id: '', hasPrevious: false, hasNext: false },
-        progress: 0,
-        volume: 0,
-        currentTime: 0,
-        playbackRate: 1.0,
-      },
-    },
-    messages: { byID: {}, allIDs: [] },
-    speakers: {},
-    settings: {
-      audioInputDeviceId: '',
-      audioOutputDeviceId: '',
-      videoInputDeviceId: '',
-    },
-    devices: {
-      audioInput: [],
-      audioOutput: [],
-      videoInput: [],
-    },
-    roles: {},
-    roleChangeRequests: [],
-    errors: [],
-  };
-};

package/src/core/schema/settings.ts

@@ -1,5 +0,0 @@
-export interface HMSMediaSettings {
-  audioInputDeviceId: string;
-  videoInputDeviceId: string;
-  audioOutputDeviceId?: string;
-}

package/src/core/selectors/derivedSelectors.ts

@@ -1,81 +0,0 @@
-import { HMSPeer, HMSStore } from '../schema';
-import { selectLocalPeerRole, selectPeersMap, selectRolesMap, selectTracksMap } from './selectors';
-import { createSelector } from 'reselect';
-import { HMSRole } from '@100mslive/hms-video';
-
-export interface HMSPeerWithMuteStatus {
-  peer: HMSPeer;
-  isAudioEnabled?: boolean;
-}
-
-/**
- * @privateRemarks
- * this is more friendly to UI format, the object in store has only peer id and role name instead of the full objects
- */
-export interface HMSRoleChangeRequest {
-  requestedBy: HMSPeer;
-  role: HMSRole;
-  token: string;
-}
-
-export interface HMSPublishAllowed {
-  video: boolean;
-  audio: boolean;
-  screen: boolean;
-}
-
-export const selectPeersWithAudioStatus = createSelector(
-  [selectPeersMap, selectTracksMap],
-  (peersMap, tracksMap) => {
-    const participants: HMSPeerWithMuteStatus[] = Object.values(peersMap).map(peer => {
-      return {
-        peer: peer,
-        isAudioEnabled: peer.audioTrack ? tracksMap[peer.audioTrack]?.enabled : false,
-      };
-    });
-    return participants;
-  },
-);
-
-const selectRoleChangeStoreRequest = (store: HMSStore) => {
-  return store.roleChangeRequests[0] || null;
-};
-
-/**
- * Select the role change request received for your local peer.
- */
-export const selectRoleChangeRequest = createSelector(
-  [selectRoleChangeStoreRequest, selectPeersMap, selectRolesMap],
-  (request, peersMap, rolesMap): HMSRoleChangeRequest | null => {
-    if (!request) {
-      return null;
-    }
-    return {
-      requestedBy: peersMap[request.requestedBy],
-      role: rolesMap[request.roleName],
-      token: request.token,
-    };
-  },
-);
-
-/**
- * Select what streams is the local peer allowed to publish from video, audio and screenshare.
- */
-export const selectIsAllowedToPublish = createSelector(
-  [selectLocalPeerRole],
-  (role): HMSPublishAllowed => {
-    let video = false,
-      audio = false,
-      screen = false;
-    if (role?.publishParams?.allowed) {
-      video = role.publishParams.allowed.includes('video');
-      audio = role.publishParams.allowed.includes('audio');
-      screen = role.publishParams.allowed.includes('screen');
-    }
-    return {
-      video,
-      audio,
-      screen,
-    };
-  },
-);

package/src/core/selectors/index.ts

@@ -1,5 +0,0 @@
-export * from './selectors';
-export * from './playlistselectors';
-export * from './selectorsByID';
-export * from './derivedSelectors';
-export * from './selectorsByReference';

package/src/core/selectors/playlistselectors.ts

@@ -1,67 +0,0 @@
-import { createSelector } from 'reselect';
-import { HMSPlaylistType, HMSStore, HMSPlaylistSelector } from '../schema';
-
-/**
- * @internal
- */
-const selectPlaylistMap = (type: HMSPlaylistType = HMSPlaylistType.audio) => (store: HMSStore) =>
-  store.playlist[type].list;
-
-const selectPlaylistSelection = (type: HMSPlaylistType = HMSPlaylistType.audio) => (
-  store: HMSStore,
-) => store.playlist[type].selection;
-
-const selectPlaylistProgress = (type: HMSPlaylistType = HMSPlaylistType.audio) => (
-  store: HMSStore,
-) => store.playlist[type].progress;
-
-const selectPlaylistCurrentTime = (type: HMSPlaylistType = HMSPlaylistType.audio) => (
-  store: HMSStore,
-) => store.playlist[type].currentTime;
-
-const selectPlaylistPlaybackRate = (type: HMSPlaylistType = HMSPlaylistType.audio) => (
-  store: HMSStore,
-) => store.playlist[type].playbackRate;
-
-const selectPlaylistVolume = (type: HMSPlaylistType = HMSPlaylistType.audio) => (store: HMSStore) =>
-  store.playlist[type].volume;
-
-/**
- * Select an array of playlist items.
- */
-const selectPlaylist = (type: HMSPlaylistType = HMSPlaylistType.audio) =>
-  createSelector(selectPlaylistMap(type), storePlaylist => {
-    return Object.values(storePlaylist);
-  });
-
-const selectPlaylistSelectedItem = (type: HMSPlaylistType = HMSPlaylistType.audio) =>
-  createSelector(
-    selectPlaylistMap(type),
-    selectPlaylistSelection(type),
-    (storePlaylist, currentSelection) => {
-      if (!currentSelection.id) {
-        return;
-      }
-      return storePlaylist[currentSelection.id];
-    },
-  );
-
-export const selectAudioPlaylist: HMSPlaylistSelector = {
-  selection: selectPlaylistSelection(HMSPlaylistType.audio),
-  progress: selectPlaylistProgress(HMSPlaylistType.audio),
-  currentTime: selectPlaylistCurrentTime(HMSPlaylistType.audio),
-  playbackRate: selectPlaylistPlaybackRate(HMSPlaylistType.audio),
-  volume: selectPlaylistVolume(HMSPlaylistType.audio),
-  list: selectPlaylist(HMSPlaylistType.audio),
-  selectedItem: <any>selectPlaylistSelectedItem(HMSPlaylistType.audio),
-};
-
-export const selectVideoPlaylist: HMSPlaylistSelector = {
-  selection: selectPlaylistSelection(HMSPlaylistType.video),
-  progress: selectPlaylistProgress(HMSPlaylistType.video),
-  currentTime: selectPlaylistCurrentTime(HMSPlaylistType.video),
-  playbackRate: selectPlaylistPlaybackRate(HMSPlaylistType.video),
-  volume: selectPlaylistVolume(HMSPlaylistType.video),
-  list: selectPlaylist(HMSPlaylistType.video),
-  selectedItem: <any>selectPlaylistSelectedItem(HMSPlaylistType.video),
-};

package/src/core/selectors/selectorUtils.ts

@@ -1,63 +0,0 @@
-import { HMSPeer, HMSStore, HMSTrack, HMSTrackID } from '../schema';
-
-type trackCheck = (track: HMSTrack | undefined) => boolean | undefined;
-
-export function getPeerTracksByCondition(
-  tracks: Record<HMSTrackID, HMSTrack>,
-  peer: HMSPeer | null,
-  trackCheckFn: trackCheck = isScreenShare,
-) {
-  let videoTrack = undefined;
-  let audioTrack = undefined;
-  if (peer) {
-    for (let trackID of peer.auxiliaryTracks) {
-      const track = tracks[trackID];
-      if (trackCheckFn(track)) {
-        audioTrack = isAudio(track) ? track : audioTrack;
-        videoTrack = isVideo(track) ? track : videoTrack;
-      }
-    }
-  }
-  return { video: videoTrack, audio: audioTrack };
-}
-
-export function isAudio(track: HMSTrack | undefined) {
-  return track && track.type === 'audio';
-}
-
-export function isVideo(track: HMSTrack | undefined) {
-  return track && track.type === 'video';
-}
-
-export function isScreenShare(track: HMSTrack | undefined) {
-  return track && track.source === 'screen';
-}
-
-export function isAudioPlaylist(track: HMSTrack | undefined) {
-  return track && track.source === 'audioplaylist';
-}
-
-export function isVideoPlaylist(track: HMSTrack | undefined) {
-  return track && track.source === 'videoplaylist';
-}
-
-export function isDegraded(track: HMSTrack | undefined) {
-  return Boolean(track?.degraded);
-}
-
-export function isTrackEnabled(store: HMSStore, trackID?: string) {
-  if (trackID && store.tracks[trackID]) {
-    return store.tracks[trackID].enabled;
-  }
-  return false;
-}
-
-/**
- * Should UI show the video track as enabled
- */
-export function isTrackDisplayEnabled(store: HMSStore, trackID?: string) {
-  if (trackID && store.tracks[trackID]) {
-    return store.tracks[trackID].displayEnabled;
-  }
-  return false;
-}