API 参考

主调

MeetingSDK.getVersion()

  • 功能:获取 SDK 版本号
  • 返回值:SDK版本号String
  • 参数:无

示例:

console.log(MeetingSDK.getVersion());

MeetingSDK.init(InitParams)

  • 功能:初始化 SDK
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
InitParams Object 初始化参数,参见下方

InitParams 参数说明

参数 类型 必传 含义
server String 是 会议服务器地址
containerSelector String 是 挂载会议组件的 DOM 容器选择器 id
virtualBackgroundAssets String 否 虚拟背景资源路径
svrTimeout Number 否 网络超时时间(单位:秒),默认为60秒
isRtcLog Boolean 否 是否开启 RTC 日志,默认开启
isSDKConsole Boolean 否 是否开启 SDK 控制台输出,默认开启
MSProtocol Number 否 流媒体传输协议,0:自动,1:UDP,2:TCP,默认1

示例:

await MeetingSDK.init({
  server: 'www.cloudroom.com',
  containerSelector: '#container',
});

MeetingSDK.uninit()

  • 功能:反初始化 SDK
  • 返回值:无
  • 参数:无

示例:

await MeetingSDK.uninit();

MeetingSDK.on(event, handler)

  • 功能:监听 SDK 事件
  • 返回值:无
  • 参数:
参数 类型 含义
event String 事件名称
handler Function 事件处理函数

示例:

MeetingSDK.on('notifyMeetingState', (data) => {
  console.log(data);
});

MeetingSDK.off(event, handler)

  • 功能:取消监听 SDK 事件
  • 返回值:无
  • 参数:
参数 类型 含义
event String 事件名称
handler Function 事件处理函数(可选,不传则取消该事件的所有监听)

示例:

MeetingSDK.off('notifyMeetingState');

MeetingSDK.setParams(SDKParams)

  • 功能:配置 SDK 参数
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
SDKParams Object SDK 配置参数,包含 option 和 custom

SDKParams.option 参数说明

参数 类型 必传 含义
autoOpenMic Boolean 否 入会打开麦克风
autoOpenCam Boolean 否 入会打开摄像头
language String 否 语言(zh:中文,en:英文)
showDuration Boolean 否 显示会议时长
uiStyle Number 否 UI界面风格(0:会议模式;1:1v1通话模式;2:多人通话模式)

注意:uiStyle为非会议模式时,custom参数将不生效

SDKParams.custom 参数说明
类型:Array,每个对象包含以下属性:

属性 类型 必传 含义
id String 是 按钮/组件标识符,可选值参见下方列表
hidden Boolean 否 是否隐藏
text String 否 按钮文本

custom 可配置项列表:PC 端与移动端可配置项不同,请按实际运行端选择对应 id。下表「支持」表示该项可配置对应属性,「—」表示不支持。

PC 端

顶部栏

id 名称 hidden text
topbar_info 会议信息 支持 支持
topbar_netstatus 网络状态 支持 —

底部栏

id 名称 hidden text
bottom_mic 麦克风 支持 支持
bottom_camera 摄像头 支持 支持
bottom_member 成员管理 支持 支持
bottom_invite 邀请 支持 支持
bottom_im 聊天 支持 支持
bottom_share 共享 支持 支持
bottom_stopshare 停止共享 支持 支持
bottom_videolayout 视频布局 支持 支持
bottom_record 录制 支持 支持
bottom_stop_record 停止录制 支持 支持
bottom_breakrooms 分组会议 支持 支持
bottom_more 更多 支持 支持
bottom_goback_mainroom 返回主会场 支持 支持
bottom_exit_meeting 退出 支持 支持

更多菜单

id 名称 hidden text
more_rollcall 点名 支持 支持
more_vote 投票 支持 支持
more_startcaptions 开启字幕 支持 支持
more_stopcaptions 关闭字幕 支持 支持
more_interpretation 同声传译 支持 支持

设置

id 名称 hidden text
setting_general 个人设置 支持 支持
setting_meeting 会议设置 支持 支持
setting_option 参会者权限 支持 支持
setting_audio 音频设置 支持 支持
setting_video 视频设置 支持 支持
setting_vbg 虚拟背景 支持 支持
setting_record 录制 支持 支持
setting_captions 字幕 支持 支持
setting_about 关于我们 支持 支持

共享

