简介
@yangzaiwangzi/zm-sdk 是一款基于 webRTC 技术的视频会议 SDK,支持多人会议、桌面共享、白板涂鸦等常见功能。该 SDK 适用于需要在 web 端实现视频会议功能的前端开发人员,使用简单易上手。
安装
npm 安装:
npm install @yangzaiwangzi/zm-sdk
使用前,需要事先在官网申请开发者账号,并获得应用 ID 和密钥。
使用
初始化
在项目中引入 SDK,并初始化会议需要的参数:
-- -------------------- ---- ------- ------ ----- ---- ------------------------ ----- ----- - --- ------- ------- --------------- ---------- ------------------ -------------- ------------------- --------- ------------ --------- ------------------- ---
其中,apiKey 和 apiSecret 是申请应用时获得的 API Key 和 API Secret;meetingNumber 是要加入的会议号;userName 是加入会议的用户名;password 是会议密码。
开启会议
使用 startMeeting() 方法开启会议:
zmSdk.startMeeting().then(() => { // 开启成功 }).catch((err) => { // 开启失败 });
结束会议
使用 leaveMeeting() 方法结束会议:
zmSdk.leaveMeeting();
注意,结束会议后,即使调用成员列表等接口,也将返回空数组。
获取成员列表
使用 getParticipants() 方法获取当前会议中的所有成员:
zmSdk.getParticipants().then((participants) => { console.log(participants); }).catch((err) => { // 获取成员列表失败 });
成员列表将以数组形式返回,每个成员对象包括 id(成员唯一标识符)、name(成员名字)等信息。
发送聊天消息
使用 sendChat() 方法向当前会议中的所有成员发送聊天消息:
zmSdk.sendChat("Hello, world!").catch((err) => { // 发送聊天消息失败 });
其他功能
SDK 还提供了多人视频、桌面共享、白板涂鸦等常见功能,详细使用方法可以参考官方文档。
总结
@yangzaiwangzi/zm-sdk 是一款简单易用的视频会议 SDK,适用于想要在 web 端实现视频会议功能的前端开发人员。本文介绍了该 SDK 的安装、初始化、开始会议、结束会议、获取成员列表、发送聊天消息等功能。希望本文对使用该 SDK 的开发人员有帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60067356890c4f7277583bdd