@webex/plugin-meetings 3.8.0-web-workers-keepalive.1 → 3.8.1-next.1

package/dist/types/controls-options-manager/enums.d.ts

@@ -10,7 +10,9 @@ declare enum Control {
     reactions = "reactions",
     shareControl = "shareControl",
     video = "video",
-    viewTheParticipantList = "viewTheParticipantList"
+    viewTheParticipantList = "viewTheParticipantList",
+    annotation = "annotation",
+    rdc = "rdc"
 }
 export { Control, Setting };
 export default Setting;

package/dist/types/controls-options-manager/types.d.ts

@@ -32,7 +32,13 @@ export interface ViewTheParticipantListProperties {
     panelistEnabled?: boolean;
     attendeeCount?: boolean;
 }
-export type Properties = AudioProperties | RaiseHandProperties | ReactionsProperties | ShareControlProperties | VideoProperties | ViewTheParticipantListProperties;
+export interface AnnotationProperties {
+    enabled?: boolean;
+}
+export interface RemoteDesktopControlProperties {
+    enabled?: boolean;
+}
+export type Properties = AudioProperties | RaiseHandProperties | ReactionsProperties | ShareControlProperties | VideoProperties | ViewTheParticipantListProperties | AnnotationProperties | RemoteDesktopControlProperties;
 export interface ControlConfig<Props = Properties> {
     /**
      * The scope of the control within this object.

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

@@ -37,6 +37,7 @@ export default class LocusInfo extends EventsScope {
     services: any;
     resources: any;
     mainSessionLocusCache: any;
+    self: any;
     /**
      * Constructor
      * @param {function} updateMeeting callback to update the meeting object from an object
@@ -249,13 +250,12 @@ export default class LocusInfo extends EventsScope {
     updateReplace(replace: object): void;
     /**
      * handles when the locus.self is updated
-     * @param {Object} self the locus.mediaShares property
-     * @param {Array} participants the locus.participants property
+     * @param {Object} self the new locus.self
      * @returns {undefined}
      * @memberof LocusInfo
      * emits internal events self_admitted_guest, self_unadmitted_guest, locus_info_update_self
      */
-    updateSelf(self: any, participants: Array<any>): void;
+    updateSelf(self: any): void;
     /**
      * handles when the locus.url is updated
      * @param {String} url

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

@@ -1,2 +1,217 @@
-declare const SelfUtils: any;
+declare const SelfUtils: {
+    /**
+     * parses the relevant values for self: muted, guest, moderator, mediaStatus, state, joinedWith, pstnDevices, creator, id
+     * @param {Object} self
+     * @param {String} deviceId
+     * @param {Array} participants
+     * @returns {undefined}
+     */
+    parse: (self: any, deviceId: string, participants: Array<any>) => {
+        remoteVideoMuted: any;
+        remoteMuted: any;
+        unmuteAllowed: boolean;
+        localAudioUnmuteRequested: boolean;
+        localAudioUnmuteRequestedTimeStamp: number;
+        localAudioUnmuteRequired: boolean;
+        lastModified: any;
+        modifiedBy: any;
+        guest: any;
+        moderator: any;
+        mediaStatus: {
+            audio: any;
+            video: any;
+            slides: any;
+        };
+        state: any;
+        joinedWith: any;
+        pairedWith: any;
+        pstnDevices: any;
+        currentMediaStatus: {
+            audio: any;
+            video: any;
+            share: any;
+        };
+        creator: any;
+        selfId: any;
+        selfIdentity: any;
+        selfUrl: any;
+        removed: any;
+        roles: any;
+        isUserUnadmitted: boolean;
+        layout: any;
+        canNotViewTheParticipantList: boolean;
+        isSharingBlocked: boolean;
+        breakoutSessions: any;
+        breakout: any;
+        interpretation: any;
+        brb: any;
+    };
+    getBreakoutSessions: (self: any) => any;
+    getBreakout: (self: any) => any;
+    getInterpretation: (self: any) => any;
+    getBrb: (self: any) => any;
+    getLayout: (self: any) => any;
+    getRoles: (self: any) => any;
+    canNotViewTheParticipantList: (self: any) => boolean;
+    isSharingBlocked: (self: any) => boolean;
+    getSelves: (oldParsedSelf: any, newSelf: any, deviceId: any, participants: Array<any>) => {
+        previous: any;
+        current: {
+            remoteVideoMuted: any;
+            remoteMuted: any;
+            unmuteAllowed: boolean;
+            localAudioUnmuteRequested: boolean;
+            localAudioUnmuteRequestedTimeStamp: number;
+            localAudioUnmuteRequired: boolean;
+            lastModified: any;
+            modifiedBy: any;
+            guest: any;
+            moderator: any;
+            mediaStatus: {
+                audio: any;
+                video: any;
+                slides: any;
+            };
+            state: any;
+            joinedWith: any;
+            pairedWith: any;
+            pstnDevices: any;
+            currentMediaStatus: {
+                audio: any;
+                video: any;
+                share: any;
+            };
+            creator: any;
+            selfId: any;
+            selfIdentity: any;
+            selfUrl: any;
+            removed: any;
+            roles: any;
+            isUserUnadmitted: boolean;
+            layout: any;
+            canNotViewTheParticipantList: boolean;
+            isSharingBlocked: boolean;
+            breakoutSessions: any;
+            breakout: any;
+            interpretation: any;
+            brb: any;
+        };
+        updates: any;
+    };
+    /**
+     * Checks if user has joined the meeting
+     * @param {Object} self
+     * @returns {boolean} isJoined
+     */
+    isJoined: (self: any) => boolean;
+    /**
+     * Validate if the Meeting Layout Controls Layout has changed.
+     *
+     * @param {Self} previous - Previous self state
+     * @param {Self} current - Current self state [per event]
+     * @returns {boolean} - If the Meeting Layout Controls Layout has changed.
+     */
+    layoutChanged: (previous: any, current: any) => boolean;
+    breakoutsChanged: (previous: any, current: any) => boolean;
+    interpretationChanged: (previous: any, current: any) => boolean;
+    brbChanged: (previous: any, current: any) => boolean;
+    isMediaInactive: (previous: any, current: any) => boolean;
+    getLastModified: (self: any) => any;
+    getModifiedBy: (self: any) => any;
+    /**
+     * get the id from the self object
+     * @param {Object} self
+     * @returns {String}
+     */
+    getSelfIdentity: (self: any) => any;
+    /**
+     * get the "remote video mute" property from the self object
+     * @param {Object} self
+     * @returns {Boolean}
+     */
+    getRemoteVideoMuted: (self: any) => any;
+    /**
+     * get the "remote mute" property from the self object
+     * @param {Object} self
+     * @returns {Boolean}
+     */
+    getRemoteMuted: (self: any) => any;
+    getLocalAudioUnmuteRequested: (self: any) => boolean;
+    getLocalAudioUnmuteRequestedTimeStamp: (self: any) => number;
+    getUnmuteAllowed: (self: any) => boolean;
+    getLocalAudioUnmuteRequired: (self: any) => boolean;
+    getStatus: (status: any) => {
+        audio: any;
+        video: any;
+        slides: any;
+    };
+    /**
+     * @param {Object} oldSelf
+     * @param {Object} changedSelf
+     * @returns {Boolean}
+     */
+    wasMediaInactiveOrReleased: (oldSelf: any, changedSelf: any) => boolean;
+    /**
+     * @param {String | undefined} state meeting state
+     * @param {any} joinedWith device that user has joined with
+     * @param {any} pairedWith device that user is paired with
+     * @returns {Boolean | undefined} true if user is in lobby, false if not, undefined if it cannot be determined
+     */
+    isLocusUserUnadmitted: (state?: string, joinedWith?: any, pairedWith?: any) => boolean;
+    /**
+     * @param {String | undefined} state meeting state
+     * @param {any} joinedWith device that user has joined with
+     * @param {any} pairedWith device that user is paired with
+     * @returns {Boolean}
+     */
+    isLocusUserAdmitted: (state?: string, joinedWith?: any, pairedWith?: any) => boolean;
+    /**
+     * @param {Object} oldSelf
+     * @param {Object} changedSelf
+     * @returns {Boolean} true if user has just been placed in the lobby
+     * @throws {Error} when self is undefined
+     */
+    hasUserEnteredLobby: (oldSelf: any, changedSelf: any) => boolean;
+    moderatorChanged: (oldSelf: any, changedSelf: any) => boolean;
+    /**
+     * determine whether the roles of self is changed or not
+     * @param {Object} oldSelf
+     * @param {Object} changedSelf
+     * @returns {Boolean}
+     */
+    isRolesChanged: (oldSelf: any, changedSelf: any) => boolean;
+    /**
+     * @param {Object} oldSelf
+     * @param {Object} changedSelf
+     * @returns {Boolean}
+     * @throws {Error} if changed self was undefined
+     */
+    isDeviceObserving: (oldSelf: any, changedSelf: any) => boolean;
+    /**
+     * @param {Object} oldSelf
+     * @param {Object} changedSelf
+     * @returns {Boolean} true if the user has just been admitted from lobby into the meeting
+     * @throws {Error} if changed self was undefined
+     */
+    hasUserBeenAdmitted: (oldSelf: any, changedSelf: any) => boolean;
+    videoMutedByOthersChanged: (oldSelf: any, changedSelf: any) => boolean;
+    mutedByOthersChanged: (oldSelf: any, changedSelf: any) => boolean;
+    localAudioUnmuteRequestedByServer: (oldSelf: any, changedSelf: any) => boolean;
+    localAudioUnmuteRequiredByServer: (oldSelf: any, changedSelf: any) => boolean;
+    /**
+     * extract the sipUrl from the partner
+     * @param {Object} partner
+     * @param {Object} info
+     * @returns {Object}
+     */
+    getSipUrl: (partner: any, type: any, sipUri: any) => {
+        sipUri: any;
+    };
+    getMediaStatus: (mediaSessions?: any[]) => {
+        audio: any;
+        video: any;
+        share: any;
+    };
+    getReplacedBreakoutMoveId: (self: any, deviceId: string) => any;
+};
 export default SelfUtils;

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

