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

package/dist/docs/markdown/plugin-meetings.remotemedia.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; [remoteMedia](./plugin-meetings.remotemedia.md)
+
+## remoteMedia namespace
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) | <p>Class representing a remote audio/video stream.</p><p>Internally it is associated with a specific receive slot and a media request for it.</p> |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [getMaxFs(paneSize)](./plugin-meetings.remotemedia.getmaxfs.md) | Converts pane size into h264 maxFs |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [RemoteMediaEvents](./plugin-meetings.remotemedia.remotemediaevents.md) |  |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [RemoteMediaId](./plugin-meetings.remotemedia.remotemediaid.md) |  |
+|  [RemoteVideoResolution](./plugin-meetings.remotemedia.remotevideoresolution.md) |  |
+

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemedia._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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [(constructor)](./plugin-meetings.remotemedia.remotemedia._constructor_.md)
+
+## remoteMedia.RemoteMedia.(constructor)
+
+Constructs RemoteMedia instance
+
+**Signature:**
+
+```typescript
+constructor(receiveSlot: ReceiveSlot, mediaRequestManager: MediaRequestManager, options?: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  receiveSlot | ReceiveSlot |  |
+|  mediaRequestManager | MediaRequestManager |  |
+|  options | Options | _(Optional)_ |
+

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemedia.csi.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [csi](./plugin-meetings.remotemedia.remotemedia.csi.md)
+
+## remoteMedia.RemoteMedia.csi property
+
+Getter for csi
+
+**Signature:**
+
+```typescript
+get csi(): number;
+```

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemedia.id.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [id](./plugin-meetings.remotemedia.remotemedia.id.md)
+
+## remoteMedia.RemoteMedia.id property
+
+**Signature:**
+
+```typescript
+readonly id: RemoteMediaId;
+```

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

@@ -0,0 +1,40 @@
+<!-- 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; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md)
+
+## remoteMedia.RemoteMedia class
+
+Class representing a remote audio/video stream.
+
+Internally it is associated with a specific receive slot and a media request for it.
+
+**Signature:**
+
+```typescript
+export declare class RemoteMedia extends EventsScope 
+```
+**Extends:** EventsScope
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(receiveSlot, mediaRequestManager, options)](./plugin-meetings.remotemedia.remotemedia._constructor_.md) |  | Constructs RemoteMedia instance |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [csi](./plugin-meetings.remotemedia.remotemedia.csi.md) | <code>readonly</code> | number | Getter for csi |
+|  [id](./plugin-meetings.remotemedia.remotemedia.id.md) | <code>readonly</code> | [RemoteMediaId](./plugin-meetings.remotemedia.remotemediaid.md) |  |
+|  [mediaType](./plugin-meetings.remotemedia.remotemedia.mediatype.md) | <code>readonly</code> | MediaType | Getter for mediaType |
+|  [memberId](./plugin-meetings.remotemedia.remotemedia.memberid.md) | <code>readonly</code> | string | Getter for memberId |
+|  [sourceState](./plugin-meetings.remotemedia.remotemedia.sourcestate.md) | <code>readonly</code> | SourceState | Getter for source state |
+|  [stream](./plugin-meetings.remotemedia.remotemedia.stream.md) | <code>readonly</code> | MediaStream | Getter for remote media stream |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [setSizeHint(width, height)](./plugin-meetings.remotemedia.remotemedia.setsizehint.md) |  | Supply the width and height of the video element to restrict the requested resolution to this size |
+

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemedia.mediatype.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [mediaType](./plugin-meetings.remotemedia.remotemedia.mediatype.md)
+
+## remoteMedia.RemoteMedia.mediaType property
+
+Getter for mediaType
+
+**Signature:**
+
+```typescript
+get mediaType(): MediaType;
+```

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemedia.memberid.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [memberId](./plugin-meetings.remotemedia.remotemedia.memberid.md)
+
+## remoteMedia.RemoteMedia.memberId property
+
+Getter for memberId
+
+**Signature:**
+
+```typescript
+get memberId(): string;
+```

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

@@ -0,0 +1,25 @@
+<!-- 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; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [setSizeHint](./plugin-meetings.remotemedia.remotemedia.setsizehint.md)
+
+## remoteMedia.RemoteMedia.setSizeHint() method
+
+Supply the width and height of the video element to restrict the requested resolution to this size
+
+**Signature:**
+
+```typescript
+setSizeHint(width: any, height: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  width | any | width of the video element |
+|  height | any | height of the video element |
+
+**Returns:**
+
+void
+

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemedia.sourcestate.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [sourceState](./plugin-meetings.remotemedia.remotemedia.sourcestate.md)
+
+## remoteMedia.RemoteMedia.sourceState property
+
+Getter for source state
+
+**Signature:**
+
+```typescript
+get sourceState(): SourceState;
+```

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemedia.stream.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) &gt; [stream](./plugin-meetings.remotemedia.remotemedia.stream.md)
+
+## remoteMedia.RemoteMedia.stream property
+
+Getter for remote media stream
+
+**Signature:**
+
+```typescript
+get stream(): MediaStream;
+```

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

