ar-meet

this SDK from anyrtc developer group.

Usage no npm install needed!

<script type="module">
  import arMeet from 'https://cdn.skypack.dev/ar-meet';
</script>

README

一、快速开始

集成指南

适用范围

本集成文档适用于Web RTMeetEngine SDK 3.0.0及以上版本。

兼容情况

导入SDK

npm 市场
npm install ar-meet --save-dev

import ArMeetKit from 'ar-meet';
  • 安装或更新至最新版本：
npm install ar-meet@latest --save-dev

import ArMeetKit from 'ar-meet';
js 引用
<script src="yourAssetsPath/ArMeetKit.版本.js"></script>

开发指南

1. 初始化SDK

集成SDK后，还需对SDK在页面进行初始化操作。

1.1 导入js SDK
import ArMeetKit from 'ar-meet';
1.2 实例化对象

options为会议配置项，包括用户信息、会议类型、视频分辨率、会议身份类型、码率自适应等。

let meet = new ArMeetKit(options);
1.3 监听回调
//加入会议成功
meet.on("join-success", () => {
  
});
//加入会议失败
//根据code码查询错误原因
meet.on("join-failed", (code) => {
  
});
//设置其他人视频显示窗口
//对方（或己方）同意视频通话请求后，会收到此回调，收到后需要将`mediaRender`添加展示到页面上。
meet.on("stream-subscribed", (peerUserId, pubId, userId, rtcUserData, mediaRender) => {
  
});
//其他人离开移除视频显示窗口
meet.on("stream-unsubscribed", (peerUserId, pubId, userId, rtcUserData) => {
  
});
1.4 配置开发者信息

配置开发者信息，开发者信息可在anyRTC管理后台中获得，详见创建anyRTC账号。

//配置开发者信息
meet.initAppInfo(APP_ID, APP_TOKEN);

//配置私有云(默认无需配置)
//meet.configServer(SERVE_URL);

2. 加入房间

2.1 设置本地视频采集窗口

设置本地显示窗口，参数constraints为音视频配置项。

meet.setLocalVideoCapturer({
  video: true,
  audio: true
}).then(res => {
  document.body.appendChild(res.mediaRender);
  //预览本地流成功之后的操作：比如加入房间
}).catch(err => {
  throw err;
})
2.2 加入会议

roomID为房间号。

meet.joinRTC(roomID);

3. 离开房间

离开房间方法。

meet.leaveRTC();

二、API接口文档

ArMeet 实例化

1.初始化实例

示例
let meet = new ArMeetKit(Options);
参数
参数名 类型 描述
Options Object 实例配置

Options

参数名 类型 描述
meetMode Number 会议模式： 0 视频会议 1 主持人模式；2 ZOOM模式; 默认0（视频会议）
audioMeet Boolean 音频会议： false 视频会议 true 音频会议；默认false（音视频会议）
videoProfile String 视频分辨率
userRole Number 用户身份：0 与会者 1 主持人 2 监看者；默认0;（注：会议模式为0时用户身份仅有与会者和监看者身份生效，当会议模式为1时仅与会者和主持人身份生效）
logLevel String 打印日志级别： info、warning、error
userId String 自定义用户ID
userData String 自定义用户数据，推荐JSON字符串
autoBitrate boolean 是否开启码流自适应

videoProfile

参数名 类型 描述
ARVideoProfile120P String 160*120 65
ARVideoProfile180P String 320*180 140
ARVideoProfile240P String 320*240 200
ARVideoProfile360P String 640*360 400
ARVideoProfile360P_1 String 640*360 512
ARVideoProfile480P String 640*480 512
ARVideoProfile480P_1 String 640*480 768
ARVideoProfile720P String 1280*720 1280
ARVideoProfile1080P String 1920*1080 2048

2. 配置开发者信息

示例
meet.initAppInfo(appId, appToken);
参数
参数名 类型 描述
appId String anyRTC云平台的应用ID
appToken String anyRTC云平台的应用Token
说明

该方法为配置开发者信息，上述参数均可在https://www.anyrtc.io/ 应用管理中获得。

3. 配置私有云

示例
meet.configServer(address);
参数
参数名 类型 描述
address String 私有云服务地址（HTTPS环境不支持IP）
说明

