跳转到内容
搜索文档

RTKSelf

最后更新 查看 MarkdownAgent 设置

RTKSelf 模块表示当前用户,并允许在会议中修改用户的状态。可以从此模块检索用户的音频和视频流。

meeting.self.peerId

注 (ishita1805):与 Ravindra 讨论过,为了在使用 Locker 中的标识符时保持一致,添加了一个副本。 我们可能希望在以后弃用 id

类型: RTKSelf 的实例属性

meeting.self.roomState

返回当前会议室状态: init - 初始状态 joined - 用户已在会议中 waitlisted - 用户处于等候名单状态 rejected - 用户曾在等候室中,但准入被拒绝 kicked - 特权用户将该用户移出了会议 left - 用户离开了会议 ended - 会议已结束

类型: RTKSelf 的实例属性

meeting.self.permissions

返回当前赋予该用户参加该会议的权限。

类型: RTKSelf 的实例属性

meeting.self.config

返回会议配置。

类型: RTKSelf 的实例属性

meeting.self.roomJoined

如果本地参与者已加入会议,则返回 true。

类型: RTKSelf 的实例属性

meeting.self.isPinned

如果当前用户被固定,则返回 true。

类型: RTKSelf 的实例属性

meeting.self.cleanupEvents()

类型: RTKSelf 的实例方法

meeting.self.setName(name)

可以通过调用此方法设置用户名称。 只有在加入会议室之前调用此方法,此设置才会反映给其他参与者。

类型: RTKSelf 的实例方法

参数 类型 描述
name string 用户名称。

meeting.self.setupTracks(options)

设置本地媒体轨道。

类型: RTKSelf 的实例方法

参数 类型 描述
options Object 音频和视频选项。
[options.video] boolean 如果为 true,则获取视频流。
[options.audio] boolean 如果为 true,则获取音频流。
[options.forceReset] boolean 如果为 true,则在重新获取之前强制重置轨道。

meeting.self.enableAudio()

此方法用于取消静音本地参与者的音频。

类型: RTKSelf 的实例方法

meeting.self.enableVideo()

此方法用于开始向会议流式传输本地参与者的视频。

类型: RTKSelf 的实例方法

meeting.self.updateVideoConstraints()

此方法用于向当前视频流应用约束。

类型: RTKSelf 的实例方法

meeting.self.enableScreenShare()

此方法用于开始向会议共享本地参与者的屏幕。

类型: RTKSelf 的实例方法

meeting.self.updateScreenshareConstraints()

此方法用于向当前屏幕共享流应用约束。

类型: RTKSelf 的实例方法

meeting.self.disableAudio()

此方法用于静音本地参与者的音频。

类型: RTKSelf 的实例方法

meeting.self.disableVideo()

此方法用于禁用本地参与者的视频。

类型: RTKSelf 的实例方法

meeting.self.disableScreenShare()

此方法用于停止共享本地参与者的屏幕。

类型: RTKSelf 的实例方法

meeting.self.getAllDevices()

返回本地参与者可访问的所有媒体设备。

类型: RTKSelf 的实例方法

meeting.self.pin()

如果用户有权固定参与者,则返回 self.id

类型: RTKSelf 的实例方法

meeting.self.unpin()

如果用户有权取消固定参与者,则返回 self.id

类型: RTKSelf 的实例方法

meeting.self.hide()

在 UI 中隐藏用户的方块图(本地)

类型: RTKSelf 的实例方法

meeting.self.show()

如果在 UI 中隐藏了用户的方块图,则显示它(本地)

类型: RTKSelf 的实例方法

meeting.self.setDevice(device)

更改本地参与者当前使用的媒体设备。

类型: RTKSelf 的实例方法

参数 类型 描述
device MediaDeviceInfo 要使用的设备。相同 kind 的设备将被替换。主要流。

这篇文档对您有帮助吗?