集成 SDK
更新时间: 2023/07/10 03:08:58
本文为您展示通过 NEMeetingKit 实现音视频会议的相关步骤,帮助您在业务中实现创建会议、预约会议、查询会议信息等在线会议场景下的相关能力。
前提条件
在开始运行示例项目之前,请确保您已完成以下操作:
-
已开通 NERoom 房间组件能力,并选择线上会议场景模板。
开发环境
在客户端实现音视频会议功能之前,请您准备以下开发环境:
环境类型 | 具体要求 |
---|---|
浏览器 |
|
Node | 8 及以上版本 |
注意事项
- 请使用 https 协议访问会议组件的 Domain。
- 不建议通过 require 方式引入 SDK,可能存在选择设备无效等问题。
方式1:通过 script 标签引入 SDK
配置步骤
- 在本地文件夹中创建会议组件的项目文件夹,并将解压后的会议组件 SDK 拷贝到项目文件夹中。文件目录类似如下:
├── index.html
├── NEMeetingKit_V3.x.x.js
-
将如下代码添加到
index.html
页面的body底部 中。<script src="./NEMeetingKit_V3.x.x.js"></script>//将文件路径替换为会议组件在本地的相对路径,版本号请替换为对应的版本号
-
在页面添加 ID 为
ne-web-meeting
的元素(用于挂载会议组件)。<div id="ne-web-meeting"></div>
该 ID 为固定值,请不要修改。
-
初始化会议组件。
NEMeetingKit.actions.init(800, 800, config, (e) => {
// 初始化完成回调
});
示例代码
html<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<div id="ne-web-meeting"></div>
<script src="./NEMeetingKit_v3.x.x.js"></script> //将文件路径替换为会议组件在本地的相对路径,版本号请替换为对应的版本号
<script>
// 先执行项目初始化,将会议初始化操作执行结束后,会依据初始化提供的宽高,进行占位
// 3.8.0版本开始初始化为异步方法,新增回调函数。
NEMeetingKit.actions.init(800, 800, config, (e) => {
// 初始化完成回调
});
</script>
</body>
</html>
方式2:通过 esmodule 方式引入 SDK
- 将会议组件 SDK 拷贝到项目文件夹中。文件目录类似如下:
├── index.js
├── NEMeetingKit_V3.x.x.js
- 将如下代码添加到
index.js
中。
import { actions } from './NEMeetingKit_V3.x.x.js' //将文件路径替换为会议组件在本地的相对路径,版本号请替换为对应的版本号
aciotns.init(800, 800, config, (e) => {
// 初始化完成回调
});
// or
import NEMeetingKit from './NEMeetingKit_V3.x.x.js'
NEMeetingKit.init(800, 800, config, (e) => {
// 初始化完成回调
});
此文档是否对你有帮助?