易米WebRTC SDK接口使用指南与注意事项

需积分: 0 4 下载量 91 浏览量 更新于2024-06-30 收藏 267KB PDF 举报
"本文档主要介绍了易米WebRTC SDK的API接口使用,包括两种使用方式:通过HTML页面的script标签引入CDN和通过npm安装后在webpack或gulp中使用。同时,强调了内部数据交互依赖浏览器的localStorage以及WebRTC需在HTTPS环境下运行的要求。" 在WebRTC领域,易米WebRTC SDK提供了一整套解决方案,使得用户可以在浏览器中实现点对点的音频通信。SDK分为1.x和2.x两个版本,对应不同的呼叫平台系统。对于SDK的使用,文档给出了两种方法: 1. 传统方式:在HTML页面中使用`<script>`标签直接引入CDN上的API接口文件。然而,需要注意的是,由于CDN会自动指向最新版本,因此如果需要特定版本,如1.5.4或2.0.6,应当直接指定版本号。例如,引入1.5.4版本的代码如下: ```html <script src='https://unpkg.com/jssip-emicnet@1.5.4/dist/phonebar.js'></script> ``` 2. NPM安装方式:适用于使用webpack或gulp等现代前端构建工具的项目。首先,通过npm安装`jssip-emicnet`包: ```bash npm install jssip-emicnet ``` 然后,在代码中导入并使用: ```javascript let phonebar = require("jssip-emicnet/dist/phonebar"); // 或者 import phonebar from 'jssip-emicnet/dist/phonebar'; ``` 在使用这些API接口时,有几个关键点需要特别注意: - 内部数据交互依赖于浏览器的localStorage,因此所有API调用必须在浏览器环境中执行,不适用于Node.js环境。 - WebRTC通信必须在HTTPS安全协议下进行,以确保数据传输的安全。在本地开发时,可以使用localhost来绕过HTTPS限制,但在实际部署时必须使用HTTPS,并开启麦克风访问权限。 文档中虽然没有提供具体的API接口示例,但提到可以通过`phonebar`对象调用相关API,这通常包括注册、呼叫、挂断等操作。实际开发中,开发者需要参考SDK提供的详细文档来了解如何初始化、创建会话、处理事件等。 最后,如果使用Babel进行代码转换,需要确保配置正确,如设置目标浏览器版本,以确保SDK能在广泛使用的浏览器版本上运行。 易米WebRTC SDK为开发者提供了便捷的API接口,通过合理的集成,可以在浏览器中快速搭建稳定的音视频通信应用。开发者需要注意的是,选择合适的接入方式,理解其依赖环境,以及正确配置构建工具,以确保SDK能正常工作。