@webex/jsdoctrinetest 3.0.0-bnr.5 → 3.0.0-next.2

package/dist/types/@webex/plugin-meetings/src/multistream/remoteMediaManager.d.ts

@@ -1,241 +0,0 @@
-import { EventMap } from 'typed-emitter';
-import EventsScope from '../common/events/events-scope';
-import { RemoteMedia, RemoteVideoResolution } from './remoteMedia';
-import { CSI } from './receiveSlot';
-import { ReceiveSlotManager } from './receiveSlotManager';
-import { RemoteMediaGroup } from './remoteMediaGroup';
-import { MediaRequestManager } from './mediaRequestManager';
-export type PaneSize = RemoteVideoResolution;
-export type LayoutId = string;
-export type PaneId = string;
-export type PaneGroupId = string;
-export interface ActiveSpeakerVideoPaneGroup {
-    id: PaneGroupId;
-    numPanes: number;
-    size: PaneSize;
-    priority: number;
-}
-export interface MemberVideoPane {
-    id: PaneId;
-    size: PaneSize;
-    csi?: CSI;
-}
-export interface VideoLayout {
-    screenShareVideo?: {
-        size: PaneSize;
-    };
-    activeSpeakerVideoPaneGroups?: ActiveSpeakerVideoPaneGroup[];
-    memberVideoPanes?: MemberVideoPane[];
-}
-export interface Configuration {
-    audio: {
-        numOfActiveSpeakerStreams: number;
-        numOfScreenShareStreams: number;
-    };
-    video: {
-        preferLiveVideo: boolean;
-        initialLayoutId: LayoutId;
-        layouts: {
-            [key: LayoutId]: VideoLayout;
-        };
-    };
-}
-/**
- * Default configuration:
- * - uses 3 audio streams
- * - prefers active speakers with live video (e.g. are not audio only or video muted) over active speakers without live video
- * - has a few layouts defined, including 1 that contains remote screen share (ScreenShareView)
- */
-export declare const DefaultConfiguration: Configuration;
-export declare enum Event {
-    AudioCreated = "AudioCreated",
-    ScreenShareAudioCreated = "ScreenShareAudioCreated",
-    VideoLayoutChanged = "VideoLayoutChanged"
-}
-export interface VideoLayoutChangedEventData {
-    layoutId: LayoutId;
-    activeSpeakerVideoPanes: {
-        [key: PaneGroupId]: RemoteMediaGroup;
-    };
-    memberVideoPanes: {
-        [key: PaneId]: RemoteMedia;
-    };
-    screenShareVideo?: RemoteMedia;
-}
-export interface Events extends EventMap {
-    [Event.AudioCreated]: (audio: RemoteMediaGroup) => void;
-    [Event.ScreenShareAudioCreated]: (screenShareAudio: RemoteMediaGroup) => void;
-    [Event.VideoLayoutChanged]: (data: VideoLayoutChangedEventData) => void;
-}
-/**
- * A helper class that manages all remote audio/video streams in order to achieve a predefined set of layouts.
- * It also creates a fixed number of audio streams and these don't change during the meeting.
- *
- * Things that RemoteMediaManager does:
- * - owns the receive slots (creates them when needed, and re-uses them when switching layouts)
- * - constructs appropriate RemoteMedia and RemoteMediaGroup objects and sends appropriate mediaRequests
- */
-export declare class RemoteMediaManager extends EventsScope {
-    private config;
-    private started;
-    private receiveSlotManager;
-    private mediaRequestManagers;
-    private currentLayout?;
-    private slots;
-    private media;
-    private receiveSlotAllocations;
-    private currentLayoutId?;
-    /**
-     * Constructor
-     *
-     * @param {ReceiveSlotManager} receiveSlotManager
-     * @param {{audio: MediaRequestManager, video: mediaRequestManagers}} mediaRequestManagers
-     * @param {Configuration} config Configuration describing what video layouts to use during the meeting
-     */
-    constructor(receiveSlotManager: ReceiveSlotManager, mediaRequestManagers: {
-        audio: MediaRequestManager;
-        video: MediaRequestManager;
-        screenShareAudio: MediaRequestManager;
-        screenShareVideo: MediaRequestManager;
-    }, config?: Configuration);
-    /**
-     * Checks if configuration is valid, throws an error if it's not
-     */
-    private checkConfigValidity;
-    /**
-     * Starts the RemoteMediaManager.
-     *
-     * @returns {Promise}
-     */
-    start(): Promise<void>;
-    /**
-     * Releases all the used resources (like allocated receive slots). This function needs
-     * to be called when we leave the meeting, etc.
-     */
-    stop(): void;
-    /**
-     * Returns the total number of main video panes required for a given layout
-     *
-     * @param {VideoLayout} layout
-     * @returns {number}
-     */
-    private getRequiredNumVideoSlotsForLayout;
-    /**
-     * Allocates the maximum number of panes that any of the configured layouts will require.
-     * We do this at the beginning, because it's more efficient (much faster) then allocating receive slots
-     * later, after the SDP exchange was done.
-     */
-    private preallocateVideoReceiveSlots;
-    /**
-     * Changes the layout (triggers Event.VideoLayoutChanged)
-     *
-     * @param {LayoutId} layoutId new layout id
-     * @returns {Promise}
-     */
-    setLayout(layoutId: LayoutId): Promise<void>;
-    /**
-     * Returns the currently selected layout id
-     *
-     * @returns {LayoutId}
-     */
-    getLayoutId(): LayoutId | undefined;
-    /**
-     * Creates the audio slots
-     */
-    private createAudioMedia;
-    /**
-     * Creates receive slots required for receiving screen share audio and video
-     */
-    private createScreenShareReceiveSlots;
-    /**
-     * Creates RemoteMedia objects for screen share
-     */
-    private createScreenShareAudioMedia;
-    /**
-     * Goes over all receiver-selected slots and keeps only the ones that are required by a given layout,
-     * the rest are all moved to the "unused" list
-     */
-    private trimReceiverSelectedSlots;
-    /**
-     * Releases all the "unused" video slots.
-     */
-    private releaseUnusedVideoSlots;
-    /**
-     * Allocates receive slots to all video panes in the current selected layout
-     */
-    private allocateSlotsToVideoPaneGroups;
-    /**
-     * Makes sure we have the right number of receive slots created for the current layout
-     * and allocates them to the right video panes / pane groups
-     *
-     * @returns {Promise}
-     */
-    private updateVideoReceiveSlots;
-    /**
-     * Creates new RemoteMedia and RemoteMediaGroup objects for the current layout
-     * and sends the media requests for all of them.
-     */
-    private updateVideoRemoteMediaObjects;
-    /**
-     * Checks if current layout requires a screen share.
-     * If it does, it creates new RemoteMediaGroup object for screen share
-     * and sends the media requests for it.
-     * If it doesn't, it makes sure we clean up any RemoteMediaGroup objects
-     * created earlier for screen share (for previous layout).
-     */
-    private updateScreenShareVideoRemoteMediaObject;
-    /**
-     * Invalidates all remote media objects belonging to currently selected layout
-     */
-    private invalidateCurrentRemoteMedia;
-    /** emits Event.VideoLayoutChanged */
-    private emitVideoLayoutChangedEvent;
-    /**
-     * Sets a new CSI on a given remote media object
-     *
-     * @param {RemoteMedia} remoteMedia remote Media object to modify
-     * @param {CSI} csi new CSI value, can be null if we want to stop receiving media
-     */
-    setRemoteVideoCsi(remoteMedia: RemoteMedia, csi: CSI | null): void;
-    /**
-     * Adds a new member video pane to the currently selected layout.
-     *
-     * Changes to the layout are lost after a layout change.
-     *
-     * @param {MemberVideoPane} newPane
-     * @returns {Promise<RemoteMedia>}
-     */
-    addMemberVideoPane(newPane: MemberVideoPane): Promise<RemoteMedia>;
-    /**
-     * Removes a member video pane from the currently selected layout.
-     *
-     * Changes to the layout are lost after a layout change.
-     *
-     * @param {PaneId} paneId pane id of the pane to remove
-     * @returns {Promise<void>}
-     */
-    removeMemberVideoPane(paneId: PaneId): Promise<void>;
-    /**
-     * Pins an active speaker remote media object to the given CSI value. From that moment
-     * onwards the remote media will only play audio/video from that specific CSI until
-     * unpinActiveSpeakerVideoPane() is called or current layout is changed.
-     *
-     * @param {RemoteMedia} remoteMedia remote media object reference
-     * @param {CSI} csi CSI value to pin to, if undefined, then current CSI value is used
-     */
-    pinActiveSpeakerVideoPane(remoteMedia: RemoteMedia, csi?: CSI): void;
-    /**
-     * Unpins a remote media object from the fixed CSI value it was pinned to.
-     *
-     * @param {RemoteMedia} remoteMedia remote media object reference
-     */
-    unpinActiveSpeakerVideoPane(remoteMedia: RemoteMedia): void;
-    /**
-     * Returns true if a given remote media object belongs to an active speaker group and has been pinned.
-     * Throws an error if the remote media object doesn't belong to any active speaker remote media group.
-     *
-     * @param {RemoteMedia} remoteMedia remote media object
-     * @returns {boolean}
-     */
-    isPinned(remoteMedia: RemoteMedia): boolean;
-}