id 名称 hidden text
share_title 共享(标题) — 支持
share_screen 屏幕 支持 支持
share_wbdoc 文档/白板 支持 支持
share_media 影音 支持 支持
share_wbdoc_locdoc 本地文档 支持 支持
share_wbdoc_pnetdisk 个人网盘 支持 支持
share_wbdoc_cnetdisk 企业网盘 支持 支持
share_wbdoc_wb 创建白板 支持 支持
share_media_locfile 影音文件 支持 支持

会议信息

id 名称 hidden text
confinfo_title 会议信息(标题) — 支持
confinfo_inviteTab 呼叫邀请 tab 支持 支持
confinfo_meetInfoTab 会议信息 tab — 支持
confinfo_qrcode 扫一扫邀请 支持 支持
confinfo_meetSubject 会议主题 支持 支持
confinfo_meetID 会议号 支持 支持
confinfo_pswd 会议密码 支持 支持
confinfo_host 主持人 支持 支持
confinfo_hostpswd 主持人密码 支持 支持
confinfo_pstn 电话参会 支持 支持
confinfo_pstnpswd 电话参会密码 支持 支持
confinfo_confurl 会议链接 支持 支持
confinfo_copyinvite 复制邀请信息 支持 支持
confinfo_copyMeetUrl 复制会议链接 支持 支持
confinfo_email 邮件邀请 支持 支持

成员管理

id 名称 hidden text
member_inviteBtn 邀请按钮 支持 —

移动端

顶部栏

id 名称 hidden text
topbar_fullscreen 全屏按钮 支持 —
topbar_switchcamera 切换摄像头按钮 支持 —
topbar_info 会议信息 支持 支持
topbar_meetSubject 会议主题 支持 支持
topbar_time 会议时间 支持 —
topbar_exit 退出 支持 支持

底部栏

id 名称 hidden text
bottom_mic 麦克风 支持 支持
bottom_camera 摄像头 支持 支持
bottom_share 共享 支持 支持
bottom_member 成员管理 支持 支持
bottom_more 更多 支持 支持

更多菜单(通过底部「更多」按钮弹出的面板)

id 名称 hidden text
more_startcaptions 开启字幕 支持 支持
more_stopcaptions 关闭字幕 支持 支持
more_record 云端录制 支持 支持
more_stop_record 停止录制 支持 支持
more_vote 投票 支持 支持
more_interpretation 同声传译 支持 支持
more_rollcall 点名 支持 支持
more_chat 聊天 支持 支持
more_vbg 虚拟背景 支持 支持
more_setting 设置 支持 支持

设置(音频/视频设置为 PC 专属,移动端不支持)

id 名称 hidden text
setting_general 个人设置 支持 支持
setting_meeting 会议设置 支持 支持
setting_option 参会者权限 支持 支持
setting_vbg 虚拟背景 支持 支持
setting_record 录制 支持 支持
setting_captions 字幕 支持 支持
setting_about 关于我们 支持 支持

共享(通过底部「共享」按钮弹出的选择面板)

id 名称 hidden text
share_wbdoc_openeddoc 已打开文档 支持 支持
share_wbdoc_cnetdisk 企业网盘 支持 支持
share_wbdoc_pnetdisk 个人网盘 支持 支持
share_wbdoc_wb 创建白板 支持 支持
share_wbdoc_locdoc 本地文档 支持 支持

会议信息

id 名称 hidden text
confinfo_inviteTab 呼叫邀请 tab 支持 支持
confinfo_meetSubject 会议主题 支持 支持
confinfo_meetID 会议号 支持 支持
confinfo_pswd 会议密码 支持 支持
confinfo_host 主持人 支持 支持
confinfo_hostpswd 主持人密码 支持 支持
confinfo_confurl 会议链接 支持 支持
confinfo_copyinvite 复制邀请信息 支持 支持
confinfo_tipText 加密保护提示 支持 支持
confinfo_netStateTab 网络状态 tab 支持 支持
confinfo_netstatus 网络状态 支持 —

示例:

await MeetingSDK.setParams({
  option: { autoOpenMic: true },
  custom: [
    { id: 'bottom_record', hidden: true }, // 隐藏录制按钮
    { id: 'bottom_share', text: '屏幕共享' }, // 修改共享按钮文本
  ],
});

MeetingSDK.login(loginParams)

  • 功能:登录
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
loginParams Object 登录参数

loginParams 参数说明