配置服务器地址，私有云需要配置，否则无需配置（如果网站是HTPPS 服务器地址不支持IP）

4. 获取SDK版本号

示例
meet.getSDKVersion();
说明

返回RTMeeting SDK版本号。

ArMeet 接口类

1. 获取媒体设备

示例
meet.getDevices(deviceType);
参数
参数名 类型 描述
deviceType string 媒体设备类型videoinput、audioinput、audiooutput，分别是摄像头、麦克风、扬声器

Return

Promise对象

Promise.then 返回的参数data对象，包含所查询的设备列表，如果deviceType为空则返回videoinput、videooutput、audioinput三个类型的设备列表

说明

获取设备列表，根据设备列表的id可以切换指定摄像头以及指定扬声器作为音频输出设备。

2. 设置本地视频采集窗口

示例
meet.setLocalVideoCapturer(constraints);
参数
参数名 类型 描述
constraints Object 音视频配置（非必填项）

constraints

参数名 类型 描述
video Object 视频配置；
audio Object 音频配置；
video 类型 描述
enable Boolean true为采集摄像头， false;
deviceId String deviceId: 设备ID，可通过getDevices方法获取
audio 类型 描述
enable Boolean true为采集麦克风， false;
deviceId String deviceId: 设备ID，可通过getDevices方法获取

Return

Promise对象

Promise.then 返回的参数data

data 描述
mediaStream MediaStream
mediaRender HTMLDivElement
说明

预览本地音视频，如果video.enable为true时，表示允许采集摄像头；video.deviceId表示采集指定摄像头的媒体流。

3. 切换设备

示例
meet.switchDevice(constraints);
参数
参数名 类型 描述
constraints Object 音视频配置（非必填项）

constraints

参数名 类型 描述
video Object 视频配置；
audio Object 音频配置；
video 类型 描述
enable Boolean true为采集摄像头， false;
devideId String devideId: 设备ID，可通过getDevices方法获取
audio 类型 描述
enable Boolean true为采集麦克风， false;
devideId String devideId: 设备ID，可通过getDevices方法获取

Return

Promise对象

Promise.then 返回的参数data

data 描述
mediaStream MediaStream
mediaRender HTMLDivElement
说明

切换设备获取新的媒体流，mediaStream视频流用于绑定咋video标签的src属性里面，mediaRender则是DOM对象，可直接添加到页面。

4. 设置本地视频是否传输

示例
meet.setLocalVideoEnable(enable);
参数
参数名 类型 描述
enable Boolean true为传输视频，false为不传输视频，默认视频传输

5. 设置本地音频是否传输

示例
meet.setLocalAudioEnable(enable);
参数
参数名 类型 描述
enable Boolean true为传输视频，false为不传输视频，默认视频传输

6. 获取本地视频传输是否打开

示例
meet.getLocalVideoEnable();
说明

视频是否传输。

7. 获取本地音频传输是否打开

示例
meet.getLocalAudioEnable();
说明

音频是否传输。

8. 设置远端音视频是否传输

示例
meet.setRemoteAVEnable(peerId, audioEnable, videoEnable);
参数
参数名 类型 描述
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
audioEnable Boolean 音频是否传输
videoEnable Boolean 视频是否传输

9. 打开共享通道

示例
meet.openShare(type);
参数
参数名 类型 描述
type Number 自定义共享通道标识id
说明

打开共享通道之后，将会收到share-result回调。

10. 设置共享信息

示例
meet.setShareInfo(shareInfo);
参数
参数名 类型 描述
shareInfo String 自定义共享信息，推荐JSON字符串
说明

打开共享通道成功(share-result )之后调用，其他端在收到share-opened回调时将收到该参数。

11. 关闭共享通道

示例
meet.closeShare(type);
参数
参数名 类型 描述
type Number 自定义共享通道标识id
说明

结束共享，其他参会者将会收到share-closed

12. 开始屏幕共享

示例
meet.startScreenCap(scrnStream);
参数
参数名 类型 描述
scrnStream MediaStream 屏幕共享媒体流
说明

