@webex/plugin-meetings 3.0.0-beta.9 → 3.0.0-bnr.1

package/dist/docs/markdown/plugin-meetings.meetings._constructor_.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [(constructor)](./plugin-meetings.meetings._constructor_.md)
+
+## Meetings.(constructor)
+
+Initializes the Meetings Plugin 
+
+ Meetings
+
+**Signature:**
+
+```typescript
+constructor(...args: any[]);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  args | any\[\] |  |
+

package/dist/docs/markdown/plugin-meetings.meetings.create.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [create](./plugin-meetings.meetings.create.md)
+
+## Meetings.create() method
+
+Create a meeting.
+
+**Signature:**
+
+```typescript
+create(destination: string, type?: string, useRandomDelayForInfo?: boolean): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  destination | string | sipURL, spaceId, phonenumber, or locus object<!-- -->} |
+|  type | string | _(Optional)_ the optional specified type, such as locusId |
+|  useRandomDelayForInfo | boolean | _(Optional)_ whether a random delay should be added to fetching meeting info |
+
+**Returns:**
+
+any
+
+{<!-- -->Promise<Meeting>} A new Meeting.
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.fetchuserpreferredwebexsite.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [fetchUserPreferredWebexSite](./plugin-meetings.meetings.fetchuserpreferredwebexsite.md)
+
+## Meetings.fetchUserPreferredWebexSite() method
+
+Fetch user preferred webex site information This also has other infomation about the user
+
+**Signature:**
+
+```typescript
+fetchUserPreferredWebexSite(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->Promise<!-- -->}   Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.geohintinfo.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [geoHintInfo](./plugin-meetings.meetings.geohintinfo.md)
+
+## Meetings.geoHintInfo property
+
+**Signature:**
+
+```typescript
+geoHintInfo: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.getallmeetings.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [getAllMeetings](./plugin-meetings.meetings.getallmeetings.md)
+
+## Meetings.getAllMeetings() method
+
+Get all meetings.
+
+**Signature:**
+
+```typescript
+getAllMeetings(options?: {
+        startDate: object;
+        endDate: object;
+    }): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | { startDate: object; endDate: object; } | _(Optional)_ |
+
+**Returns:**
+
+any
+
+{<!-- -->Object<!-- -->} All currently active meetings.
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.getgeohint.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [getGeoHint](./plugin-meetings.meetings.getgeohint.md)
+
+## Meetings.getGeoHint() method
+
+Get geoHint for info for meetings
+
+**Signature:**
+
+```typescript
+getGeoHint(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->Promise<!-- -->}   Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.getlogger.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [getLogger](./plugin-meetings.meetings.getlogger.md)
+
+## Meetings.getLogger() method
+
+Get the logger instance for plugin-meetings
+
+**Signature:**
+
+```typescript
+getLogger(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->Logger<!-- -->}
+

package/dist/docs/markdown/plugin-meetings.meetings.getmeetingbytype.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [getMeetingByType](./plugin-meetings.meetings.getmeetingbytype.md)
+
+## Meetings.getMeetingByType() method
+
+get a specifc meeting given it's type matched to the value, i.e., locus url
+
+**Signature:**
+
+```typescript
+getMeetingByType(type: string, value: object): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | string |  |
+|  value | object |  |
+
+**Returns:**
+
+any
+
+{<!-- -->Meeting<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.getpersonalmeetingroom.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [getPersonalMeetingRoom](./plugin-meetings.meetings.getpersonalmeetingroom.md)
+
+## Meetings.getPersonalMeetingRoom() method
+
+gets the personal meeting room instance, for saved PMR values for this user
+
+**Signature:**
+
+```typescript
+getPersonalMeetingRoom(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->PersonalMeetingRoom<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.getreachability.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [getReachability](./plugin-meetings.meetings.getreachability.md)
+
+## Meetings.getReachability() method
+
+gets the reachability instance for Meetings
+
+**Signature:**
+
+```typescript
+getReachability(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->Reachability<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.getscheduledmeetings.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [getScheduledMeetings](./plugin-meetings.meetings.getscheduledmeetings.md)
+
+## Meetings.getScheduledMeetings() method
+
+Get all scheduled meetings.
+
+**Signature:**
+
+```typescript
+getScheduledMeetings(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->Object<!-- -->} All scheduled meetings.  Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.loggerrequest.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [loggerRequest](./plugin-meetings.meetings.loggerrequest.md)
+
+## Meetings.loggerRequest property
+
+**Signature:**
+
+```typescript
+loggerRequest: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.md

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md)
+
+## Meetings class
+
+Maintain a cache of meetings and sync with services. 
+
+**Signature:**
+
+```typescript
+export default class Meetings extends WebexPlugin 
+```
+**Extends:** WebexPlugin
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(args)](./plugin-meetings.meetings._constructor_.md) |  | <p>Initializes the Meetings Plugin </p><p> Meetings</p> |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [geoHintInfo](./plugin-meetings.meetings.geohintinfo.md) |  | any |  |
+|  [loggerRequest](./plugin-meetings.meetings.loggerrequest.md) |  | any |  |
+|  [media](./plugin-meetings.meetings.media.md) |  | any |  |
+|  [meetingCollection](./plugin-meetings.meetings.meetingcollection.md) |  | any |  |
+|  [meetingInfo](./plugin-meetings.meetings.meetinginfo.md) |  | any |  |
+|  [namespace](./plugin-meetings.meetings.namespace.md) |  | string |  |
+|  [personalMeetingRoom](./plugin-meetings.meetings.personalmeetingroom.md) |  | any |  |
+|  [preferredWebexSite](./plugin-meetings.meetings.preferredwebexsite.md) |  | any |  |
+|  [reachability](./plugin-meetings.meetings.reachability.md) |  | any |  |
+|  [registered](./plugin-meetings.meetings.registered.md) |  | any |  |
+|  [request](./plugin-meetings.meetings.request.md) |  | any |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [create(destination, type, useRandomDelayForInfo)](./plugin-meetings.meetings.create.md) |  | Create a meeting. |
+|  [fetchUserPreferredWebexSite()](./plugin-meetings.meetings.fetchuserpreferredwebexsite.md) |  | Fetch user preferred webex site information This also has other infomation about the user |
+|  [getAllMeetings(options)](./plugin-meetings.meetings.getallmeetings.md) |  | Get all meetings. |
+|  [getGeoHint()](./plugin-meetings.meetings.getgeohint.md) |  | Get geoHint for info for meetings |
+|  [getLogger()](./plugin-meetings.meetings.getlogger.md) |  | Get the logger instance for plugin-meetings |
+|  [getMeetingByType(type, value)](./plugin-meetings.meetings.getmeetingbytype.md) |  | get a specifc meeting given it's type matched to the value, i.e., locus url |
+|  [getPersonalMeetingRoom()](./plugin-meetings.meetings.getpersonalmeetingroom.md) |  | gets the personal meeting room instance, for saved PMR values for this user |
+|  [getReachability()](./plugin-meetings.meetings.getreachability.md) |  | gets the reachability instance for Meetings |
+|  [getScheduledMeetings()](./plugin-meetings.meetings.getscheduledmeetings.md) |  | Get all scheduled meetings. |
+|  [register()](./plugin-meetings.meetings.register.md) |  | Explicitly sets up the meetings plugin by registering the device, connecting to mercury, and listening for locus events. |
+|  [setReachability()](./plugin-meetings.meetings.setreachability.md) |  | initializes the reachability instance for Meetings |
+|  [startReachability()](./plugin-meetings.meetings.startreachability.md) |  | initializes and starts gathering reachability for Meetings |
+|  [syncMeetings()](./plugin-meetings.meetings.syncmeetings.md) |  | syncs all the meeting from server |
+|  [unregister()](./plugin-meetings.meetings.unregister.md) |  | Explicitly tears down the meetings plugin by deregistering the device, disconnecting from mercury, and stops listening to locus events |
+|  [uploadLogs(options)](./plugin-meetings.meetings.uploadlogs.md) |  | Uploads logs to the webex services for tracking |
+

