跳转到主要内容

RTKPip

Modules

RTKPip

Functions

getInitials()

Code from ui-kit. Same method used in the avatar component

meeting.participants.pip.disable

Disable PiP

Kind: instance property of RTKPip

meeting.participants.pip.init([options])

Initialize PiP and prepare sources

Kind: instance method of RTKPip

Param Type
[options] Object
[options.height] number
[options.width] number

meeting.participants.pip.disableSource(source)

Kind: instance method of RTKPip

Param Type
source string

meeting.participants.pip.addSource(id, element, enabled, [displayText])

Add a video source from the participant grid

Kind: instance method of RTKPip

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

meeting.participants.pip.updateSource(id, source)

Update a video source

Kind: instance method of RTKPip

Param Type
id string
source any

meeting.participants.pip.removeSource(id)

Remove the video source for the participant

Kind: instance method of RTKPip

Param Description
id id for the source (ex. participant id)

meeting.participants.pip.removePinnedSource(id)

Remove the pinned source

Kind: instance method of RTKPip

Param Description
id id for the source (ex. participant id)

meeting.participants.pip.removeAllSources()

Remove all sources

Kind: instance method of RTKPip

meeting.participants.pip.enable()

Enable PiP

Kind: instance method of RTKPip

Code from ui-kit. Same method used in the avatar component

Kind: global function

这篇文档对你有帮助吗？
想留言或继续讨论？请到 Cyberforums 赛博论坛参与。 参与讨论 / 回复