该接口表示发布该屏幕共享流，发布共享流之前，需要获取到屏幕共享流，具体使用请前往npm 市场查看ar-share-screen。

13. 结束屏幕共享

示例
meet.stopScreenCap();
说明

停止该屏幕共享流。

14. 加入房间

示例
meet.joinRTC(roomId, userToken);
参数
参数名 类型 描述
roomId String 房间唯一标识ID
userToken String 用于企业认证，如果开通了企业认证的客户，需要使用该方法进行初始化设置

15. 发送用户实时消息

示例
meet.sendUserMessage(userName, userHeaderUrl, content);
参数
参数名 类型 描述
userName String 自定义用户昵称（最大256字节）
userHeaderUrl String 自定义头像URL（最大512字节）
content String 自定义消息内容，推荐JSON字符串（最大1024字节）

16. 设置某路视频广播 -- (仅主持人模式有效)

示例
meet.setBroadCast(enable, peerId);
参数
参数名 类型 描述
enable Boolean 是否广播用户图像: true为广播，false为不广播
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
说明

主持人模式，主持人可以看到所有用户的图像，与会者只能看到主持人模式，如果主持人广播某人的视频，其他都可以看到被广播者的图像。取消广播，将会移除被广播者的图像。

17. 设置是否单独聊天 -- (仅主持人模式有效)

示例
meet.setTalkOnly(enable, peerId);
参数
参数名 类型 描述
enable Boolean 是否设置单聊: true为广播，false为不广播
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
说明

主持人设置单聊对象，房间内的人将不能听到单聊双方的语音。

18. 离开房间

示例
meet.leaveRTC();
说明

释放实例。离开页面或退出房间时需要调用此方法，其他端才会收到用户离开的回调，否则会有视图残留在页面。

19. 设置音频检测是否打开

示例
meet.setAudioActiveCheck(enable);
参数
参数名 类型 描述
enable Boolean true打开，false关闭，默认关闭

20. 获取音频检测是否打开

示例
meet.getAudioActiveCheck();
说明

获取网络状态。

21. 设置网络质量是否打开

示例
meet.setNetworkStatus(enable);
参数
参数名 类型 描述
enable Boolean true打开，false关闭，默认关闭

22. 获取当前网络状态是否打开

示例
meet.getNetworkStatus();
说明

获取网络状态。

23. 设置zoom模式

示例
meet.setZoomMode(zoomMode);
参数
参数名 类型 描述
zoomMode Number 0为演讲者模式；1为画廊模式；默认演讲者模式。

24. 切换zoom模式

示例
meet.switchZoomMode(zoomMode);
参数
参数名 类型 描述
zoomMode Number 0为演讲者模式；1为画廊模式；默认演讲者模式。

25. 获取人员列表

示例
meet.getUserList();
说明

人员列表。

ArMeet 回调接口

1. 加入会议成功

示例
meet.on('join-success', () => {});

2. 加入会议失败

示例
meet.on('join-failed', (code) => {});
参数
参数名 类型 描述
code Number 错误码，详情查看错误码

3. 远程媒体流已订阅

示例
meet.on('stream-subscribed', (peerId, pubId, userId, userData, mediaRender) => {});
参数
参数名 类型 描述
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
pubId String RTC服务生成媒体流的唯一标识ID
userId String 自定义用户ID(该加入人员的用户信息，初始化实例时携带的userId)
userData String 自定义用户数据(该加入人员的用户信息，初始化实例时携带的userData)
mediaRender String 远程视频
说明

已订阅远程媒体流，创建该媒体流的视图窗口，等待接收媒体流并展示。

4. 远程媒体流被移除

示例
meet.on('stream-unsubscribed', (peerId, pubId, userId, userData) => {});
参数
参数名 类型 描述
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
pubId String RTC服务生成媒体流的唯一标识ID
userId String 自定义用户ID(该加入人员的用户信息，初始化实例时携带的userId)
userData String 自定义用户数据(该加入人员的用户信息，初始化实例时携带的userData)
说明

远程媒体流被移除，取消订阅并移除该媒体流的视图窗口。

5. 远程屏幕共享媒体流已订阅