@@ -0,0 +1,14 @@
+<!-- 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; [RemoteMediaEvents](./plugin-meetings.remotemedia.remotemediaevents.md)
+
+## remoteMedia.RemoteMediaEvents variable
+
+**Signature:**
+
+```typescript
+RemoteMediaEvents: {
+    SourceUpdate: string;
+    Stopped: string;
+}
+```

package/dist/docs/markdown/plugin-meetings.remotemedia.remotemediaid.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteMediaId](./plugin-meetings.remotemedia.remotemediaid.md)
+
+## remoteMedia.RemoteMediaId type
+
+**Signature:**
+
+```typescript
+export type RemoteMediaId = string;
+```

package/dist/docs/markdown/plugin-meetings.remotemedia.remotevideoresolution.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; [remoteMedia](./plugin-meetings.remotemedia.md) &gt; [RemoteVideoResolution](./plugin-meetings.remotemedia.remotevideoresolution.md)
+
+## remoteMedia.RemoteVideoResolution type
+
+**Signature:**
+
+```typescript
+export type RemoteVideoResolution = 'thumbnail' | 'very small' | 'small' | 'medium' | 'large' | 'best';
+```

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md)
+
+## remoteMediaGroup namespace
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md) |  |
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md) &gt; [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md) &gt; [(constructor)](./plugin-meetings.remotemediagroup.remotemediagroup._constructor_.md)
+
+## remoteMediaGroup.RemoteMediaGroup.(constructor)
+
+Constructs a new instance of the `RemoteMediaGroup` class
+
+**Signature:**
+
+```typescript
+constructor(mediaRequestManager: MediaRequestManager, receiveSlots: ReceiveSlot[], priority: number, commitMediaRequest: boolean, options?: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  mediaRequestManager | MediaRequestManager |  |
+|  receiveSlots | ReceiveSlot\[\] |  |
+|  priority | number |  |
+|  commitMediaRequest | boolean |  |
+|  options | Options | _(Optional)_ |
+

package/dist/docs/markdown/plugin-meetings.remotemediagroup.remotemediagroup.getremotemedia.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; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md) &gt; [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md) &gt; [getRemoteMedia](./plugin-meetings.remotemediagroup.remotemediagroup.getremotemedia.md)
+
+## remoteMediaGroup.RemoteMediaGroup.getRemoteMedia() method
+
+Gets the array of remote media elements from the group
+
+**Signature:**
+
+```typescript
+getRemoteMedia(filter?: 'all' | 'pinned' | 'unpinned'): RemoteMedia[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filter | 'all' \| 'pinned' \| 'unpinned' | _(Optional)_ 'all' (default) returns both pinned and unpinned |
+
+**Returns:**
+
+[RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md)<!-- -->\[\]
+
+{<!-- -->Array<RemoteMedia>}
+

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md) &gt; [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md) &gt; [includes](./plugin-meetings.remotemediagroup.remotemediagroup.includes.md)
+
+## remoteMediaGroup.RemoteMediaGroup.includes() method
+
+Checks if a given RemoteMedia instance belongs to this group.
+
+**Signature:**
+
+```typescript
+includes(remoteMedia: RemoteMedia, filter?: 'all' | 'pinned' | 'unpinned'): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  remoteMedia | [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) | RemoteMedia instance to check |
+|  filter | 'all' \| 'pinned' \| 'unpinned' | _(Optional)_ controls which remote media from the group to check |
+
+**Returns:**
+
+boolean
+
+true if remote media is found
+

package/dist/docs/markdown/plugin-meetings.remotemediagroup.remotemediagroup.ispinned.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; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md) &gt; [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md) &gt; [isPinned](./plugin-meetings.remotemediagroup.remotemediagroup.ispinned.md)
+
+## remoteMediaGroup.RemoteMediaGroup.isPinned() method
+
+**Signature:**
+
+```typescript
+isPinned(remoteMedia: RemoteMedia): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  remoteMedia | [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) |  |
+
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md) &gt; [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md)
+
+## remoteMediaGroup.RemoteMediaGroup class
+
+**Signature:**
+
+```typescript
+export declare class RemoteMediaGroup 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(mediaRequestManager, receiveSlots, priority, commitMediaRequest, options)](./plugin-meetings.remotemediagroup.remotemediagroup._constructor_.md) |  | Constructs a new instance of the <code>RemoteMediaGroup</code> class |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getRemoteMedia(filter)](./plugin-meetings.remotemediagroup.remotemediagroup.getremotemedia.md) |  | Gets the array of remote media elements from the group |
+|  [includes(remoteMedia, filter)](./plugin-meetings.remotemediagroup.remotemediagroup.includes.md) |  | Checks if a given RemoteMedia instance belongs to this group. |
+|  [isPinned(remoteMedia)](./plugin-meetings.remotemediagroup.remotemediagroup.ispinned.md) |  |  |
+|  [pin(remoteMedia, csi)](./plugin-meetings.remotemediagroup.remotemediagroup.pin.md) |  | Pins a specific remote media instance to a specfic CSI, so the media will no longer come from active speaker, but from that CSI. If no CSI is given, the current CSI value is used. |
+|  [unpin(remoteMedia)](./plugin-meetings.remotemediagroup.remotemediagroup.unpin.md) |  | Unpins a remote media instance, so that it will again provide media from active speakers |
+

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md) &gt; [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md) &gt; [pin](./plugin-meetings.remotemediagroup.remotemediagroup.pin.md)
+
+## remoteMediaGroup.RemoteMediaGroup.pin() method
+
+Pins a specific remote media instance to a specfic CSI, so the media will no longer come from active speaker, but from that CSI. If no CSI is given, the current CSI value is used.
+
+**Signature:**
+
+```typescript
+pin(remoteMedia: RemoteMedia, csi?: CSI): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  remoteMedia | [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) |  |
+|  csi | CSI | _(Optional)_ |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@webex/plugin-meetings](./plugin-meetings.md) &gt; [remoteMediaGroup](./plugin-meetings.remotemediagroup.md) &gt; [RemoteMediaGroup](./plugin-meetings.remotemediagroup.remotemediagroup.md) &gt; [unpin](./plugin-meetings.remotemediagroup.remotemediagroup.unpin.md)
+
+## remoteMediaGroup.RemoteMediaGroup.unpin() method
+
+Unpins a remote media instance, so that it will again provide media from active speakers
+
+**Signature:**
+
+```typescript
+unpin(remoteMedia: RemoteMedia): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  remoteMedia | [RemoteMedia](./plugin-meetings.remotemedia.remotemedia.md) |  |
+
+**Returns:**
+
+void
+

package/dist/docs/markdown/plugin-meetings.triggerproxy.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; [TriggerProxy](./plugin-meetings.triggerproxy.md)
+
+## TriggerProxy variable
+
+**Signature:**
+
+```typescript
+TriggerProxy: any
+```