npm 包 @yangzaiwangzi/zm-sdk 使用教程

简介

@yangzaiwangzi/zm-sdk 是一款基于 webRTC 技术的视频会议 SDK,支持多人会议、桌面共享、白板涂鸦等常见功能。该 SDK 适用于需要在 web 端实现视频会议功能的前端开发人员,使用简单易上手。

安装

npm 安装:

--- ------- ---------------------

使用前,需要事先在官网申请开发者账号,并获得应用 ID 和密钥。

使用

初始化

在项目中引入 SDK,并初始化会议需要的参数:

------ ----- ---- ------------------------

----- ----- - --- -------
  ------- ---------------
  ---------- ------------------
  -------------- -------------------
  --------- ------------
  --------- -------------------
---

其中,apiKey 和 apiSecret 是申请应用时获得的 API Key 和 API Secret;meetingNumber 是要加入的会议号;userName 是加入会议的用户名;password 是会议密码。

开启会议

使用 startMeeting() 方法开启会议:

---------------------------- -- -
  -- ----
-------------- -- -
  -- ----
---

结束会议

使用 leaveMeeting() 方法结束会议:

---------------------

注意,结束会议后,即使调用成员列表等接口,也将返回空数组。

获取成员列表

使用 getParticipants() 方法获取当前会议中的所有成员:

------------------------------------------- -- -
  --------------------------
-------------- -- -
  -- --------
---

成员列表将以数组形式返回,每个成员对象包括 id(成员唯一标识符)、name(成员名字)等信息。

发送聊天消息

使用 sendChat() 方法向当前会议中的所有成员发送聊天消息:

---------------------- -------------------- -- -
  -- --------
---

其他功能

SDK 还提供了多人视频、桌面共享、白板涂鸦等常见功能,详细使用方法可以参考官方文档。

总结

@yangzaiwangzi/zm-sdk 是一款简单易用的视频会议 SDK,适用于想要在 web 端实现视频会议功能的前端开发人员。本文介绍了该 SDK 的安装、初始化、开始会议、结束会议、获取成员列表、发送聊天消息等功能。希望本文对使用该 SDK 的开发人员有帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60067356890c4f7277583bdd