示例
meet.on('exstream-subscribed', (peerId, pubId, userId, userData, mediaRender) => {});
参数
参数名 类型 描述
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
pubId String RTC服务生成媒体流的唯一标识ID
userId String 自定义用户ID(该加入人员的用户信息，初始化实例时携带的userId)
userData String 自定义用户数据(该加入人员的用户信息，初始化实例时携带的userData)
mediaRender String 远程视频
说明

已订阅远程的屏幕共享媒体流，创建该媒体流的视图窗口，等待接收媒体流并展示。

6. 远程屏幕共享媒体流被移除

示例
meet.on('exstream-unsubscribed', (peerId, pubId, userId, userData) => {});
参数
参数名 类型 描述
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
pubId String RTC服务生成媒体流的唯一标识ID
userId String 自定义用户ID(该加入人员的用户信息，初始化实例时携带的userId)
userData String 自定义用户数据(该加入人员的用户信息，初始化实例时携带的userData)
说明

远程的屏幕共享媒体流被移除，取消订阅并移除该媒体流的视图窗口。

注意：一个用户（peerId）最多可以发布两路媒体流（pubId），当人员离开时，该人员发布的两路媒体流将会被移除；只有发布了主流，才能发布辅流(屏幕共享)。

7. 远程人员媒体流的音视频状态

示例
meet.on('av-status', (isRemote, pubId, audioEnable, videoEnable) => {});
参数
参数名 类型 描述
isRemote Boolean 是否是远程用户
pubId String RTC服务生成媒体流的唯一标识ID
audioEnable Boolean 音频状态；true为打开；false为打开。
videoEnable Boolean 视频状态；true为打开；false为打开。
说明

远程人员媒体流的音视频状态回调，当远程人员setLocalVideoEnable和setLocalAudioEnable时，房间其他人员将会收到此回调。

8. 音频音量大小变化

示例
meet.on('audio-volume', (isRemote, pubId, audioVolume) => {});
参数
参数名 类型 描述
isRemote Boolean 是否是远程用户
pubId String RTC服务生成媒体流的唯一标识ID
audioVolume Number 音量范围为 0 到 100 之间的整数。通常在列表中音量大于 5 的用户为持续说话的人
说明

提示房间内谁在说话以及说话者的音量。每30毫秒回调一次。

9. 网络状态变化

示例
meet.on('network-status', (isRemote, pubId, videoBytes, ARNetQulity) => {});
参数
参数名 类型 描述
isRemote Boolean 是否是远程用户
pubId String RTC服务生成媒体流的唯一标识ID
videoBytes Number 视频码率
ARNetQulity String 网络状况，根据丢包率严重分为5个等级，ARNetQualityExcellent(优)、ARNetQualityGood（良好）、ARNetQualityAccepted（一般）、ARNetQualityBad（差）、ARNetQualityVBad(极差)
说明

网络状态每一秒回调一次。

10. 共享通道被开启

示例
meet.on('share-opened', (shareType, shareInfo, userId, userData) => {});
参数
参数名 类型 描述
shareType Number 共享者设置的自定义共享通道ID
shareInfo String 共享者设置的自定义共享信息
userId String 自定义用户ID
userData String 自定义用户数据
说明

远程人员打开共享通道openShare。

11. 共享通道被关闭

示例
meet.on('share-closed', () => {});
说明

远程人员关闭共享通道close-share。

12. 打开共享通道结果

示例
meet.on('share-result', (isOpen) => {});
参数
参数名 类型 描述
isOpen Boolean 是否打开成功
说明

当调用openShare时，该回调将会返回打开共享通道是否成功。

13. 收到用户消息

示例
meet.on('user-message', (userId, userName, userAvatar, msgContent) => {});
参数
参数名 类型 描述
userId String 自定义用户ID(发送者userId)
userName String 自定义用户昵称（sendUserMessage携带的用户昵称）
userAvatar String 自定义用户头像(sendUserMessage携带的用户头像)
msgContent String 自定义消息内容(sendUserMessage携带的消息内容)
说明

收到房间内用户发送的实时消息，根据实时消息可以进行一些业务拓展（消息主体可以以JSON字符串的形式传出，收到消息之后进行解析），比如: 踢人等。

14. 本地图像第一帧

