README in English.
这个开源示例项目演示了如何快速集成 Agora 信令 SDK 实现一个简单的视频电话应用。
在这个示例项目中包含了以下功能:
- 登录信令服务器
- 键入对方姓名,进行视频电话
- 接收对方的视频电话,进行视频电话
- 注销
首先在 Agora.io 注册 注册账号,并创建自己的测试项目,获取到 AppID。 然后选择测试项目里的编辑,App Certificate 点击启用,根据操作拿到App Certificate。 将 AppID 和App Certificate 填写进 meeting.js 中的两个常量中
const appid = "YOUR_SIGNALING_APPID", appcert = "YOUR_SIGNALING_APP_CERTIFICATE";
将您获得的信令SDK文件'AgoraSig-.js' 与 视频通讯SDK文件 'AgoraRTC-.js' 置于'/src/assets/vendor'目录下。在项目根目录使用npm安装项目依赖,并使用gulp打包出发布文件
# install dependency
npm install
# generate dist
gulp build
根目录下会生成dist目录,注意请勿直接使用浏览器将html当作静态文件使用文件协议打开,必须使用http/https协议,也就是说请部署服务器或使用 Python simpleHTTPServer 模块。
在登录信令服务器时可提供一个参数token,一般由服务器计算提供作为身份凭证,默认不使用,如需使用,请重写signalingClient.js中的login函数
//...
let session = this.signal.login(account,'_no_need_token');
//...
在使用视频通讯服务时可提供动态key,一般由服务器计算提供作为身份凭证,默认不适用,如需使用,请修改rtc.js中的getDynamicKey函数
getDynamicKey(channelName){
// if dynamic not enabled
return new Deferred().resolve(undefined).promise();
// if dynamic key enabled
// return $.ajax({
// url: 'service url to get your dynamic key'
// })
}
- 完整的 API 文档见 文档中心
- 如果在集成中遇到问题, 你可以到 开发者社区 提问
- 如果有售前咨询问题, 可以拨打 400 632 6626,或加入官方Q群 12742516 提问
- 如果需要售后技术支持, 你可以在 Agora Dashboard 提交工单
- 如果发现了示例代码的 bug, 欢迎提交 issue
The MIT License (MIT).