猜你喜欢

  • npm 包 @skatejs/element 使用教程

    前言 在 Web 前端开发中,我们需要频繁地处理 DOM 元素,包括增删改查、样式操作、事件绑定等等。而这些操作是比较繁琐和容易出错的,因此业界推出了诸如 React、Vue 等流行的前端框架,来解决...

    4 年前
  • npm 包 @skatejs/element-preact 使用教程

    前言 在 Web 前端开发中,组件化编程已经成为了主流,而前端框架为我们提供了丰富的组件库,这些组件库可以帮助我们快速搭建一个现代化的 Web 应用程序。而 @skatejs/element-prea...

    4 年前
  • npm 包 @skatejs/element-react 使用教程

    介绍 在前端开发中,我们经常会用到各种各样的 UI 组件库来辅助开发。而其中,React 就是一个很受欢迎的前端框架。在 React 的基础上,有许多开发者为 React 创造了不同的组件库,如 An...

    4 年前
  • npm 包 @skatejs/element-hyperhtml 使用教程

    前言 在前端开发中,我们经常需要编写自定义标签来扩展 HTML 元素的功能。@skatejs/element-hyperhtml 包提供了一种快速创建自定义元素的方式。

    4 年前
  • npm 包 walking 使用教程

    walking 是一个用于前端项目中文件操作的 npm 包。它提供了一种简单且易用的方式,让你能够轻松地在你的项目中执行文件操作,例如文件的遍历、复制、重命名等。 walking 使用 Node.js...

    4 年前
  • npm 包 iview-sdruan 使用教程

    iView-sdruan 是一个基于 Vue.js 的前端 UI 组件库,它的设计原则是易用、高效、美观,为前端开发者提供了一些日常开发中需要的 UI 元素。 在本文中,我们将介绍如何使用 npm 包...

    4 年前
  • NPM 包 "loading-screen" 使用教程

    在网站或应用中,我们经常需要用到 loading 动画来展示数据正在加载中,这个诉求常常被前端开发人员们高频次使用,为了更好的体验和展示,我们需要一个易用性高且自定义度强的 loading 动画库,那...

    4 年前
  • npm 包 tuxcoind-rpc 使用教程

    在前端开发中,我们经常使用一些第三方库来解决实际的问题。tuxcoind-rpc 就是一种基于 Node.js 的包,可以让前端程序员方便地与 Tuxcoin 区块链进行交互。

    4 年前
  • npm 包 git-gan 使用教程

    前言 在日常的前端开发工作中,我们经常会用到 Git 进行代码版本控制。但是在团队协作中,如何遵循良好的 Git Commit Message 规范,使得团队成员之间更好地理解、沟通代码变更,成为了一...

    4 年前
  • npm 包 react-native-general-actionsheet 使用教程

    前言 在移动应用开发中,很多场景需要用户通过弹出层来选择某项操作。为了方便开发者实现这个功能,React Native 社区著名的第三方组件库 react-native-general-actions...

    4 年前
  • npm 包 lucky-number 使用教程

    1. 什么是 npm 包? npm 是一个开源的 Node.js 包管理器,用于管理 Node.js 模块,以及安装、分享、查询、更新等相关操作。npm 包(npm package)是指符合 npm ...

    4 年前
  • NPM 包 vue-fullcalendars 使用教程

    前言 随着前端架构的发展,越来越多的工具被开发出来来帮助我们更加高效地完成任务。其中,NPM 包是前端开发中不可或缺的一部分。而本篇文章将会介绍一款常用的 NPM 包 —— vue-fullcalen...

    4 年前
  • npm 包 egg-obs 使用教程

    什么是 egg-obs? egg-obs 是基于 egg.js 框架封装的一个 OBS (Object Storage Service) 服务插件。OBS 是一种在线以及离线数据存储服务,它可以容纳海...

    4 年前
  • npm 包 @skatejs/element-lit-html 使用教程

    简介 在前端开发中,我们经常需要通过 JavaScript 来创建和管理页面上的组件。这些组件可以是按钮、输入框、画廊、列表等等一系列用户界面元素。要创建一个高性能、可复用、可维护的组件并不容易。

    4 年前
  • npm 包 @skatejs/sk-context 使用教程

    前言 随着前端应用的不断发展,组件化和状态管理成了必不可少的工具。在 React 生态圈中,Context API 是一个非常重要的状态管理工具,可以帮助我们在父组件和子组件之间传递数据,而在使用的过...

    4 年前
  • npm 包 @skatejs/sk-router 使用教程

    介绍 @skatejs/sk-router 是一个基于 Web Components 的路由框架,它可以让你在你的应用程序中轻松实现页面导航和路由功能。它支持多视图和嵌套路由,允许你通过自定义标签或 ...

    4 年前
  • npm 包 @skatejs/sk-marked 使用教程

    前言 在前端开发中,我们经常需要在页面中展示一些 Markdown 格式的文本。而 @skatejs/sk-marked 是一个可以将 Markdown 格式的文本转换成 HTML 的 npm 包,这...

    4 年前
  • npm 包 @skatejs/cli 使用教程

    前言 在现代 Web 开发中,前端框架和库层出不穷。其中,使用 SkateJS 可以让我们更轻松地构建 Web 组件,以及更好地组织和维护我们的前端代码。 SkateJS 提供了一套生态体系包括:sk...

    4 年前
  • npm 包 @skatejs/element-snabbdom 使用教程

    前言 前端作为一门快速发展的技术,新技术层出不穷。其中,npm 已成为前端开发中不可或缺的一部分,npm 上有许多代码库和工具,可以为我们在开发中提供便利。 @skatejs/element-snab...

    4 年前
  • npm 包 ant-design-draft-mention-plugin 使用教程

    ant-design-draft-mention-plugin 是一个 ant-design-design-pro 的富文本编辑器插件,提供了在富文本编辑器中添加 @ 提及功能的能力。

    4 年前

相关推荐

    暂无文章