package/dist/docs/markdown/plugin-meetings.meetings.media.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [media](./plugin-meetings.meetings.media.md)
+
+## Meetings.media property
+
+**Signature:**
+
+```typescript
+media: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.meetingcollection.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [meetingCollection](./plugin-meetings.meetings.meetingcollection.md)
+
+## Meetings.meetingCollection property
+
+**Signature:**
+
+```typescript
+meetingCollection: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.meetinginfo.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [meetingInfo](./plugin-meetings.meetings.meetinginfo.md)
+
+## Meetings.meetingInfo property
+
+**Signature:**
+
+```typescript
+meetingInfo: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.namespace.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [namespace](./plugin-meetings.meetings.namespace.md)
+
+## Meetings.namespace property
+
+**Signature:**
+
+```typescript
+namespace: string;
+```

package/dist/docs/markdown/plugin-meetings.meetings.personalmeetingroom.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [personalMeetingRoom](./plugin-meetings.meetings.personalmeetingroom.md)
+
+## Meetings.personalMeetingRoom property
+
+**Signature:**
+
+```typescript
+personalMeetingRoom: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.preferredwebexsite.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [preferredWebexSite](./plugin-meetings.meetings.preferredwebexsite.md)
+
+## Meetings.preferredWebexSite property
+
+**Signature:**
+
+```typescript
+preferredWebexSite: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.reachability.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [reachability](./plugin-meetings.meetings.reachability.md)
+
+## Meetings.reachability property
+
+**Signature:**
+
+```typescript
+reachability: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.register.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [register](./plugin-meetings.meetings.register.md)
+
+## Meetings.register() method
+
+Explicitly sets up the meetings plugin by registering the device, connecting to mercury, and listening for locus events.
+
+**Signature:**
+
+```typescript
+register(): Promise<void>;
+```
+**Returns:**
+
+Promise&lt;void&gt;
+
+{<!-- -->Promise<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.registered.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [registered](./plugin-meetings.meetings.registered.md)
+
+## Meetings.registered property
+
+**Signature:**
+
+```typescript
+registered: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.request.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [request](./plugin-meetings.meetings.request.md)
+
+## Meetings.request property
+
+**Signature:**
+
+```typescript
+request: any;
+```

package/dist/docs/markdown/plugin-meetings.meetings.setreachability.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [setReachability](./plugin-meetings.meetings.setreachability.md)
+
+## Meetings.setReachability() method
+
+initializes the reachability instance for Meetings
+
+**Signature:**
+
+```typescript
+setReachability(): void;
+```
+**Returns:**
+
+void
+
+{<!-- -->undefined<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.startreachability.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [startReachability](./plugin-meetings.meetings.startreachability.md)
+
+## Meetings.startReachability() method
+
+initializes and starts gathering reachability for Meetings
+
+**Signature:**
+
+```typescript
+startReachability(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->Promise<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.syncmeetings.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [syncMeetings](./plugin-meetings.meetings.syncmeetings.md)
+
+## Meetings.syncMeetings() method
+
+syncs all the meeting from server
+
+**Signature:**
+
+```typescript
+syncMeetings(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->undefined<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.unregister.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [unregister](./plugin-meetings.meetings.unregister.md)
+
+## Meetings.unregister() method
+
+Explicitly tears down the meetings plugin by deregistering the device, disconnecting from mercury, and stops listening to locus events
+
+**Signature:**
+
+```typescript
+unregister(): any;
+```
+**Returns:**
+
+any
+
+{<!-- -->Promise<!-- -->}
+
+ Meetings
+

package/dist/docs/markdown/plugin-meetings.meetings.uploadlogs.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [Meetings](./plugin-meetings.meetings.md) &gt; [uploadLogs](./plugin-meetings.meetings.uploadlogs.md)
+
+## Meetings.uploadLogs() method
+
+Uploads logs to the webex services for tracking
+
+**Signature:**
+
+```typescript
+uploadLogs(options?: {
+        callStart?: string;
+        feedbackId?: string;
+        locusId?: string;
+        correlationId?: string;
+        meetingId?: string;
+        userId?: string;
+        orgId?: string;
+    }): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | { callStart?: string; feedbackId?: string; locusId?: string; correlationId?: string; meetingId?: string; userId?: string; orgId?: string; } | _(Optional)_ |
+
+**Returns:**
+
+any
+
+{<!-- -->String<!-- -->} feedback ID logs were submitted under
+

package/dist/docs/markdown/plugin-meetings.reactions.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [REACTIONS](./plugin-meetings.reactions.md)
+
+## REACTIONS namespace
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [Reactions](./plugin-meetings.reactions.reactions.md) |  |
+|  [SkinTones](./plugin-meetings.reactions.skintones.md) |  |
+

package/dist/docs/markdown/plugin-meetings.reactions.reactions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [REACTIONS](./plugin-meetings.reactions.md) &gt; [Reactions](./plugin-meetings.reactions.reactions.md)
+
+## REACTIONS.Reactions variable
+
+**Signature:**
+
+```typescript
+Reactions: Record<ReactionServerType, Reaction>
+```

package/dist/docs/markdown/plugin-meetings.reactions.skintones.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [REACTIONS](./plugin-meetings.reactions.md) &gt; [SkinTones](./plugin-meetings.reactions.skintones.md)
+
+## REACTIONS.SkinTones variable
+
+**Signature:**
+
+```typescript
+SkinTones: Record<SkinToneType, SkinTone>
+```

package/dist/docs/markdown/plugin-meetings.remotemedia.getmaxfs.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [getMaxFs](./plugin-meetings.remotemedia.getmaxfs.md)
+
+## remoteMedia.getMaxFs() function
+
+Converts pane size into h264 maxFs
+
+**Signature:**
+
+```typescript
+export declare function getMaxFs(paneSize: RemoteVideoResolution): number;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  paneSize | [RemoteVideoResolution](./plugin-meetings.remotemedia.remotevideoresolution.md) |  |
+
+**Returns:**
+
+number
+
+{<!-- -->number<!-- -->}
+