@webex/plugin-meetings 3.8.1 → 3.9.0

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

@@ -21,6 +21,8 @@ import RecordingController from '../recording-controller';
 import ControlsOptionsManager from '../controls-options-manager';
 import { LocusMediaRequest } from './locusMediaRequest';
 import { BrbState } from './brbState';
+import { SetStageOptions } from './request.type';
+import { Invitee } from './type';
 export type CaptionData = {
     id: string;
     isFinal: boolean;
@@ -66,6 +68,13 @@ export type AddMediaOptions = {
     remoteMediaManagerConfig?: RemoteMediaManagerConfiguration;
     bundlePolicy?: BundlePolicy;
     allowMediaInLobby?: boolean;
+    additionalMediaOptions?: AdditionalMediaOptions;
+};
+export type AdditionalMediaOptions = {
+    sendVideo?: boolean;
+    receiveVideo?: boolean;
+    sendAudio?: boolean;
+    receiveAudio?: boolean;
 };
 export type CallStateForMetrics = {
     correlationId?: string;
@@ -74,6 +83,7 @@ export type CallStateForMetrics = {
     loginType?: string;
     userNameInput?: string;
     emailInput?: string;
+    pstnCorrelationId?: string;
 };
 export declare const MEDIA_UPDATE_TYPE: {
     TRANSCODED_MEDIA_CONNECTION: string;
@@ -479,10 +489,11 @@ export default class Meeting extends StatelessWebexPlugin {
     /**
      * @param {Object} attrs
      * @param {Object} options
+     * @param {Function} callback - if provided, it will be called with the newly created meeting object as soon as the meeting.id is set
      * @constructor
      * @memberof Meeting
      */
-    constructor(attrs: any, options: object);
+    constructor(attrs: any, options: object, callback: (meeting: Meeting) => void);
     /**
      * returns meeting is joined
      * @private
@@ -505,6 +516,16 @@ export default class Meeting extends StatelessWebexPlugin {
      * @param {string} correlationId
      */
     set correlationId(correlationId: string);
+    /**
+     * Getter - Returns callStateForMetrics.pstnCorrelationId
+     * @returns {string | undefined}
+     */
+    get pstnCorrelationId(): string | undefined;
+    /**
+     * Setter - sets callStateForMetrics.pstnCorrelationId
+     * @param {string | undefined} correlationId
+     */
+    set pstnCorrelationId(correlationId: string | undefined);
     /**
      * Getter - Returns callStateForMetrics.userNameInput
      * @returns {string}
@@ -854,43 +875,37 @@ export default class Meeting extends StatelessWebexPlugin {
     private updateMeetingObject;
     /**
      * Invite a guest to the call that isn't normally part of this call
-     * @param {Object} invitee
+     * @param {Invitee} invitee
      * @param {String} invitee.emailAddress
      * @param {String} invitee.email
      * @param {String} invitee.phoneNumber
      * @param {Boolean} [alertIfActive]
+     * @param {Boolean} [invitee.skipEmailValidation]
+     * @param {Boolean} [invitee.isInternalNumber]
      * @returns {Promise} see #members.addMember
      * @public
      * @memberof Meeting
      */
-    invite(invitee: {
-        emailAddress: string;
-        email: string;
-        phoneNumber: string;
-        roles: Array<string>;
-    }, alertIfActive?: boolean): any;
+    invite(invitee: Invitee, alertIfActive?: boolean): any;
     /**
      * Cancel an outgoing phone call invitation made during a meeting
-     * @param {Object} invitee
+     * @param {Invitee} invitee
      * @param {String} invitee.phoneNumber
      * @returns {Promise} see #members.cancelPhoneInvite
      * @public
      * @memberof Meeting
      */
-    cancelPhoneInvite(invitee: {
-        phoneNumber: string;
-    }): any;
+    cancelPhoneInvite(invitee: Invitee): any;
     /**
-     * Cancel an SIP call invitation made during a meeting
-     * @param {Object} invitee
+     * Cancel an SIP/phone call invitation made during a meeting
+     * @param {Invitee} invitee
      * @param {String} invitee.memberId
-     * @returns {Promise} see #members.cancelSIPInvite
+     * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
+     * @returns {Promise} see #members.cancelInviteByMemberId
      * @public
      * @memberof Meeting
      */
-    cancelSIPInvite(invitee: {
-        memberId: string;
-    }): any;
+    cancelInviteByMemberId(invitee: Invitee): any;
     /**
      * Admit the guest(s) to the call once they are waiting.
      * If the host/cohost is in a breakout session, the locus url
@@ -1337,7 +1352,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      * @returns {Promise}
      */
-    disconnectPhoneAudio(): Promise<[any, any]>;
+    disconnectPhoneAudio(): Promise<void>;
     /**
      * Moves the call to the specified resourceId
      * @param {String} resourceId
@@ -1993,5 +2008,18 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {Promise<MediaReachabilityMetrics>}
      */
     private getMediaReachabilityMetricFields;
+    /**
+     * Set the stage for the meeting
+     *
+     * @param {SetStageOptions} options Options to use when setting the stage
+     * @returns {Promise} The locus request
+     */
+    setStage({ activeSpeakerProportion, customBackground, customLogo, customNameLabel, importantParticipants, lockAttendeeViewOnStage, showActiveSpeaker, }?: SetStageOptions): Promise<any>;
+    /**
+     * Unset the stage for the meeting
+     *
+     * @returns {Promise} The locus request
+     */
+    unsetStage(): Promise<any>;
 }
 export {};

package/dist/types/meeting/request.d.ts

@@ -1,5 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
-import { SendReactionOptions, BrbOptions, ToggleReactionsOptions, PostMeetingDataConsentOptions } from './request.type';
+import { SendReactionOptions, BrbOptions, ToggleReactionsOptions, PostMeetingDataConsentOptions, SynchronizeVideoLayout } from './request.type';
 import { AnnotationInfo } from '../annotation/annotation.types';
 import { ClientMediaPreferences } from '../reachability/reachability.types';
 /**
@@ -314,4 +314,12 @@ export default class MeetingRequest extends StatelessWebexPlugin {
      * @returns {Promise}
      */
     setPostMeetingDataConsent({ postMeetingDataConsent, locusUrl, deviceUrl, selfId, }: PostMeetingDataConsentOptions): Promise<any>;
+    /**
+     * Synchronize the stage for a meeting
+     *
+     * @param {LocusUrl} locusUrl The locus URL
+     * @param {SetStageVideoLayout} videoLayout The video layout to synchronize
+     * @returns {Promise} The locus request
+     */
+    synchronizeStage(locusUrl: string, videoLayout: SynchronizeVideoLayout): Promise<any>;
 }

package/dist/types/meeting/request.type.d.ts

@@ -21,3 +21,77 @@ export type PostMeetingDataConsentOptions = {
     deviceUrl: string;
     selfId: string;
 };
+export type StageCustomLogoPositions = 'LowerLeft' | 'LowerMiddle' | 'LowerRight' | 'UpperLeft' | 'UpperMiddle' | 'UpperRight';
+export type StageNameLabelType = 'Primary' | 'PrimaryInverted' | 'Secondary' | 'SecondaryInverted';
+export type StageCustomBackground = {
+    url: string;
+    [others: string]: unknown;
+};
+export type StageCustomLogo = {
+    url: string;
+    position: StageCustomLogoPositions;
+    [others: string]: unknown;
+};
+export type StageCustomNameLabel = {
+    accentColor: string;
+    background: {
+        color: string;
+    };
+    border: {
+        color: string;
+    };
+    content: {
+        displayName: {
+            color: string;
+        };
+        subtitle: {
+            color: string;
+        };
+    };
+    decoration: {
+        color: string;
+    };
+    fadeOut?: {
+        delay: number;
+    };
+    type: StageNameLabelType;
+    [others: string]: unknown;
+};
+export type SetStageOptions = {
+    activeSpeakerProportion?: number;
+    customBackground?: StageCustomBackground;
+    customLogo?: StageCustomLogo;
+    customNameLabel?: StageCustomNameLabel;
+    importantParticipants?: {
+        mainCsi: number;
+        participantId: string;
+    }[];
+    lockAttendeeViewOnStage?: boolean;
+    showActiveSpeaker?: boolean;
+};
+export type SetStageVideoLayout = {
+    overrideDefault: true;
+    lockAttendeeViewOnStageOnly: boolean;
+    stageParameters: {
+        importantParticipants?: {
+            participantId: string;
+            mainCsi: number;
+            order: number;
+        }[];
+        showActiveSpeaker: {
+            show: boolean;
+            order: number;
+        };
+        activeSpeakerProportion: number;
+        stageManagerType: number;
+    };
+    customLayouts?: {
+        background?: StageCustomBackground;
+        logo?: StageCustomLogo;
+    };
+    nameLabelStyle?: StageCustomNameLabel;
+};
+export type UnsetStageVideoLayout = {
+    overrideDefault: false;
+};
+export type SynchronizeVideoLayout = SetStageVideoLayout | UnsetStageVideoLayout;

package/dist/types/meeting/type.d.ts

@@ -0,0 +1,9 @@
+export type Invitee = {
+    memberId: string;
+    emailAddress: string;
+    email: string;
+    phoneNumber: string;
+    roles: Array<string>;
+    skipEmailValidation?: boolean;
+    isInternalNumber?: boolean;
+};

package/dist/types/meeting/util.d.ts

@@ -71,6 +71,9 @@ declare const MeetingUtil: {
     canStopTranscribing: (displayHints: any) => any;
     isClosedCaptionActive: (displayHints: any) => any;
     canStartManualCaption: (displayHints: any) => any;
+    isLocalRecordingStarted: (displayHints: any) => any;
+    isLocalRecordingStopped: (displayHints: any) => any;
+    isLocalRecordingPaused: (displayHints: any) => any;
     canStopManualCaption: (displayHints: any) => any;
     isManualCaptionActive: (displayHints: any) => any;
     isWebexAssistantActive: (displayHints: any) => any;

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

@@ -4,6 +4,7 @@ import MembersCollection from './collection';
 import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
 import { MediaRequestManager } from '../multistream/mediaRequestManager';
 import { ServerRoleShape } from './types';
+import { Invitee } from '../meeting/type';
 /**
  * @class Members
  */
@@ -212,26 +213,28 @@ export default class Members extends StatelessWebexPlugin {
     private update;
     /**
      * Adds a guest Member to the associated meeting
-     * @param {String} invitee
+     * @param {Invitee} invitee
      * @param {Boolean} [alertIfActive]
      * @returns {Promise}
      * @memberof Members
      */
-    addMember(invitee: any, alertIfActive?: boolean): any;
+    addMember(invitee: Invitee, alertIfActive?: boolean): any;
     /**
      * Cancels an outgoing PSTN call to the associated meeting
-     * @param {String} invitee
+     * @param {Invitee} invitee
      * @returns {Promise}
      * @memberof Members
      */
-    cancelPhoneInvite(invitee: any): any;
+    cancelPhoneInvite(invitee: Invitee): any;
     /**
-     * Cancels an SIP call to the associated meeting
-     * @param {String} invitee
+     * Cancels an SIP/phone call to the associated meeting
+     * @param {Invitee} invitee
+     * @param {String} invitee.memberId - The memberId of the invitee
+     * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
      * @returns {Promise}
      * @memberof Members
      */
-    cancelSIPInvite(invitee: any): any;
+    cancelInviteByMemberId(invitee: Invitee): any;
     /**
      * Admits waiting members (invited guests to meeting)
      * @param {Array} memberIds

package/dist/types/members/request.d.ts

@@ -136,5 +136,5 @@ export default class MembersRequest extends StatelessWebexPlugin {
      * @throws {Error} if the options are not valid and complete, must have invitee with memberId AND locusUrl
      * @memberof MembersRequest
      */
-    cancelSIPInvite(options: any): Promise<any>;
+    cancelInviteByMemberId(options: any): Promise<any>;
 }

package/dist/types/members/util.d.ts

@@ -1,4 +1,5 @@
 import { RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape } from './types';
+import { Invitee } from '../meeting/type';
 declare const MembersUtil: {
     /**
      * @param {Object} invitee with emailAddress, email or phoneNumber
@@ -26,6 +27,7 @@ declare const MembersUtil: {
      */
     getAddMemberBody: (options: any) => {
         invitees: {
+            isInternalNumber?: any;
             roles?: any;
             address: any;
         }[];
@@ -55,13 +57,14 @@ declare const MembersUtil: {
         uri: any;
         body: {
             invitees: {
+                isInternalNumber?: any;
                 roles?: any;
                 address: any;
             }[];
             alertIfActive: any;
         };
     };
-    isInvalidInvitee: (invitee: any) => boolean;
+    isInvalidInvitee: (invitee: Invitee) => boolean;
     getRemoveMemberRequestParams: (options: any) => {
         method: string;
         uri: string;
@@ -228,16 +231,17 @@ declare const MembersUtil: {
             }[];
         };
     };
-    cancelSIPInviteOptions: (invitee: any, locusUrl: any) => {
+    cancelInviteByMemberIdOptions: (invitee: any, locusUrl: any) => {
         invitee: any;
         locusUrl: any;
     };
-    generateCancelSIPInviteRequestParams: (options: any) => {
+    generateCancelInviteByMemberIdRequestParams: (options: any) => {
         method: string;
         uri: any;
         body: {
             actionType: string;
             invitees: {
+                isInternalNumber?: any;
                 address: any;
             }[];
         };

package/dist/types/metrics/constants.d.ts

@@ -69,6 +69,7 @@ declare const BEHAVIORAL_METRICS: {
     MEETING_INFO_POLICY_ERROR: string;
     LOCUS_DELTA_SYNC_FAILED: string;
     LOCUS_DELTA_OUT_OF_ORDER: string;
+    LOCUS_SYNC_HANDLING_FAILED: string;
     PERMISSION_TOKEN_REFRESH: string;
     PERMISSION_TOKEN_REFRESH_ERROR: string;
     TURN_DISCOVERY_LATENCY: string;

package/dist/types/multistream/remoteMedia.d.ts

@@ -7,9 +7,17 @@ export declare const RemoteMediaEvents: {
     Stopped: string;
 };
 export type RemoteVideoResolution = 'thumbnail' | 'very small' | 'small' | 'medium' | 'large' | 'best';
+export declare const MAX_FS_VALUES: {
+    '90p': number;
+    '180p': number;
+    '360p': number;
+    '540p': number;
+    '720p': number;
+    '1080p': number;
+};
 /**
  * Converts pane size into h264 maxFs
- * @param {PaneSize} paneSize
+ * @param {RemoteVideoResolution} paneSize
  * @returns {number}
  */
 export declare function getMaxFs(paneSize: RemoteVideoResolution): number;
@@ -29,6 +37,12 @@ export declare class RemoteMedia extends EventsScope {
     private readonly options;
     private mediaRequestId?;
     readonly id: RemoteMediaId;
+    /**
+     * The max frame size of the media request, used for logging and media requests.
+     * Set by setSizeHint() based on video element dimensions.
+     * When > 0, this value takes precedence over options.resolution in sendMediaRequest().
+     */
+    private maxFrameSize;
     /**
      * Constructs RemoteMedia instance
      *
@@ -45,6 +59,11 @@ export declare class RemoteMedia extends EventsScope {
      * @note width/height of 0 will be ignored
      */
     setSizeHint(width: any, height: any): void;
+    /**
+     * Get the current effective maxFs value that would be used in media requests
+     * @returns {number | undefined} The maxFs value, or undefined if no constraints
+     */
+    getEffectiveMaxFs(): number | undefined;
     /**
      * registers event listeners on the receive slot and forwards all the events
      */

package/dist/types/multistream/remoteMediaGroup.d.ts

@@ -45,5 +45,16 @@ export declare class RemoteMediaGroup {
      * @returns true if remote media is found
      */
     includes(remoteMedia: RemoteMedia, filter?: 'all' | 'pinned' | 'unpinned'): boolean;
+    /**
+     * Calculate the effective maxFs for the active speaker media request based on unpinned RemoteMedia instances
+     * @returns {number | undefined} The calculated maxFs value, or undefined if no constraints
+     * @private
+     */
+    private getEffectiveMaxFsForActiveSpeaker;
+    /**
+     * Get the current effective maxFs that would be used for the active speaker media request
+     * @returns {number | undefined} The effective maxFs value
+     */
+    getEffectiveMaxFs(): number | undefined;
 }
 export {};

package/dist/types/multistream/sendSlotManager.d.ts

@@ -1,7 +1,17 @@
 import { SendSlot, MediaType, LocalStream, MultistreamRoapMediaConnection, NamedMediaGroup, StreamState } from '@webex/internal-media-core';
+/**
+ * This class is used to manage the sendSlots for the given media types.
+ */
 export default class SendSlotManager {
     private readonly slots;
     private readonly LoggerProxy;
+    private readonly sourceStateOverrides;
+    /**
+     * Constructor for SendSlotManager
+     *
+     * @param {any} LoggerProxy is used to log the messages
+     * @constructor
+     */
     constructor(LoggerProxy: any);
     /**
      * This method is used to create a sendSlot for the given mediaType and returns the created sendSlot
@@ -32,6 +42,12 @@ export default class SendSlotManager {
      * @returns {void}
      */
     setSourceStateOverride(mediaType: MediaType, state: StreamState | null): void;
+    /**
+     * Gets the source state override for the given media type.
+     * @param {MediaType} mediaType - The type of media to get the source state override for.
+     * @returns {StreamState | null} - The current source state override or null if not set.
+     */
+    private getSourceStateOverride;
     /**
      * This method publishes the given stream to the sendSlot for the given mediaType
      * @param {MediaType} mediaType MediaType of the sendSlot to which a stream needs to be published (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)

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

@@ -68,12 +68,12 @@ export default class Reachability extends EventsScope {
     }>;
     /**
      * Checks if the given subnet is reachable
-     * @param {string} mediaServerIp - media server ip
+     * @param {string} selectedSubnetFirstOctet - selected subnet first octet, e.g. "10" for "10.X.X.X"
      * @returns {boolean | null} true if reachable, false if not reachable, null if mediaServerIp is not provided
      * @public
      * @memberof Reachability
      */
-    isSubnetReachable(mediaServerIp?: string): boolean | null;
+    isSubnetReachable(selectedSubnetFirstOctet: string): boolean | null;
     /**
      * Gets a list of media clusters from the backend and performs reachability checks on all the clusters
      * @param {string} trigger - explains the reason for starting reachability

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.1"
+  version: "3.9.0"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@webex/plugin-meetings",
   "description": "",
-  "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
+  "license": "Cisco's General Terms (https://www.cisco.com/site/us/en/about/legal/contract-experience/index.html)",
   "contributors": [
     "Adam Weeks <adweeks@cisco.com> (https://adamweeks.com/)",
     "Arun Ganeshan <arungane@cisco.com>",
@@ -43,13 +43,12 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.8.1",
-    "@webex/plugin-rooms": "3.8.1",
-    "@webex/test-helper-chai": "3.8.1",
-    "@webex/test-helper-mocha": "3.8.1",
-    "@webex/test-helper-mock-webex": "3.8.1",
-    "@webex/test-helper-retry": "3.8.1",
-    "@webex/test-helper-test-users": "3.8.1",
+    "@webex/plugin-rooms": "3.9.0",
+    "@webex/test-helper-chai": "3.9.0",
+    "@webex/test-helper-mocha": "3.9.0",
+    "@webex/test-helper-mock-webex": "3.9.0",
+    "@webex/test-helper-retry": "3.9.0",
+    "@webex/test-helper-test-users": "3.9.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -61,23 +60,23 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.1",
-    "@webex/event-dictionary-ts": "^1.0.1753",
-    "@webex/internal-media-core": "2.17.1",
-    "@webex/internal-plugin-conversation": "3.8.1",
-    "@webex/internal-plugin-device": "3.8.1",
-    "@webex/internal-plugin-llm": "3.8.1",
-    "@webex/internal-plugin-mercury": "3.8.1",
-    "@webex/internal-plugin-metrics": "3.8.1",
-    "@webex/internal-plugin-support": "3.8.1",
-    "@webex/internal-plugin-user": "3.8.1",
-    "@webex/internal-plugin-voicea": "3.8.1",
-    "@webex/media-helpers": "3.8.1",
-    "@webex/plugin-people": "3.8.1",
-    "@webex/plugin-rooms": "3.8.1",
+    "@webex/common": "3.9.0",
+    "@webex/event-dictionary-ts": "^1.0.1819",
+    "@webex/internal-media-core": "2.18.5",
+    "@webex/internal-plugin-conversation": "3.9.0",
+    "@webex/internal-plugin-device": "3.9.0",
+    "@webex/internal-plugin-llm": "3.9.0",
+    "@webex/internal-plugin-mercury": "3.9.0",
+    "@webex/internal-plugin-metrics": "3.9.0",
+    "@webex/internal-plugin-support": "3.9.0",
+    "@webex/internal-plugin-user": "3.9.0",
+    "@webex/internal-plugin-voicea": "3.9.0",
+    "@webex/media-helpers": "3.9.0",
+    "@webex/plugin-people": "3.9.0",
+    "@webex/plugin-rooms": "3.9.0",
     "@webex/ts-sdp": "^1.8.1",
-    "@webex/web-capabilities": "^1.4.0",
-    "@webex/webex-core": "3.8.1",
+    "@webex/web-capabilities": "^1.6.0",
+    "@webex/webex-core": "3.9.0",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -93,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.1"
+  "version": "3.9.0"
 }