RTKPip
- getInitials()
Code from ui-kit. Same method used in the avatar component
- _init(context, self)
- init([options])
Initialize PiP and prepare sources
- disableSource(source)
- addSource(id, element, enabled, [displayText])
Add a video source from the participant grid
- updateSource(id, source)
Update a video source
- removeSource(id)
Remove the video source for the participant
- removePinnedSource(id)
Remove the pinned source
- removeAllSources()
Remove all sources
- enable()
Enable PiP
Code from ui-kit. Same method used in the avatar component
Kind: global function
| Param | Type |
|---|---|
| context | Context |
| self | Self |
Initialize PiP and prepare sources
Kind: global function
| Param | Type |
|---|---|
| [options] | Object |
| [options.height] | number |
| [options.width] | number |
Kind: global function
| Param | Type |
|---|---|
| source | string |
Add a video source from the participant grid
Kind: global function
| Param | Type | Description |
|---|---|---|
| id | string | id for the source (ex. participant id) |
| element | HTMLVideoElement | HTMLVideoElement for the video source |
| enabled | boolean | if source is enabled |
| [displayText] | string | two character display text |
Update a video source
Kind: global function
| Param | Type |
|---|---|
| id | string |
| source | any |
Remove the video source for the participant
Kind: global function
| Param | Description |
|---|---|
| id | id for the source (ex. participant id) |
Remove the pinned source
Kind: global function
| Param | Description |
|---|---|
| id | id for the source (ex. participant id) |
Remove all sources
Enable PiP
Kind: global function