package/dist/types/@webex/plugin-meetings/src/networkQualityMonitor/index.d.ts

@@ -1,70 +0,0 @@
-import EventsScope from '../common/events/events-scope';
-/**
- * Meeting - network quality event
- * Emitted on each interval of retrieving stats Analyzer data
- * @event network:quality
- * @type {Object}
- * @property {string} mediaType {video|audio}
- * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
- * @memberof NetworkQualityMonitor
- */
-/**
- * NetworkQualityMonitor class that will emit events based on detected quality
- *
- * @class NetworkQualityMonitor
- * @extends {EventsScope}
- */
-export default class NetworkQualityMonitor extends EventsScope {
-    config: any;
-    frequencyTypes: any;
-    indicatorTypes: any;
-    mediaType: any;
-    networkQualityScore: any;
-    networkQualityStatus: any;
-    /**
-     * Creates a new instance of NetworkQualityMonitor
-     * @constructor
-     * @public
-     * @param {Object} config
-     * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
-     * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
-     * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
-     * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
-     * @property {string} mediaType - audio|video
-     */
-    constructor(config: any);
-    /**
-     * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
-     *
-     * @memberof NetworkQualityMonitor
-     * @returns {void}
-     */
-    emitNetworkQuality(): void;
-    /**
-     * invokes emitNetworkQuality method resets values back to default
-     * @returns {void}
-     * @memberof NetworkQualityMonitor
-     */
-    updateNetworkQualityStatus(): void;
-    /**
-     * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
-     * @param {Object} configObj
-     * @param {string} configObj.mediaType {audio|video}
-     * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
-     * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
-     * @returns {void}
-     * @public
-     * @memberof NetworkQualityMonitor
-     */
-    determineUplinkNetworkQuality({ mediaType, remoteRtpResults, statsAnalyzerCurrentStats, }: {
-        mediaType: string;
-        remoteRtpResults: any;
-        statsAnalyzerCurrentStats: object;
-    }): void;
-    /**
-     * Get the current status of network quaility object - networkQualityStatus
-     * @returns {Object}
-     * @public
-     */
-    get networkQualityStats(): any;
-}

