@webex/plugin-meetings 3.0.0-beta.39 → 3.0.0-beta.391

package/dist/types/locus-info/index.d.ts

@@ -30,11 +30,27 @@ export default class LocusInfo extends EventsScope {
     fullState: any;
     host: any;
     info: any;
+    roles: any;
     mediaShares: any;
     replace: any;
     url: any;
     services: any;
+    mainSessionLocusCache: any;
+    /**
+     * Constructor
+     * @param {function} updateMeeting callback to update the meeting object from an object
+     * @param {object} webex
+     * @param {string} meetingId
+     * @returns {undefined}
+     */
     constructor(updateMeeting: any, webex: any, meetingId: any);
+    /**
+     * Does a Locus sync. It tries to get the latest delta DTO or if it can't, it falls back to getting the full Locus DTO.
+     *
+     * @param {Meeting} meeting
+     * @returns {undefined}
+     */
+    private doLocusSync;
     /**
      * Apply locus delta data to meeting
      * @param {string} action Locus delta action
@@ -139,19 +155,20 @@ export default class LocusInfo extends EventsScope {
      */
     updateParticipantDeltas(participants?: Array<any>): void;
     /**
-     *
+     * update meeting's members
      * @param {Object} participants new participants object
-     * @param {boolen} deltaParticpantFlag  delta event
+     * @param {Boolean} isReplace is replace the whole members
      * @returns {Array} updatedParticipants
      * @memberof LocusInfo
      */
-    updateParticipants(participants: object): void;
+    updateParticipants(participants: object, isReplace?: boolean): void;
     /**
      * @param {Object} controls
+     * @param {Object} self
      * @returns {undefined}
      * @memberof LocusInfo
      */
-    updateControls(controls: object): void;
+    updateControls(controls: object, self: object): void;
     /**
      * @param {String} conversationUrl
      * @param {Object} info
@@ -266,4 +283,40 @@ export default class LocusInfo extends EventsScope {
      * @memberof LocusInfo
      */
     updateIdentifiers(identities: Array<any>): void;
+    /**
+     * check the locus is main session's one or not, if is main session's, update main session cache
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateLocusCache(locus: any): void;
+    /**
+     * if return from breakout to main session, need to use cached main session DTO since locus won't send the full locus (participants)
+     * if join breakout from main session, main session is not active for the attendee and remove main session locus cache
+     * @param {Object} newLocus
+     * @returns {Object}
+     * @memberof LocusInfo
+     */
+    getTheLocusToUpdate(newLocus: any): any;
+    /**
+     * merge participants by participant id
+     * @param {Array} participants
+     * @param {Array} sourceParticipants
+     * @returns {Array} merged participants
+     * @memberof LocusInfo
+     */
+    mergeParticipants(participants: any, sourceParticipants: any): any;
+    /**
+     * need cache main sessions' participants since locus will not send the full list when cohost/host leave breakout
+     * @param {Object} mainLocus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateMainSessionLocusCache(mainLocus: any): void;
+    /**
+     * clear main session cache
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    clearMainSessionLocusCache(): void;
 }

package/dist/types/locus-info/parser.d.ts

@@ -1,14 +1,25 @@
+import SortedQueue from '../common/queue';
+type LocusDeltaDto = {
+    url: string;
+    baseSequence: {
+        rangeStart: number;
+        rangeEnd: number;
+        entries: number[];
+    };
+    sequence: {
+        rangeStart: number;
+        rangeEnd: number;
+        entries: number[];
+    };
+    syncUrl: string;
+};
 /**
  * Locus Delta Parser
  * @private
  * https://sqbu-github.cisco.com/WebExSquared/cloud-apps/wiki/Locus-Delta-Events
  */
 export default class Parser {
-    static status: {
-        IDLE: string;
-        PAUSED: string;
-        WORKING: string;
-    };
+    status: 'IDLE' | 'PAUSED' | 'WORKING' | 'BLOCKED';
     static loci: {
         EQ: string;
         GT: string;
@@ -16,14 +27,24 @@ export default class Parser {
         DESYNC: string;
         USE_INCOMING: string;
         USE_CURRENT: string;
+        WAIT: string;
         ERROR: string;
+        LOCUS_URL_CHANGED: string;
     };
-    queue: any;
+    queue: SortedQueue<LocusDeltaDto>;
     workingCopy: any;
+    syncTimer?: ReturnType<typeof setTimeout>;
     /**
      * @constructs Parser
      */
     constructor();
+    /**
+     * Returns a debug string representing a locus delta - useful for logging
+     *
+     * @param {LocusDeltaDto} locus Locus delta
+     * @returns {string}
+     */
+    static locus2string(locus: LocusDeltaDto): string;
     /**
      * Checks if two sequences overlap in time,
      * the sequence with the higher minimum value is greater.
@@ -80,6 +101,21 @@ export default class Parser {
      * @returns {string} loci comparison state
      */
     private static compareDelta;
+    /**
+     * Compares Locus sequences - it should be called only for full Locus DTOs, not deltas
+     *
+     * @param {Types~Locus} current Current working copy
+     * @param {Types~Locus} incomingFullDto New Full Locus DTO
+     * @returns {string} either Parser.loci.USE_INCOMING or Parser.loci.USE_CURRENT
+     */
+    static compareFullDtoSequence(current: any, incomingFullDto: any): string;
+    /**
+     * Returns true if the incoming full locus DTO is newer than the current working copy
+     *
+     * @param {Types~Locus} incomingFullDto New Full Locus DTO
+     * @returns {string} either Parser.loci.USE_INCOMING or Parser.loci.USE_CURRENT
+     */
+    isNewFullLocus(incomingFullDto: any): boolean;
     /**
      * Compares Locus sequences
      * @param {Types~Locus} current Current working copy
@@ -190,6 +226,29 @@ export default class Parser {
      * @returns {undefined}
      */
     pause(): void;
+    /**
+     * Triggers a sync with Locus
+     *
+     * @param {string} reason used just for logging
+     * @returns {undefined}
+     */
+    private triggerSync;
+    /**
+     * Starts a timer with a random delay. When that timer expires we will do a sync.
+     *
+     * The main purpose of this timer is to handle a case when we get some out-of-order deltas,
+     * so we start waiting to receive the missing delta. If that delta never arrives, this timer
+     * will trigger a sync with Locus.
+     *
+     * @returns {undefined}
+     */
+    private startSyncTimer;
+    /**
+     * Stops the timer for triggering a sync
+     *
+     * @returns {undefined}
+     */
+    private stopSyncTimer;
     /**
      * Processes next locus delta in the queue,
      * continues until the queue is empty
@@ -210,3 +269,4 @@ export default class Parser {
      */
     static getDebugMessage(debugCode: string, comparison: string): any;
 }
+export {};

package/dist/types/media/index.d.ts

@@ -1,6 +1,8 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+import { type MultistreamConnectionConfig } from '@webex/internal-media-core';
+export type BundlePolicy = MultistreamConnectionConfig['bundlePolicy'];
 /**
  * MediaDirection
  * @typedef {Object} MediaDirection

package/dist/types/media/properties.d.ts

@@ -1,26 +1,34 @@
-import { LocalCameraTrack, LocalMicrophoneTrack, LocalDisplayTrack } from '@webex/internal-media-core';
+import { LocalCameraStream, LocalMicrophoneStream, LocalDisplayStream, LocalSystemAudioStream, RemoteStream } from '@webex/media-helpers';
+export type MediaDirection = {
+    sendAudio: boolean;
+    sendVideo: boolean;
+    sendShare: boolean;
+    receiveAudio: boolean;
+    receiveVideo: boolean;
+    receiveShare: boolean;
+};
 /**
  * @class MediaProperties
  */
 export default class MediaProperties {
-    audioTrack: LocalMicrophoneTrack | null;
-    localQualityLevel: any;
-    mediaDirection: any;
+    audioStream?: LocalMicrophoneStream;
+    mediaDirection: MediaDirection;
     mediaSettings: any;
     webrtcMediaConnection: any;
-    remoteAudioTrack: any;
+    remoteAudioStream: RemoteStream;
     remoteQualityLevel: any;
-    remoteShare: any;
-    remoteVideoTrack: any;
-    shareTrack: LocalDisplayTrack | null;
+    remoteShareStream: RemoteStream;
+    remoteVideoStream: RemoteStream;
+    shareVideoStream?: LocalDisplayStream;
+    shareAudioStream?: LocalSystemAudioStream;
     videoDeviceId: any;
-    videoTrack: LocalCameraTrack | null;
+    videoStream?: LocalCameraStream;
     namespace: string;
     /**
      * @param {Object} [options] -- to auto construct
      * @returns {MediaProperties}
      */
-    constructor(options?: any);
+    constructor();
     /**
      * Retrieves the preferred video input device
      * @returns {Object|null}
@@ -29,24 +37,24 @@ export default class MediaProperties {
     setMediaDirection(mediaDirection: any): void;
     setMediaSettings(type: any, values: any): void;
     setMediaPeerConnection(mediaPeerConnection: any): void;
-    setLocalVideoTrack(videoTrack: LocalCameraTrack | null): void;
-    setLocalAudioTrack(audioTrack: LocalMicrophoneTrack | null): void;
-    setLocalQualityLevel(localQualityLevel: any): void;
-    setLocalShareTrack(shareTrack: LocalDisplayTrack | null): void;
+    setLocalVideoStream(videoStream?: LocalCameraStream): void;
+    setLocalAudioStream(audioStream?: LocalMicrophoneStream): void;
+    setLocalShareVideoStream(shareVideoStream?: LocalDisplayStream): void;
+    setLocalShareAudioStream(shareAudioStream?: LocalSystemAudioStream): void;
     setRemoteQualityLevel(remoteQualityLevel: any): void;
-    setRemoteShare(remoteShare: any): void;
+    setRemoteShareStream(remoteShareStream: RemoteStream): void;
     /**
-     * Sets the remote audio track
-     * @param {MediaTrack} remoteAudioTrack MediaTrack to save
+     * Sets the remote audio stream
+     * @param {RemoteStream} remoteAudioStream RemoteStream to save
      * @returns {void}
      */
-    setRemoteAudioTrack(remoteAudioTrack: any): void;
+    setRemoteAudioStream(remoteAudioStream: RemoteStream): void;
     /**
-     * Sets the remote video track
-     * @param {MediaTrack} remoteVideoTrack MediaTrack to save
+     * Sets the remote video stream
+     * @param {RemoteStream} remoteVideoStream RemoteStream to save
      * @returns {void}
      */
-    setRemoteVideoTrack(remoteVideoTrack: any): void;
+    setRemoteVideoStream(remoteVideoStream: RemoteStream): void;
     /**
      * Stores the preferred video input device
      * @param {string} deviceId Preferred video input device
@@ -54,45 +62,22 @@ export default class MediaProperties {
      */
     setVideoDeviceId(deviceId: string): void;
     unsetPeerConnection(): void;
-    unsetLocalVideoTrack(): void;
-    unsetLocalShareTrack(): void;
-    unsetLocalAudioTrack(): void;
-    /**
-     * Removes remote stream from class instance
-     * @deprecated after v1.89.3
-     * @returns {void}
-     */
-    unsetRemoteStream(): void;
     /**
      * Removes both remote audio and video from class instance
      * @returns {void}
      */
     unsetRemoteMedia(): void;
-    unsetRemoteShare(): void;
-    unsetLocalVideoTracks(): void;
+    unsetRemoteShareStream(): void;
     /**
-     * Removes remote stream and remote share from class instance
-     * @deprecated after v1.89.3
+     * Unsets all remote streams
      * @returns {void}
      */
     unsetRemoteStreams(): void;
     /**
-     * Unsets all remote tracks
-     * @returns {void}
-     */
-    unsetRemoteTracks(): void;
-    unsetShareStreams(): void;
-    /**
-     * Removes both local and remote video stream from class instance
-     * @deprecated after v1.89.3
-     * @returns {void}
-     */
-    unsetMediaStreams(): void;
-    /**
-     * Removes both local and remote video stream from class instance
-     * @returns {void}
+     * Returns if we have at least one local share stream or not.
+     * @returns {Boolean}
      */
-    unsetMediaTracks(): void;
+    hasLocalShareStream(): boolean;
     /**
      * Waits for the webrtc media connection to be connected.
      *