参数 类型 必传 含义
account String 是 账号
md5_pswd String 是 MD5 加密后的密码

示例:

await MeetingSDK.login({ account: 'user', md5_pswd: '...' });

MeetingSDK.logout()

  • 功能:登出
  • 返回值:Promise<errCode>
  • 参数:无

示例:

await MeetingSDK.logout();

MeetingSDK.joinMeeting(option)

  • 功能:加入会议
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
option Object 入会参数

option 参数说明

参数 类型 必传 含义
meetID String 是 会议号
pswd String 否 密码

示例:

await MeetingSDK.joinMeeting({ meetID: '123456' });

MeetingSDK.joinMeetingWithoutLogin(option)

  • 功能:免登录加入会议
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
option Object 免登录入会参数

option 参数说明

参数 类型 必传 含义
meetID String 是 会议号
pswd String 否 密码
userID String 否 用户 ID (不传自动生成)
userName String 否 用户昵称 (不传使用 userID)
asHost Boolean 否 是否作为主持人入会

示例:

await MeetingSDK.joinMeetingWithoutLogin({ meetID: '123456' });

MeetingSDK.leaveMeeting()

  • 功能:离开会议
  • 返回值:Promise<errCode>
  • 参数:无

示例:

await MeetingSDK.leaveMeeting();

MeetingSDK.acceptCall(callID)

  • 功能:接受呼叫邀请。一般在收到 notifyCallIn 后调用;接受后通常需再调用 joinMeeting,入会参数可使用回调数据中的会议信息(参见示例)。
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
callID String 呼叫 ID,来自 notifyCallIn 回调中的字段

示例:

MeetingSDK.on('notifyCallIn', async (data) => {
  const { callID, meetInfo } = data;
  await MeetingSDK.acceptCall(callID);
  await MeetingSDK.joinMeeting({
    meetID: meetInfo.meetID,
    pswd: meetInfo.pswd,
  });
});

MeetingSDK.declineCall(callID)

  • 功能:拒绝呼叫邀请。
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
callID String 呼叫 ID,来自 notifyCallIn 回调中的字段

示例:

MeetingSDK.on('notifyCallIn', (data) => {
  MeetingSDK.declineCall(data.callID);
});

MeetingSDK.setCustomInviteType(type)

  • 功能:设置会议内「邀请」相关的自定义模式。
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
type Number 邀请模式,取值见下表

type 取值说明:

值 含义 说明
0 默认 使用 SDK 内置邀请流程
1 自定义 UI 用户点击邀请按钮时触发 notifyInviteBtnClicked,由业务自行实现邀请界面
2 自定义组织架构 用户点击邀请时触发 notifyQueryOrgInfo,业务通过 setCustomOrgInfo 回传组织与用户数据;用户选定后触发 notifyInviteUsers

示例(可在入会成功后调用):

// 自定义 UI 模式
await MeetingSDK.setCustomInviteType(1);
// 自定义组织架构模式
await MeetingSDK.setCustomInviteType(2);

MeetingSDK.setCustomOrgInfo(orgInfo)

  • 功能:在自定义组织架构邀请模式(setCustomInviteType(2))下,响应 notifyQueryOrgInfo 时向 SDK 上报部门树与联系人列表。
  • 返回值:Promise<errCode>
  • 参数:
参数 类型 含义
orgInfo Object 组织架构数据,字段见下

orgInfo 字段说明:

字段 类型 必传 含义
contactDepartsData Array 是 部门数据,每项含 id、pId(父部门 id,根为 0)、departName
contactData Array 是 用户数据,每项含 userId、userName、departId(所属部门 id)

示例:

MeetingSDK.on('notifyQueryOrgInfo', () => {
  MeetingSDK.setCustomOrgInfo({
    contactDepartsData: [
      { id: 1, pId: 0, departName: '部门1' },
      { id: 3322, pId: 1, departName: '子部门' },
    ],
    contactData: [
      { userId: 91000332344, userName: 'user1', departId: 1 },
    ],
  });
});

MeetingSDK.log(logStr)

  • 功能:打印日志到 SDK 内部日志系统
  • 返回值:无
  • 参数:
参数 类型 含义
logStr String 日志内容

示例:

MeetingSDK.log('Test Log');

回调

notifyMeetingState

  • 功能:参会状态通知
  • 参数:
