跳转到内容
搜索文档

RTKParticipant

最后更新 查看 MarkdownAgent 设置

该模块表示会议中的单个参与者。 可以从 meeting.participants 对象中存在的某个参与者列表中访问参与者对象。例如:

const participant1 = meeting.participants.active.get(participantId);
const participant2 = meeting.participants.joined.get(participantId);
const participant3 = meeting.participants.active.toArray()[0];
const participantsNamedJohn = meeting.participants.active.toArray()
  .filter((p) => p.name === 'John');

participant.id

参与者的 Peer ID。 在参与者映射表中,参与者通过此 ID 进行索引。

类型: RTKParticipant 的实例属性

participant.userId

参与者的用户 ID。

类型: RTKParticipant 的实例属性

participant.name

参与者的名称。

类型: RTKParticipant 的实例属性

participant.picture

参与者的头像。

类型: RTKParticipant 的实例属性

participant.customParticipantId

https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/add_participant REST API 期间设置的参与者自定义 ID

类型: RTKParticipant 的实例属性

participant.device

参与者的设备配置。

类型: RTKParticipant 的实例属性

participant.videoTrack

参与者的视频轨道。

类型: RTKParticipant 的实例属性

participant.audioTrack

参与者的音频轨道。

类型: RTKParticipant 的实例属性

participant.screenShareTracks

参与者的屏幕共享视频和音频轨道。

类型: RTKParticipant 的实例属性

participant.videoEnabled

如果启用了参与者的视频,则为 true。

类型: RTKParticipant 的实例属性

participant.audioEnabled

如果启用了参与者的音频,则为 true。

类型: RTKParticipant 的实例属性

participant.screenShareEnabled

如果参与者正在进行屏幕共享,则为 true。

类型: RTKParticipant 的实例属性

participant.producers

由参与者创建的 producer

类型: RTKParticipant 的实例属性

participant.manualProducerConfig

手动订阅期间传递的 producer 配置

类型: RTKParticipant 的实例属性

participant.supportsRemoteControl

如果参与者支持远程控制,则为 true。

类型: RTKParticipant 的实例属性

participant.presetName

参与者的预设。

类型: RTKParticipant 的实例属性

participant.stageStatus

表示参与者当前的舞台状态。

类型: RTKParticipant 的实例属性

participant.isPinned

如果参与者被固定,则返回 true。

类型: RTKParticipant 的实例属性

participant.pin()

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

类型: RTKParticipant 的实例方法

participant.unpin()

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

类型: RTKParticipant 的实例方法

participant.disableAudio()

禁用此参与者的音频。 需要禁用参与者音频的权限。

类型: RTKParticipant 的实例方法

participant.kick()

将此参与者移出会议。 需要移出参与者的权限。

类型: RTKParticipant 的实例方法

participant.disableVideo()

禁用此参与者的视频。 需要禁用参与者视频的权限。

类型: RTKParticipant 的实例方法

participant.registerVideoElement(videoElem)

类型: RTKParticipant 的实例方法

参数 类型
videoElem HTMLVideoElement

participant.deregisterVideoElement([videoElem])

类型: RTKParticipant 的实例方法

参数 类型
[videoElem] HTMLVideoElement

这篇文档对您有帮助吗?