@@ -1,4 +1,5 @@
 import { LocalCameraStream, LocalMicrophoneStream, LocalDisplayStream, LocalSystemAudioStream, RemoteStream } from '@webex/media-helpers';
+import { ClientEvent } from '@webex/internal-plugin-metrics';
 export type MediaDirection = {
     sendAudio: boolean;
     sendVideo: boolean;
@@ -7,6 +8,7 @@ export type MediaDirection = {
     receiveVideo: boolean;
     receiveShare: boolean;
 };
+export type IPVersion = ClientEvent['payload']['ipVersion'];
 /**
  * @class MediaProperties
  */
@@ -94,6 +96,18 @@ export default class MediaProperties {
      * @returns {Object}
      */
     private getTransportInfo;
+    /**
+     * Checks if the given IP address is IPv6
+     * @param {string} ip address to check
+     * @returns {boolean} true if the address is IPv6, false otherwise
+     */
+    private isIPv6;
+    /** Finds out if we connected using IPv4 or IPv6
+     * @param {RTCPeerConnection} webrtcMediaConnection
+     * @param {Array<any>} allStatsReports array of RTC stats reports
+     * @returns {string} IPVersion
+     */
+    private getConnectionIpVersion;
     /**
      * Returns the type of a connection that has been established
      * It should be 'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'
@@ -111,6 +125,7 @@ export default class MediaProperties {
      */
     getCurrentConnectionInfo(): Promise<{
         connectionType: string;
+        ipVersion?: IPVersion;
         selectedCandidatePairChanges: number;
         numTransports: number;
     }>;

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

@@ -77,6 +77,8 @@ interface IInMeetingActions {
     canShareDesktop?: boolean;
     canShareContent?: boolean;
     canTransferFile?: boolean;
+    canRealtimeCloseCaption?: boolean;
+    canRealtimeCloseCaptionManual?: boolean;
     canChat?: boolean;
     canDoVideo?: boolean;
     canAnnotate?: boolean;
@@ -95,6 +97,12 @@ interface IInMeetingActions {
     isPracticeSessionOff?: boolean;
     canStartPracticeSession?: boolean;
     canStopPracticeSession?: boolean;
+    requiresPostMeetingDataConsentPrompt?: boolean;
+    canEnableAnnotation?: boolean;
+    canDisableAnnotation?: boolean;
+    canEnableRemoteDesktopControl?: boolean;
+    canDisableRemoteDesktopControl?: boolean;
+    canMoveToLobby?: boolean;
 }
 /**
  * @class InMeetingActions
@@ -172,6 +180,8 @@ export default class InMeetingActions implements IInMeetingActions {
     canShareDesktop: any;
     canShareContent: any;
     canTransferFile: any;
+    canRealtimeCloseCaption: any;
+    canRealtimeCloseCaptionManual: any;
     canChat: any;
     canDoVideo: any;
     canAnnotate: any;
@@ -190,6 +200,12 @@ export default class InMeetingActions implements IInMeetingActions {
     isPracticeSessionOff: any;
     canStartPracticeSession: any;
     canStopPracticeSession: any;
+    requiresPostMeetingDataConsentPrompt: any;
+    canEnableAnnotation: any;
+    canDisableAnnotation: any;
+    canEnableRemoteDesktopControl: any;
+    canDisableRemoteDesktopControl: any;
+    canMoveToLobby: any;
     /**
      * Returns all meeting action options
      * @returns {Object}

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

@@ -4,7 +4,8 @@ import { ClientEvent, ClientEventLeaveReason } from '@webex/internal-plugin-metr
 import { ClientEvent as RawClientEvent } from '@webex/event-dictionary-ts';
 import { MediaType, StatsAnalyzer, NetworkQualityMonitor } from '@webex/internal-media-core';
 import { LocalStream, LocalCameraStream, LocalDisplayStream, LocalSystemAudioStream, LocalMicrophoneStream } from '@webex/media-helpers';
-import Roap, { type TurnServerInfo, type TurnDiscoverySkipReason } from '../roap/index';
+import Roap, { type TurnDiscoverySkipReason } from '../roap/index';
+import { type TurnServerInfo } from '../roap/types';
 import { type BundlePolicy } from '../media';
 import MediaProperties from '../media/properties';
 import ReconnectionManager from '../reconnection-manager';
@@ -449,6 +450,12 @@ export default class Meeting extends StatelessWebexPlugin {
     allowMediaInLobby: boolean;
     localShareInstanceId: string;
     remoteShareInstanceId: string;
+    shareCAEventSentStatus: {
+        transmitStart: boolean;
+        transmitStop: boolean;
+        receiveStart: boolean;
+        receiveStop: boolean;
+    };
     turnDiscoverySkippedReason: TurnDiscoverySkipReason;
     turnServerUsed: boolean;
     areVoiceaEventsSetup: boolean;
@@ -468,6 +475,7 @@ export default class Meeting extends StatelessWebexPlugin {
     private rtcMetrics?;
     private uploadLogsTimer?;
     private logUploadIntervalIndex;
+    private mediaServerIp;
     /**
      * @param {Object} attrs
      * @param {Object} options
@@ -872,6 +880,17 @@ export default class Meeting extends StatelessWebexPlugin {
     cancelPhoneInvite(invitee: {
         phoneNumber: string;
     }): any;
+    /**
+     * Cancel an SIP call invitation made during a meeting
+     * @param {Object} invitee
+     * @param {String} invitee.memberId
+     * @returns {Promise} see #members.cancelSIPInvite
+     * @public
+     * @memberof Meeting
+     */
+    cancelSIPInvite(invitee: {
+        memberId: string;
+    }): any;
     /**
      * Admit the guest(s) to the call once they are waiting.
      * If the host/cohost is in a breakout session, the locus url
@@ -1881,6 +1900,15 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     toggleReactions(enable: boolean): Promise<any>;
+    /**
+     * Method to set post meeting data consent.
+     *
+     * @param  {boolean} accept - whether consent accepted or declined
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    setPostMeetingDataConsent(accept: boolean): Promise<any>;
     /**
      * Throws if we don't have a media connection created
      *
@@ -1959,5 +1987,11 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {Promise<void>}
      */
     checkAndRefreshPermissionToken(threshold: number, reason: string): Promise<void>;
+    /**
+     * Gets the media reachability metrics
+     *
+     * @returns {Promise<MediaReachabilityMetrics>}
+     */
+    private getMediaReachabilityMetricFields;
 }
 export {};

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

@@ -69,7 +69,6 @@ export declare class MuteState {
      * @public
      * @memberof MuteState
      * @param {Object} [meeting] the meeting object
-     * @param {Boolean} [mute] true for muting, false for unmuting request
      * @returns {void}
      */
     handleLocalStreamMuteStateChange(meeting?: any): void;

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

@@ -1,5 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
-import { SendReactionOptions, BrbOptions, ToggleReactionsOptions } from './request.type';
+import { SendReactionOptions, BrbOptions, ToggleReactionsOptions, PostMeetingDataConsentOptions } from './request.type';
 import { AnnotationInfo } from '../annotation/annotation.types';
 import { ClientMediaPreferences } from '../reachability/reachability.types';
 /**
@@ -303,4 +303,15 @@ export default class MeetingRequest extends StatelessWebexPlugin {
      * @returns {Promise}
      */
     setBrb({ enabled, locusUrl, deviceUrl, selfId }: BrbOptions): Promise<any>;
+    /**
+     * Sends a request to set post meeting data consent.
+     *
+     * @param {Object} options - The options for post meeting data consent request.
+     * @param {boolean} options.consent - Whether accepted or declined.
+     * @param {string} options.locusUrl - The URL of the locus.
+     * @param {string} options.deviceUrl - The URL of the device.
+     * @param {string} options.selfId - The ID of the participant.
+     * @returns {Promise}
+     */
+    setPostMeetingDataConsent({ postMeetingDataConsent, locusUrl, deviceUrl, selfId, }: PostMeetingDataConsentOptions): Promise<any>;
 }

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

@@ -15,3 +15,9 @@ export type BrbOptions = {
     deviceUrl: string;
     selfId: string;
 };
+export type PostMeetingDataConsentOptions = {
+    postMeetingDataConsent: boolean;
+    locusUrl: string;
+    deviceUrl: string;
+    selfId: string;
+};

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

@@ -80,8 +80,10 @@ declare const MeetingUtil: {
     waitingForOthersToJoin: (displayHints: any) => any;
     canSendReactions: (originalValue: any, displayHints: any) => any;
     canUserRenameSelfAndObserved: (displayHints: any) => any;
+    requiresPostMeetingDataConsentPrompt: (displayHints: any) => any;
     canUserRenameOthers: (displayHints: any) => any;
-    canShareWhiteBoard: (displayHints: any) => any;
+    canShareWhiteBoard: (displayHints: any, policies?: {}) => boolean;
+    canMoveToLobby: (displayHints: any) => any;
     /**
      * Adds the current locus sequence information to a request body
      * @param {Object} meeting The meeting object

package/dist/types/meeting-info/meeting-info-v2.d.ts

@@ -238,6 +238,7 @@ export default class MeetingInfoV2 {
      * @param {Object} extraParams
      * @param {Object} options
      * @param {String} registrationId
+     * @param {String} fullSiteUrl
      * @returns {Promise} returns a meeting info object
      * @public
      * @memberof MeetingInfo
@@ -248,5 +249,5 @@ export default class MeetingInfoV2 {
     }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
         meetingId?: string;
         sendCAevents?: boolean;
-    }, registrationId?: string): Promise<any>;
+    }, registrationId?: string, fullSiteUrl?: string): Promise<any>;
 }

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

@@ -227,6 +227,34 @@ export default class Meetings extends WebexPlugin {
      * @returns {undefined}
      */
     private _toggleIpv6BackendNativeSupport;
+    /**
+     * API to toggle usage of audio main DTX, needs to be called before webex.meetings.register()
+     *
+     * @param {Boolean} newValue
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
+     */
+    private _toggleDisableAudioMainDtx;
+    /**
+     * API to toggle usage of audio twcc support
+     *
+     * @param {Boolean} newValue
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
+     */
+    private _toggleEnableAudioTwccForMultistream;
+    /**
+     * API to toggle stopping ICE Candidates Gathering after first relay candidate,
+     * needs to be called before webex.meetings.joinWithMedia()
+     *
+     * @param {Boolean} newValue
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
+     */
+    private _toggleStopIceGatheringAfterFirstRelayCandidate;
     /**
      * Executes a registration step and updates the registration status.
      * @param {Function} step - The registration step to execute.

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

@@ -1,11 +1,13 @@
-import { IExternalRoles, IMediaStatus } from './types';
+import { IExternalRoles, IMediaStatus, Participant, ParticipantUrl } from './types';
+export type MemberId = string;
 /**
  * @class Member
  */
 export default class Member {
-    associatedUser: any;
+    associatedUser: MemberId | null;
+    associatedUsers: Set<MemberId>;
     canReclaimHost: boolean;
-    id: any;
+    id: MemberId;
     isAudioMuted: any;
     isContentSharing: any;
     isDevice: any;
@@ -22,6 +24,7 @@ export default class Member {
     isRecording: any;
     isRemovable: any;
     isSelf: any;
+    isPairedWithSelf: boolean;
     isBrb: boolean;
     isUser: any;
     isVideoMuted: any;
@@ -35,6 +38,10 @@ export default class Member {
     supportLiveAnnotation: boolean;
     type: any;
     namespace: string;
+    pairedWith: {
+        participantUrl?: ParticipantUrl;
+        memberId?: MemberId;
+    };
     /**
      * @param {Object} participant - the locus participant
      * @param {Object} [options] - constructor params
@@ -45,7 +52,7 @@ export default class Member {
      * @returns {Member}
      * @memberof Member
      */
-    constructor(participant: object, options?: {
+    constructor(participant: Participant, options?: {
         selfId: string;
         hostId: string;
         contentSharingId: string;
@@ -59,6 +66,13 @@ export default class Member {
      * @memberof Member
      */
     private processParticipant;
+    /**
+     * Checks if the participant is paired with another device
+     *
+     * @param {any} participant the locus participant object
+     * @returns {void}
+     */
+    processPairedDevice(participant: Participant): void;
     /**
      * Use the members options and participant values to set on the member
      * @param {Object} participant the locus participant object
@@ -115,7 +129,7 @@ export default class Member {
      * @public
      * @memberof Member
      */
-    processIsContentSharing(participant: object, sharingId: string): void;
+    processIsContentSharing(participant: Participant, sharingId: string): void;
     /**
      * Determine if this member is recording
      * @param {Object} participant
@@ -124,7 +138,7 @@ export default class Member {
      * @public
      * @memberof Member
      */
-    processIsRecording(participant: object, recordingId: string): void;
+    processIsRecording(participant: Participant, recordingId: string): void;
     /**
      * determine if this member is the self
      * @param {Object} participant