package/dist/types/@webex/plugin-meetings/src/personal-meeting-room/index.d.ts

@@ -1,47 +0,0 @@
-import { StatelessWebexPlugin } from '@webex/webex-core';
-/**
- * @class PersonalMeetingRoom
- */
-export default class PersonalMeetingRoom extends StatelessWebexPlugin {
-    link: any;
-    meetingInfo: any;
-    name: any;
-    personalMeetingRoomRequest: any;
-    pmr: any;
-    sipUri: any;
-    userId: any;
-    meetingLink: any;
-    number: any;
-    namespace: string;
-    /**
-     *
-     * @param {Object} attrs
-     * @param {Object} options
-     */
-    constructor(attrs: any, options: any);
-    /**
-     * claims a pmr and updates the cached PMR values
-     * @param {String} link
-     * @param {String} pin
-     * @param {Boolean} [preferred] defaults to true to set this claimed PMR as the preferred
-     * @returns {Promise}
-     * @public
-     * @memberof PersonalMeetingRoom
-     */
-    claim(link: string, pin: string, preferred?: boolean): any;
-    /**
-     * @param {Object} body the response body from meeting info request
-     * @returns {undefined}
-     * @private
-     * @memberof PersonalMeetingRoom
-     */
-    private set;
-    /**
-     * TODO: implement TTL for syncing and caching so to not request again and again
-     * @param {Object} options
-     * @returns {Promise}
-     * @public
-     * @memberof PersonalMeetingRoom
-     */
-    get(): any;
-}