参数 类型 含义
state Object 会议状态,0:未在会议中 1:进入中 2:会议中

示例:

MeetingSDK.on('notifyMeetingState', (state) => {
  // ...
});

notifyLineOff

  • 功能:掉线通知
  • 参数:
参数 类型 含义
sdkErr Object 错误描述对象

sdkErr:

属性 类型 含义
errCode Number 错误码
errDesc String 错误描述

示例:

MeetingSDK.on('notifyLineOff', (sdkErr) => {
  if (sdkErr.errCode == 10) {
    alert('账号异地登录,您已被迫下线!');
  }
});

notifyUserJoined

  • 功能:用户进入会议
  • 参数:
参数 类型 含义
userInfo Object 用户信息对象

userInfo:

属性 类型 含义
userID String 用户 ID
userName String 用户名称

示例:

MeetingSDK.on('notifyUserJoined', (userInfo) => {
  Message(`用户:${userInfo.userName}进入会议`);
});

notifyUserLeft

  • 功能:用户离开会议
  • 参数:
参数 类型 含义
userInfo Object 用户信息对象

userInfo:

属性 类型 含义
userID String 用户 ID
userName String 用户名称

示例:

MeetingSDK.on('notifyUserLeft', (userInfo) => {
  Message(`用户:${userInfo.userName}离开会议`);
});

notifyCallIn

  • 功能:收到其他端发起的呼叫或会议邀请。业务可展示接听/拒绝界面,并配合 acceptCall、declineCall、joinMeeting 处理。
  • 参数:
参数 类型 含义
data Object 邀请详情,字段由会议内核/信令下发,常见字段见下

data定义:

属性 类型 含义
callID String 呼叫 ID,拒绝/接受时传给 SDK
caller Object 主叫方信息(如昵称等,结构以实际为准)
meetInfo Object 会议信息,通常含 meetID、pswd、subject 等,接受后可用于 joinMeeting

示例:

MeetingSDK.on('notifyCallIn', (data) => {
  const { callID, meetInfo, caller } = data;
  // 展示邀请 UI,用户确认后:
  // await MeetingSDK.acceptCall(callID);
  // await MeetingSDK.joinMeeting({ meetID: meetInfo.meetID, pswd: meetInfo.pswd });
});

notifyCallInCanceled

  • 功能:当前呼叫邀请已被取消或失效(例如对方挂断、超时等)。业务应关闭邀请弹窗并清理本地保存的邀请状态。
  • 参数:
参数 类型 含义
data Object data常见字段见下

data定义:

属性 类型 含义
callID String 呼叫ID,收到邀请时传入

示例:

MeetingSDK.on('notifyCallInCanceled', (data) => {
  const callID = data.callID;
  // 关闭邀请弹窗,清空 currentCallInvite 等状态
});

notifyInviteBtnClicked

  • 功能:在通过 setCustomInviteType 设置为自定义 UI 模式(值为 1)时,用户在会议内点击「邀请」类按钮后触发。由业务自行弹出邀请界面或跳转自有选人流程(不再使用 SDK 内置邀请 UI)。
  • 参数:
参数 类型 含义
data Object 上下文数据,结构以实际回调为准

示例:

MeetingSDK.on('notifyInviteBtnClicked', (data) => {
  console.log('用户点击邀请', data);
});

notifyQueryOrgInfo

  • 功能:在 setCustomInviteType 为自定义组织架构模式(值为 2)时,用户打开邀请流程需要组织/联系人数据时触发。业务应在回调中调用 setCustomOrgInfo 将部门与用户列表回传给 SDK。
  • 参数:
参数 类型 含义
data Object 查询上下文,结构以实际回调为准;可不依赖具体字段,直接回传全量组织数据

示例:

MeetingSDK.on('notifyQueryOrgInfo', (data) => {
  MeetingSDK.setCustomOrgInfo({
    contactDepartsData: [/* ... */],
    contactData: [/* ... */],
  });
});

notifyInviteUsers

  • 功能:在自定义组织架构模式下,用户在 SDK 邀请界面中选定联系人并确认发起邀请后触发。业务可根据 data 执行自有邀请逻辑(如服务端下发邀请)。
  • 参数:
参数 类型 含义
data Object 被选中的用户等信息,结构以实际回调为准

示例:

MeetingSDK.on('notifyInviteUsers', (data) => {
  console.log('待邀请用户', data);
});