实时 Kit 用户界面
实时 Kit 用户界面 提供预建的、随时可用的UI组件,用于与 Cloudflare 实时 Kit。 。 。 .
如果您使用特定框架( 或者没有框架 - 见 HTML), 我们还提供专用软件包 :
使用量
首先,随同安装实时Kit UI 实时 Kit数字 :
@cloudflare/realtimekit是提供API处理客户端会议的核心软件包. 你用它来访问和在会议上执行动作.
npm i @cloudflare/realtimekit-ui @cloudflare/realtimekit
然后,你需要初始化一个会议对象 一旦你收到一个 authToken 您的API 参与者.
您从您的后端 API 调用 RealtimeKit 添加参与者 API 获取此功能
authToken用于实时 Kit.
import RealtimeKitClient from '@cloudflare/realtimekit';
const meeting = await RealtimeKitClient.init({
authToken: '<your-auth-token>',
defaults: {
video: true,
audio: true,
},
});
简单使用
在模板文件( 组件. html) 中装入组件 :
<rtk-meeting #myid></rtk-meeting>
然后将会议对象初始化并传递给组件:
import { RtkMeeting } from '@cloudflare/realtimekit-ui';
import RealtimeKitClient from '@cloudflare/realtimekit';
class AppComponent {
title = 'MyProject';
@ViewChild('myid') meetingComponent: RtkMeeting;
rtkMeeting: RtkClient;
async ngAfterViewInit() {
const meeting = await RealtimeKitClient.init({
authToken: '<auth-token>',
defaults: {
video: true,
audio: true,
},
});
meeting.joinRoom();
this.rtkMeeting = meeting;
if (this.meetingComponent) this.meetingComponent.meeting = meeting;
}
}
使用 RtkUi 提供
如果您想要使用单个的 UI 组件来构建您想要的 UI, 您可以使用 RtkUiProvider 为所有儿童提供会议实例,使发展更容易.
<rtk-ui-provider #myid>
<rtk-simple-grid />
</rtk-ui-provider>
然后将会议对象初始化并传递给组件:
import { RtkMeeting } from '@cloudflare/realtimekit-ui';
import RealtimeKitClient from '@cloudflare/realtimekit';
class AppComponent {
title = 'MyProject';
@ViewChild('myid') uiProvider: RtkUiProvider;
rtkMeeting: RtkClient;
async ngAfterViewInit() {
const meeting = await RealtimeKitClient.init({
authToken: '<auth-token>',
defaults: {
video: true,
audio: true,
},
});
meeting.joinRoom();
this.rtkMeeting = meeting;
if (this.uiProvider) this.uiProvider.meeting = meeting;
}
}