@webex/plugin-meetings 3.0.0-stream-classes.1 → 3.0.0-stream-classes.2

package/dist/types/annotation/annotation.types.d.ts

@@ -33,7 +33,6 @@ interface IAnnotationChannel {
     acceptRequest: (approval: any) => undefined | Promise<void>;
     declineRequest: (approval: any) => undefined | Promise<void>;
     closeAnnotation: (requestData: RequestData) => undefined | Promise<void>;
-    changeAnnotationOptions: (remoteShareUrl: any, annotationInfo: any) => undefined | Promise<void>;
     approveAnnotation: (requestData: RequestData) => undefined | Promise<void>;
     cancelApproveAnnotation: (requestData: RequestData, approval: any) => undefined | Promise<void>;
     sendStrokeData: (strokeData: StrokeData) => void;

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

@@ -106,13 +106,6 @@ declare class AnnotationChannel extends WebexPlugin implements IAnnotationChanne
      * @returns {void}
      */
     sendStrokeData: (strokeData: StrokeData) => void;
-    /**
-     * Change annotation options
-     * @param {remoteShareUrl} remoteShareUrl
-     * @param {annotationInfo} annotationInfo
-     * @returns {Promise}
-     */
-    changeAnnotationOptions(remoteShareUrl: any, annotationInfo: any): any;
     /**
      * private encrypted the strokes data
      * @param {string} encryptedContent

package/dist/types/breakouts/events.d.ts

@@ -1,2 +1,8 @@
-declare const breakoutEvent: any;
+import { ClientEvent } from '@webex/internal-plugin-metrics';
+declare const breakoutEvent: {
+    onBreakoutMoveRequest: (eventInfo: any, submitClientEvent: any) => void;
+    onBreakoutMoveResponse: (eventInfo: any, submitClientEvent: any) => void;
+    onBreakoutJoinResponse: (eventInfo: any, submitClientEvent: any) => void;
+    postMoveCallAnalyzer: (event: ClientEvent['name'], eventInfo: any, submitClientEvent: any) => void;
+};
 export default breakoutEvent;

package/dist/types/common/queue.d.ts

@@ -1,12 +1,14 @@
 /**
- * Simple queue
+ * Simple queue in which the elements are always sorted
  */
-export default class SimpleQueue {
-    queue: any[];
+export default class SortedQueue<ItemType> {
+    queue: ItemType[];
+    compareFunc: (left: ItemType, right: ItemType) => number;
     /**
-     * @constructs SimpleQueue
+     * @constructs SortedQueue
+     * @param {Function} compareFunc comparison function used for sorting the elements of the queue
      */
-    constructor();
+    constructor(compareFunc: (left: ItemType, right: ItemType) => number);
     /**
      * Removes all of the elements from queue.
      * @returns {undefined}
@@ -17,13 +19,13 @@ export default class SimpleQueue {
      * @param {object} item
      * @returns {undefined}
      */
-    enqueue(item: object): void;
+    enqueue(item: ItemType): void;
     /**
      * Returns and removes the head of the queue.
      * Returns null if the queue is empty.
      * @returns {(object|null)} Queue item or null.
      */
-    dequeue(): any;
+    dequeue(): ItemType;
     /**
      * Returns the number of items in queue.
      * @returns {number}

package/dist/types/constants.d.ts

@@ -218,6 +218,7 @@ export declare const EVENT_TRIGGERS: {
     MEETING_BREAKOUTS_PRE_ASSIGNMENTS_UPDATE: string;
     MEETING_INTERPRETATION_UPDATE: string;
     MEETING_INTERPRETATION_SUPPORT_LANGUAGES_UPDATE: string;
+    MEETING_INTERPRETATION_HANDOFF_REQUESTS_ARRIVED: string;
     MEMBERS_UPDATE: string;
     MEMBERS_CLEAR: string;
     MEMBERS_CONTENT_UPDATE: string;
@@ -254,6 +255,8 @@ export declare const EVENT_TRIGGERS: {
     MEETING_CONTROLS_VIEW_THE_PARTICIPANTS_LIST_UPDATED: string;
     MEETING_CONTROLS_RAISE_HAND_UPDATED: string;
     MEETING_CONTROLS_VIDEO_UPDATED: string;
+    MEETING_LOCUS_URL_UPDATE: string;
+    MEETING_STREAM_PUBLISH_STATE_CHANGED: string;
 };
 export declare const EVENT_TYPES: {
     SELF: string;
@@ -262,6 +265,7 @@ export declare const EVENT_TYPES: {
     REMOTE_AUDIO: string;
     REMOTE_VIDEO: string;
     REMOTE_SHARE: string;
+    REMOTE_SHARE_AUDIO: string;
     ERROR: string;
 };
 export declare const MEETING_REMOVED_REASON: {
@@ -463,7 +467,15 @@ export declare const BREAKOUTS: {
 export declare const INTERPRETATION: {
     EVENTS: {
         SUPPORT_LANGUAGES_UPDATE: string;
+        HANDOFF_REQUESTS_ARRIVED: string;
     };
+    ACTION_TYPE: {
+        OFFERED: string;
+        ACCEPTED: string;
+        REQUESTED: string;
+        DECLINED: string;
+    };
+    RESOURCE_TYPE: string;
 };
 export declare const LOCUSINFO: {
     EVENTS: {
@@ -635,6 +647,27 @@ export declare const MEETING_END_REASON: {
     INACTIVE: string;
     MEDIA_RELEASED: string;
 };
+export declare enum SELF_POLICY {
+    ENFORCE_VIRTUAL_BACKGROUND = "enforceVirtualBackground",
+    SUPPORT_LOCAL_RECORD = "supportLocalRecord",
+    SUPPORT_NETWORK_BASED_RECORD = "supportNetworkBasedRecord",
+    SUPPORT_REALTIME_CLOSE_CAPTION = "supportRealtimeCloseCaption",
+    SUPPORT_CHAT = "supportChat",
+    SUPPORT_DESKTOP_SHARE_REMOTE = "supportDesktopShareRemote",
+    SUPPORT_DESKTOP_SHARE = "supportDesktopShare",
+    SUPPORT_WHITEBOARD = "supportWhiteboard",
+    SUPPORT_FILE_TRANSFER = "supportFileTransfer",
+    SUPPORT_APP_SHARE = "supportAppShare",
+    SUPPORT_CAMERA_SHARE = "supportCameraShare",
+    SUPPORT_FILE_SHARE = "supportFileShare",
+    SUPPORT_ANNOTATION = "supportAnnotation",
+    SUPPORT_BROADCAST_MESSAGE = "supportBroadcastMessage",
+    SUPPORT_VIDEO = "supportVideo",
+    SUPPORT_HQV = "supportHQV",
+    SUPPORT_HDV = "supportHDV",
+    SUPPORT_PARTICIPANT_LIST = "supportParticipantList",
+    SUPPORT_VOIP = "supportVoIP"
+}
 export declare const DISPLAY_HINTS: {
     ADD_GUEST: string;
     ROSTER_WAITING_TO_JOIN: string;
@@ -694,7 +727,10 @@ export declare const DISPLAY_HINTS: {
     SHARE_CAMERA: string;
     SHARE_DESKTOP: string;
     SHARE_CONTENT: string;
+    SHARE_WHITEBOARD: string;
+    VOIP_IS_ENABLED: string;
 };
+export declare const INTERSTITIAL_DISPLAY_HINTS: string[];
 export declare const SELF_ROLES: {
     COHOST: string;
     MODERATOR: string;
@@ -949,7 +985,6 @@ export declare const MEDIA_DEVICES: {
     SPEAKER: string;
     CAMERA: string;
 };
-export declare const METRICS_JOIN_TIMES_MAX_DURATION = 1200000;
 export declare const PSTN_STATUS: {
     JOINED: string;
     CONNECTED: string;
@@ -985,3 +1020,11 @@ export declare const DEFAULT_MEETING_INFO_REQUEST_BODY: {
     supportHostKey: boolean;
     supportCountryList: boolean;
 };
+/** the values for IP_VERSION are fixed and defined in Orpheus API */
+export declare const IP_VERSION: {
+    readonly unknown: 0;
+    readonly only_ipv4: 4;
+    readonly only_ipv6: 6;
+    readonly ipv4_and_ipv6: 1;
+};
+export type IP_VERSION = (typeof IP_VERSION)[keyof typeof IP_VERSION];

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import Meetings from './meetings';
-export { getDevices, LocalTrack, LocalDisplayTrack, LocalTrackEvents, type TrackMuteEvent, type ServerMuteReason, LocalMicrophoneTrackEvents, LocalCameraTrackEvents, LocalMicrophoneTrack, LocalCameraTrack, createMicrophoneTrack, createCameraTrack, createDisplayTrack, } from '@webex/media-helpers';
+export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, type ServerMuteReason, LocalMicrophoneStreamEventNames, LocalCameraStreamEventNames, LocalMicrophoneStream, LocalCameraStream, createMicrophoneStream, createCameraStream, createDisplayStream, createDisplayStreamWithAudio, FacingMode, DisplaySurface, PresetCameraConstraints, type VideoContentHint, } from '@webex/media-helpers';
 export default Meetings;
 export * as CONSTANTS from './constants';
 export * as REACTIONS from './reactions/reactions';

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

@@ -38,12 +38,19 @@ export default class LocusInfo extends EventsScope {
     mainSessionLocusCache: any;
     /**
      * Constructor
-     * @param {boolean} updateMeeting true if the meeting should be updated
+     * @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

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

@@ -1,14 +1,25 @@
+/// <reference types="node" />
+import SortedQueue from '../common/queue';
+type LocusDeltaDto = {
+    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,23 @@ export default class Parser {
         DESYNC: string;
         USE_INCOMING: string;
         USE_CURRENT: string;
+        WAIT: string;
         ERROR: string;
     };
-    queue: any;
+    queue: SortedQueue<LocusDeltaDto>;
     workingCopy: any;
+    syncTimer: null | number | NodeJS.Timeout;
     /**
      * @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 +100,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 +225,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 +268,4 @@ export default class Parser {
      */
     static getDebugMessage(debugCode: string, comparison: string): any;
 }
+export {};

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

@@ -1,8 +1,8 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-import { MultistreamRoapMediaConnection } from '@webex/internal-media-core';
-export type BundlePolicy = ConstructorParameters<typeof MultistreamRoapMediaConnection>[0]['bundlePolicy'];
+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,4 +1,4 @@
-import { LocalCameraTrack, LocalMicrophoneTrack, LocalDisplayTrack } from '@webex/media-helpers';
+import { LocalCameraStream, LocalMicrophoneStream, LocalDisplayStream, LocalSystemAudioStream, RemoteStream } from '@webex/media-helpers';
 export type MediaDirection = {
     sendAudio: boolean;
     sendVideo: boolean;
@@ -11,17 +11,18 @@ export type MediaDirection = {
  * @class MediaProperties
  */
 export default class MediaProperties {
-    audioTrack?: LocalMicrophoneTrack;
+    audioStream?: LocalMicrophoneStream;
     mediaDirection: MediaDirection;
     mediaSettings: any;
     webrtcMediaConnection: any;
-    remoteAudioTrack: any;
+    remoteAudioStream: RemoteStream;
     remoteQualityLevel: any;
-    remoteShare: any;
-    remoteVideoTrack: any;
-    shareTrack?: LocalDisplayTrack;
+    remoteShareStream: RemoteStream;
+    remoteVideoStream: RemoteStream;
+    shareVideoStream?: LocalDisplayStream;
+    shareAudioStream?: LocalSystemAudioStream;
     videoDeviceId: any;
-    videoTrack?: LocalCameraTrack;
+    videoStream?: LocalCameraStream;
     namespace: string;
     /**
      * @param {Object} [options] -- to auto construct
@@ -36,23 +37,24 @@ export default class MediaProperties {
     setMediaDirection(mediaDirection: any): void;
     setMediaSettings(type: any, values: any): void;
     setMediaPeerConnection(mediaPeerConnection: any): void;
-    setLocalVideoTrack(videoTrack?: LocalCameraTrack): void;
-    setLocalAudioTrack(audioTrack?: LocalMicrophoneTrack): void;
-    setLocalShareTrack(shareTrack?: LocalDisplayTrack): 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
@@ -65,12 +67,17 @@ export default class MediaProperties {
      * @returns {void}
      */
     unsetRemoteMedia(): void;
-    unsetRemoteShare(): void;
+    unsetRemoteShareStream(): void;
     /**
-     * Unsets all remote tracks
+     * Unsets all remote streams
      * @returns {void}
      */
-    unsetRemoteTracks(): void;
+    unsetRemoteStreams(): void;
+    /**
+     * Returns if we have at least one local share stream or not.
+     * @returns {Boolean}
+     */
+    hasLocalShareStream(): boolean;
     /**
      * Waits for the webrtc media connection to be connected.
      *

package/dist/types/meeting/in-meeting-actions.d.ts

@@ -67,6 +67,13 @@ interface IInMeetingActions {
     canShareCamera?: boolean;
     canShareDesktop?: boolean;
     canShareContent?: boolean;
+    canTransferFile?: boolean;
+    canDoVideo?: boolean;
+    canAnnotate?: boolean;
+    canUseVoip?: boolean;
+    supportHQV?: boolean;
+    supportHDV?: boolean;
+    canShareWhiteBoard?: boolean;
 }
 /**
  * @class InMeetingActions
@@ -134,6 +141,13 @@ export default class InMeetingActions implements IInMeetingActions {
     canShareCamera: any;
     canShareDesktop: any;
     canShareContent: any;
+    canTransferFile: any;
+    canDoVideo: any;
+    canAnnotate: any;
+    canUseVoip: any;
+    supportHQV: any;
+    supportHDV: any;
+    canShareWhiteBoard: any;
     /**
      * Returns all meeting action options
      * @returns {Object}