本指南介绍如何在 Cloudflare RealtimeKit 中针对网络研讨会 (WebRTC) 用例使用舞台管理 API。
传统发布-订阅模型允许用户发布媒体并让其他人选择订阅,而 RealtimeKit 则提供可选的托管配置。在此配置中,可以将权限较低的用户默认设为不发布媒体。用户随后可以请求发布媒体的权限,由特权用户选择授予或拒绝访问。
使用 RealtimeKit 的舞台管理 API,用户可以执行以下操作:
- 离开和加入舞台
- 管理舞台请求和权限
- 移除参与者
可以在 meeting.stage 命名空间下访问舞台模块。
console.log("Stage object:", meeting.stage);console.log("Stage object:", meeting.stage);console.log("Stage object:", meeting.stage);Log.d("Stage", "Stage object: ${meeting.stage}")print("Stage object: \(meeting.stage)")console.log("Stage object:", meeting.stage);meeting.stage.status 属性返回本地用户当前的舞台状态。
console.log("Stage status:", meeting.stage.status);console.log("Stage status:", meeting.stage.status);console.log("Stage status:", meeting.stage.status);Log.d("Stage", "Stage status: ${meeting.stage.stageStatus}")print("Stage status: \(meeting.stage.stageStatus)")console.log("Stage status:", meeting.stage.status);可能的状态值:
ON_STAGE- 用户当前在舞台上,并共享音频和视频。OFF_STAGE- 用户正在观看会话,但不在舞台上,也不共享音频或视频。REQUESTED_TO_JOIN_STAGE- 用户有一个待处理的加入舞台并共享音频和视频的请求。此状态会保持到主持人接受或拒绝请求。ACCEPTED_TO_JOIN_STAGE- 主持人已接受用户加入舞台的请求。
RealtimeKit 的舞台管理 API 允许主持人接收和管理舞台请求,以及离开和加入舞台。
此方法将用户连接到媒体室,使其能够与会议中的其他对等方互动。
await meeting.stage.join();await meeting.stage.join();await meeting.stage.join();meeting.stage.join()meeting.stage.join()await meeting.stage.join();使用此方法后,用户将与媒体室断开连接,无法再与其他对等方通信。此外,房间中的其他人也将无法再看到其音频和视频。
await meeting.stage.leave();await meeting.stage.leave();await meeting.stage.leave();meeting.stage.leave()meeting.stage.leave()await meeting.stage.leave();特权用户可以使用 grantAccess 方法为一组用户授予舞台访问权限。
await meeting.stage.grantAccess(userIds);await meeting.stage.grantAccess(userIds);await meeting.stage.grantAccess(userIds);meeting.stage.grantAccess(userIds)meeting.stage.grantAccess(userIds: userIds)await meeting.stage.grantAccess(userIds);参数:
userIds(string[]) - 要授予舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(string[]) - 要授予舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(string[]) - 要授予舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(List<String>) - 要授予舞台访问权限的用户 ID 列表。可以使用meeting.participants.map { it.userId }检索用户 ID
userIds([String]) - 要授予舞台访问权限的用户 ID 数组。可以使用meeting.participants.map { $0.userId }检索用户 ID
userIds(string[]) - 要授予舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
特权用户可以使用 denyAccess 方法拒绝一组用户访问舞台。
await meeting.stage.denyAccess(userIds);await meeting.stage.denyAccess(userIds);await meeting.stage.denyAccess(userIds);meeting.stage.denyAccess(userIds)meeting.stage.denyAccess(userIds: userIds)await meeting.stage.denyAccess(userIds);参数:
userIds(string[]) - 要拒绝舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(string[]) - 要拒绝舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(string[]) - 要拒绝舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(List<String>) - 要拒绝舞台访问权限的用户 ID 列表。可以使用meeting.participants.map { it.userId }检索用户 ID
userIds([String]) - 要拒绝舞台访问权限的用户 ID 数组。可以使用meeting.participants.map { $0.userId }检索用户 ID
userIds(string[]) - 要拒绝舞台访问权限的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
特权用户可以使用 kick 方法从舞台移除一组用户。
await meeting.stage.kick(userIds);await meeting.stage.kick(userIds);await meeting.stage.kick(userIds);meeting.stage.kick(userIds)meeting.stage.kick(userIds: userIds)await meeting.stage.kick(userIds);参数:
userIds(string[]) - 要从舞台移除的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(string[]) - 要从舞台移除的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(string[]) - 要从舞台移除的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
userIds(List<String>) - 要从舞台移除的用户 ID 列表。可以使用meeting.participants.map { it.userId }检索用户 ID
userIds([String]) - 要从舞台移除的用户 ID 数组。可以使用meeting.participants.map { $0.userId }检索用户 ID
userIds(string[]) - 要从舞台移除的用户 ID 数组。可以使用meeting.participants.toArray().map(p => p.userId)检索用户 ID
RealtimeKit 的舞台管理 API 允许参与者请求和管理舞台访问权限。
此方法用于创建可由主持人批准的新舞台请求。每个用户(观众或主持人)都必须调用此方法才能加入舞台。
主持人调用此方法时,其状态将更新为 ACCEPTED_TO_JOIN_STAGE。
await meeting.stage.requestAccess();await meeting.stage.requestAccess();await meeting.stage.requestAccess();meeting.stage.requestAccess()meeting.stage.requestAccess()await meeting.stage.requestAccess();可以调用此方法取消舞台请求。
await meeting.stage.cancelRequestAccess();await meeting.stage.cancelRequestAccess();await meeting.stage.cancelRequestAccess();meeting.stage.cancelRequestAccess()meeting.stage.cancelRequestAccess()await meeting.stage.cancelRequestAccess();meeting.stage 模块发出以下事件:
舞台访问请求有更新时发出。
meeting.stage.on("stageAccessRequestUpdate", (data) => {
console.log("Stage access request updated:", data);
});也可以使用 React hook 监听舞台更新:
import { useRealtimeKitSelector } from "@cloudflare/realtimekit-react";
// useRealtimeKitSelector hook only works when `RealtimeKitProvider` is used.
const stageStatus = useRealtimeKitSelector((m) => m.stage.status);meeting.stage.on("stageAccessRequestUpdate", (data) => {
console.log("Stage access request updated:", data);
});meeting.stage.on("stageAccessRequestUpdate", (data) => {
console.log("Stage access request updated:", data);
});meeting.addStageEventListener(object : RtkStageEventListener {
override fun onStageAccessRequestsUpdated(accessRequests: List<RtkRemoteParticipant>) {
// Stage access requests list updated
Log.d("Stage", "Access requests updated: ${accessRequests.size}")
}
})extension WebinarViewModel: RtkStageEventListener {
func onStageAccessRequestsUpdated(accessRequests: [RtkRemoteParticipant]) {
// Stage access requests list updated
print("Access requests updated: \(accessRequests.count)")
}
}meeting.stage.on("stageAccessRequestUpdate", (data) => {
console.log("Stage access request updated:", data);
});也可以使用 React hook 监听舞台更新:
import { useRealtimeKitSelector } from "@cloudflare/realtimekit-react-native";
// useRealtimeKitSelector hook only works when `RealtimeKitProvider` is used.
const stageStatus = useRealtimeKitSelector((m) => m.stage.status);主持人接受加入舞台请求或直接邀请用户上台时发出。
meeting.stage.on("acceptPresentRequests", (data) => {
console.log("Present requests accepted:", data);
});meeting.stage.on("acceptPresentRequests", (data) => {
console.log("Present requests accepted:", data);
});meeting.stage.on("acceptPresentRequests", (data) => {
console.log("Present requests accepted:", data);
});meeting.addStageEventListener(object : RtkStageEventListener {
override fun onStageAccessRequestAccepted() {
// Host accepted the join stage request or invited user directly to stage
Log.d("Stage", "Access request accepted")
}
})extension WebinarViewModel: RtkStageEventListener {
func onStageAccessRequestAccepted() {
// Host accepted the join stage request or invited user directly to stage
print("Access request accepted")
}
}meeting.stage.on("acceptPresentRequests", (data) => {
console.log("Present requests accepted:", data);
});本地用户的舞台状态更改时发出。
meeting.stage.on("stageStatusUpdate", (status) => {
console.log("Stage status updated:", status);
});meeting.stage.on("stageStatusUpdate", (status) => {
console.log("Stage status updated:", status);
});meeting.stage.on("stageStatusUpdate", (status) => {
console.log("Stage status updated:", status);
});meeting.addStageEventListener(object : RtkStageEventListener {
override fun onStageStatusUpdated(oldStatus: StageStatus, newStatus: StageStatus) {
// Local user's stage status changed
Log.d("Stage", "Status updated from $oldStatus to $newStatus")
}
})extension WebinarViewModel: RtkStageEventListener {
func onStageStatusUpdated(oldStatus: StageStatus, newStatus: StageStatus) {
// Local user's stage status changed
print("Status updated from \(oldStatus) to \(newStatus)")
}
}meeting.stage.on("stageStatusUpdate", (status) => {
console.log("Stage status updated:", status);
});新参与者请求加入舞台时发出。
meeting.stage.on("newStageRequest", (request) => {
console.log("New stage request:", request);
});meeting.stage.on("newStageRequest", (request) => {
console.log("New stage request:", request);
});meeting.stage.on("newStageRequest", (request) => {
console.log("New stage request:", request);
});meeting.addStageEventListener(object : RtkStageEventListener {
override fun onNewStageAccessRequest(participant: RtkRemoteParticipant) {
// New participant requested to join the stage
Log.d("Stage", "New stage request from: ${participant.name}")
}
})extension WebinarViewModel: RtkStageEventListener {
func onNewStageAccessRequest(participant: RtkRemoteParticipant) {
// New participant requested to join the stage
print("New stage request from: \(participant.name)")
}
}meeting.stage.on("newStageRequest", (request) => {
console.log("New stage request:", request);
});主持人批准舞台请求时发出。
meeting.stage.on("stageRequestApproved", (data) => {
console.log("Stage request approved:", data);
});meeting.stage.on("stageRequestApproved", (data) => {
console.log("Stage request approved:", data);
});meeting.stage.on("stageRequestApproved", (data) => {
console.log("Stage request approved:", data);
});meeting.addStageEventListener(object : RtkStageEventListener {
override fun onStageAccessRequestAccepted() {
// Host accepted the join stage request or invited user directly to stage
Log.d("Stage", "Stage request approved")
}
})extension WebinarViewModel: RtkStageEventListener {
func onStageAccessRequestAccepted() {
// Host accepted the join stage request or invited user directly to stage
print("Stage request approved")
}
}meeting.stage.on("stageRequestApproved", (data) => {
console.log("Stage request approved:", data);
});主持人拒绝舞台请求时发出。
meeting.stage.on("stageRequestRejected", (data) => {
console.log("Stage request rejected:", data);
});meeting.stage.on("stageRequestRejected", (data) => {
console.log("Stage request rejected:", data);
});meeting.stage.on("stageRequestRejected", (data) => {
console.log("Stage request rejected:", data);
});meeting.addStageEventListener(object : RtkStageEventListener {
override fun onStageAccessRequestRejected() {
// Host rejected the join stage request
Log.d("Stage", "Stage request rejected")
}
})extension WebinarViewModel: RtkStageEventListener {
func onStageAccessRequestRejected() {
// Host rejected the join stage request
print("Stage request rejected")
}
}meeting.stage.on("stageRequestRejected", (data) => {
console.log("Stage request rejected:", data);
});