package/dist/types/@webex/plugin-meetings/src/personal-meeting-room/request.d.ts

@@ -1,14 +0,0 @@
-import { StatelessWebexPlugin } from '@webex/webex-core';
-/**
- * @class MeetingInfoRequest
- */
-export default class PersonalMeetingRoomRequest extends StatelessWebexPlugin {
-    namespace: string;
-    /**
-     *
-     * @param {Object} options with format of {userId, passcode, meetingAddress, preferred}
-     * @returns {Promise} returns a promise that resolves/rejects the result of the request
-     * @memberof PersonalMeetingRoomRequest
-     */
-    claimPmr(options: any): any;
-}

package/dist/types/@webex/plugin-meetings/src/personal-meeting-room/util.d.ts

@@ -1,2 +0,0 @@
-declare const PersonalMeetingRoomUtil: any;
-export default PersonalMeetingRoomUtil;

package/dist/types/@webex/plugin-meetings/src/reachability/index.d.ts

@@ -1,140 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-/**
- * @class Reachability
- * @export
- */
-export default class Reachability {
-    namespace: string;
-    webex: object;
-    reachabilityRequest: any;
-    clusterLatencyResults: any;
-    /**
-     * Creates an instance of Reachability.
-     * @param {object} webex
-     * @memberof Reachability
-     */
-    constructor(webex: object);
-    /**
-     * fetches reachability data
-     * @returns {Object} reachability data
-     * @public
-     * @async
-     * @memberof Reachability
-     */
-    gatherReachability(): Promise<unknown>;
-    /**
-     * fetches reachability data and checks for cluster reachability
-     * @returns {boolean}
-     * @public
-     * @memberof Reachability
-     */
-    isAnyClusterReachable(): Promise<boolean>;
-    /**
-     * Generate peerConnection config settings
-     * @param {object} cluster
-     * @returns {object} peerConnectionConfig
-     * @private
-     * @memberof Reachability
-     */
-    private buildPeerConnectionConfig;
-    /**
-     * Creates an RTCPeerConnection
-     * @param {object} cluster
-     * @returns {RTCPeerConnection} peerConnection
-     * @private
-     * @memberof Reachability
-     */
-    private createPeerConnection;
-    /**
-     * Gets total elapsed time
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {Number} Milliseconds
-     * @private
-     * @memberof Reachability
-     */
-    private getElapsedTime;
-    /**
-     * creates offer and generates localSDP
-     * @param {object} clusterList cluster List
-     * @returns {Promise} Reachability latency results
-     * @private
-     * @memberof Reachability
-     */
-    private getLocalSDPForClusters;
-    /**
-     * Get list of all unreachable clusters
-     * @returns {array} Unreachable clusters
-     * @private
-     * @memberof Reachability
-     */
-    private getUnreachablClusters;
-    /**
-     * Attach an event handler for the icegatheringstatechange
-     * event and measure latency.
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private handleIceGatheringStateChange;
-    /**
-     * Attach an event handler for the icecandidate
-     * event and measure latency.
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private handleOnIceCandidate;
-    /**
-     * An event handler on an RTCPeerConnection when the state of the ICE
-     * candidate gathering process changes. Used to measure connection
-     * speed.
-     * @private
-     * @param {RTCPeerConnection} peerConnection
-     * @param {number} timeout
-     * @returns {Promise}
-     */
-    private iceGatheringState;
-    /**
-     * Make a log of unreachable clusters.
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private logUnreachableClusters;
-    /**
-     * Calculates time to establish connection
-     * @param {array} iceResults iceResults
-     * @returns {object} reachabilityMap
-     * @private
-     * @memberof Reachability
-     */
-    private parseIceResultsToReachabilityResults;
-    /**
-     * fetches reachability data
-     * @param {object} clusterList
-     * @returns {Promise<localSDPData>} reachability check results
-     * @private
-     * @memberof Reachability
-     */
-    private performReachabilityCheck;
-    /**
-     * Records latency and closes the peerConnection
-     * @param {RTCPeerConnection} peerConnection
-     * @param {number} elapsed Latency in milliseconds
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private setLatencyAndClose;
-    /**
-     * utility function
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private setup;
-}

package/dist/types/@webex/plugin-meetings/src/reachability/request.d.ts

@@ -1,35 +0,0 @@
-export interface ClusterNode {
-    isVideoMesh: boolean;
-    udp: Array<string>;
-    tcp: Array<string>;
-    xtls: Array<string>;
-}
-export type ClusterList = {
-    [key: string]: ClusterNode;
-};
-/**
- * @class ReachabilityRequest
- */
-declare class ReachabilityRequest {
-    webex: any;
-    /**
-     * Creates an instance of ReachabilityRequest.
-     * @param {object} webex
-     * @memberof ReachabilityRequest
-     */
-    constructor(webex: object);
-    /**
-     * gets the cluster information
-     *
-     * @param {boolean} includeVideoMesh whether to include the video mesh clusters in the result or not
-     * @returns {Promise}
-     */
-    getClusters: () => Promise<ClusterList>;
-    /**
-     * gets remote SDP For Clusters
-     * @param {Object} localSDPList localSDPs for the cluster
-     * @returns {Object}
-     */
-    remoteSDPForClusters: (localSDPList: object) => any;
-}
-export default ReachabilityRequest;

package/dist/types/@webex/plugin-meetings/src/reactions/constants.d.ts

@@ -1,3 +0,0 @@
-export declare const REACTION_RELAY_TYPES: {
-    readonly REACTION: "react";
-};

package/dist/types/@webex/plugin-meetings/src/reactions/reactions.d.ts

@@ -1,4 +0,0 @@
-import { Reaction, ReactionServerType, SkinTone, SkinToneType } from './reactions.type';
-declare const Reactions: Record<ReactionServerType, Reaction>;
-declare const SkinTones: Record<SkinToneType, SkinTone>;
-export { Reactions, SkinTones };

package/dist/types/@webex/plugin-meetings/src/reactions/reactions.type.d.ts

@@ -1,52 +0,0 @@
-import { REACTION_RELAY_TYPES } from './constants';
-export type EmoticonData = {
-    type: string;
-    codepoints?: string;
-    shortcodes?: string;
-};
-export type SkinTone = EmoticonData;
-export type Reaction = EmoticonData & {
-    tone?: SkinTone;
-};
-export declare enum ReactionServerType {
-    smile = "smile",
-    sad = "sad",
-    wow = "wow",
-    haha = "haha",
-    celebrate = "celebrate",
-    clap = "clap",
-    thumb_up = "thumb_up",
-    thumb_down = "thumb_down",
-    heart = "heart",
-    fire = "fire",
-    prayer = "prayer",
-    speed_up = "speed_up",
-    slow_down = "slow_down"
-}
-export declare enum SkinToneType {
-    normal = "normal",
-    light = "light",
-    medium_light = "medium_light",
-    medium = "medium",
-    medium_dark = "medium_dark",
-    dark = "dark"
-}
-export type Sender = {
-    participantId: string;
-};
-export type ProcessedReaction = {
-    reaction: Reaction;
-    sender: {
-        id: Sender['participantId'];
-        name: string;
-    };
-};
-type RelayEventData = {
-    relayType: (typeof REACTION_RELAY_TYPES)['REACTION'];
-    reaction: Reaction;
-    sender: Sender;
-};
-export type RelayEvent = {
-    data: RelayEventData;
-};
-export {};