示例
meet.on('local-video-size', (videoWidth, videoHeight) => {});
参数
参数名 类型 描述
videoWidth Number 视频宽度
videoHeight Number 视频高度
说明

本地图像返回的第一帧，目前仅返回视频图像的大小，如果与设置的分辨率不匹配说明摄像头不支持不支持预设分辨，已切换为最佳分辨率。

15. 主持人上线 -- (仅主持人模式可用)

示例
meet.on('hoster-online', (peerId, userId, userData) => {});
参数
参数名 类型 描述
peerId String RTC服务生成的标识Id (用于标识与会者，每次加入会议随机生成)
userId String 自定义用户ID(主持人的用户ID)
userData String 自定义用户数据(主持人的用户数据)
说明

说明主持人在线。该回调只有在会议模式为主持人模式时才能生效；

16. 主持人下线 -- (仅主持人模式可用)

示例
meet.on('hoster-offline', (peerId) => {});
参数
参数名 类型 描述
peerId String 主持人离开 (用于标识与会者，每次加入会议随机生成)
说明

说明主持人下线。该回调只有在会议模式为主持人模式时才能生效；

17. 主持人开启1V1单聊 -- (仅主持人模式可用)

示例
meet.on('talk-only-on', (peerId, userId, userData) => {});
参数
参数名 类型 描述
peerId String 主持人离开 (用于标识与会者，每次加入会议随机生成)
userId String 自定义用户ID(主持人的用户ID)
userData String 自定义用户数据(主持人的用户数据)
说明

主持人设置了1V1单聊，仅单聊双方双方的语音互通，其他禁音但是可以接收视频图像，音频会议除外。

19. 主持人结束1V1单聊 -- (仅主持人模式可用)

示例
meet.on('talk-only-off', (peerId) => {});
参数
参数名 类型 描述
peerId String 主持人离开 (用于标识与会者，每次加入会议随机生成)
说明

主持人关闭了1V1单聊。

20. 获取zoom演讲者模式下的信息

示例
meet.on('zoom-info', (zoomMode, pubRender) => {});
参数
参数名 类型 描述
zoomMode Number zoom模式(0演讲者，1画廊)
pubRender Number 人数（不包括自己）
说明

获取演讲者模式下的人数信息。

21. 当前说话的演讲者

示例
meet.on('zoom-speaker', (zoomMode, pubId, zoomUserMember) => {});
参数
参数名 类型 描述
zoomMode Number zoom模式(0演讲者，1画廊)
pubId String RTC服务生成媒体流的唯一标识ID
zoomMode Number zoom模式房间人数
说明

主持人关闭了1V1单聊。

三、更新日志

Version 3.0.15 （2019-10-23）

  • 完善并优化SDK
  • 解决关闭共享抛出异常的BUG

Version 3.0.14 （2019-08-08）

  • join-success回调添加回调参数
  • 添加取消订阅的信令交互

Version 3.0.13 （2019-07-16）

  • 修复火狐浏览器关闭屏幕共享异常

Version 3.0.12 （2019-07-12）

  • 解决关闭视频之后导致后续参会人员黑屏的BUG
  • 添加重复订阅机制

Version 3.0.9 （2019-06-21）

  • 添加超时提示、优化SDK

Version 3.0.7 （2019-06-10）

  • 修复已知BUG

Version 3.0.6 （2019-05-31）

  • 添加takeVideoRenderSnapshot、downloadVideoRenderSnapshot和attachSinkId方法

  • 修复主持人模式异常

Version 3.0.5 （2019-05-27）

  • 更新文档，文档添加getDevices和switchDevice的介绍

  • 修复远程图像显示不全的问题

Version 3.0.4 （2019-05-24）

  • stream-subscribed、exstream-subscribed、stream-unsubscribed、exstream-unsubscribed回调添加userId回调参数，作为第三个回调参数返回

  • 修复切换摄像头的内部错误

Version 3.0.2 （2019-05-21）

  • 修复会议窗口显像过慢的问题

Version 3.0.1 （2019-05-21）

  • 修复开启屏幕共享的用户离会之后屏幕共享提示框残留的问题

Version 3.0.0 （2019-05-18）

  • SDK版本升级3.0，API接口变更，更加简洁规范