API参考

主调

MeetingSDK.init(SDKInitDat)

  • 功能:初始化SDK
  • 返回值:errCode, 0代表调用成功
  • 参数:
参数 类型 含义
SDKInitDat Object 初始化参数

SDKInitDat参数说明

参数 类型 含义
server String 服务器地址,格式:{domain}:{port}, 默认端口可以省略。 如:http://192.168.0.25
sdkLogPath String SDK日志路径

MeetingSDK.uninit()

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

MeetingSDK.setParams(jsonStr)

  • 功能:配置SDK参数

  • 返回值:errCode, 0代表调用成功

  • 参数:

参数 类型 含义
jsonStr string json格式, 示例:{"option":{"autoOpenMic":1,"autoOpenCam":1,"language":"zh_CN","meetDuration":1},"custom":[{"name":"topbar_info","hide":1},{"name":"bottom_mic","text":"麦"}]}

jsonStr参数说明:

参数 类型 说明
option object 入会选项,支持以下参数:
自动打开麦克风:"autoOpenMic":0/1
自动打开摄像头:"autoOpenCam":0/1
语言:"language":"zh_CN"/"en_US"
显示参会时长:"meetDuration":0/1
整体配色:"colorType":""/"blue"
界面风格:"uiStyle":0/1/2。 0:会议(默认)、1:1对1通话、2:多人通话
custom array 自定义界面元素列表,详见下方UIElementDef

UIElementDef 说明:

参数 类型 说明
name string 界面元素标识,参见后面定义
hide number 是否强制隐藏,取值:0(默认值)/1, 1:代表隐藏
text string 自定义显示文字,为空代表保持默认值

界面元素标识定义:

标识 描述 支持隐藏 自定义显示文字
topbar_info 顶部_信息 支持 不支持
topbar_security 顶部_安全 支持 不支持
topbar_netstatus 顶部_网络状态 支持 不支持
topbar_local_record 顶部_本地录制 支持 不支持
topbar_server_record 顶部_云端录制 支持 不支持
topbar_meet_lock 顶部_会议锁定 支持 不支持
topbar_live 顶部_直播 支持 不支持
topbar_fullscreen 顶部_全屏 支持 不支持
bottom_mic 底部_麦克风 支持 支持
bottom_camera 底部_摄像头 支持 支持
bottom_exit_meeting 底部_离开会议 支持 支持
bottom_goback_mainroom 底部_返回主会场 支持 支持
bottom_invite 底部_邀请 支持 支持
bottom_member 底部_成员 支持 支持
bottom_im 底部_聊天 支持 支持
bottom_startshare 底部_开启共享 支持 支持
bottom_stopshare 底部_停止共享 支持 支持
bottom_videolayout 底部_视频布局 支持 支持
bottom_record 底部_录制 支持 不支持
bottom_breakrooms 底部_分组会议 支持 支持
bottom_more 底部_更多 支持 支持
more_live 更多_直播 支持 支持
more_rollcall 更多_点名 支持 支持
more_vote 更多_投票 支持 支持
more_setting 更多_系统设置 支持 支持
more_startcaptions 更多_开启字幕 支持 支持
more_stopcaptions 更多_关闭字幕 支持 支持
more_transcripts 更多_文字转写 支持 支持
more_aiassistant 更多_AI助手 支持 支持
more_interpretation 更多_同声传译 支持 支持
setting_general 设置_通用设置 支持 支持
setting_meeting 设置_会议设置 支持 支持
setting_option 设置_参会者权限 支持 支持
setting_audio 设置_音频设置 支持 支持
setting_video 设置_视频设置 支持 支持
setting_vbg 设置_虚拟背景 支持 支持
setting_beauty 设置_美颜 支持 支持
setting_loc_storage 设置_本地存储 支持 支持
setting_record 设置_录制设置 支持 支持
setting_captions 设置_字幕和转写 支持 支持
setting_netmonitor 设置_系统监测 支持 支持
share_wbdoc 共享_文档/白板 支持 支持
share_screen 共享_屏幕 支持 支持
share_media 共享_影音 支持 支持
share_cam 共享_视频设备 支持 支持
share_wbdoc_locdoc 共享_文档/白板_本地文件 支持 支持
share_wbdoc_pnetdisk 共享_文档/白板_个人网盘 支持 支持
share_wbdoc_cnetdisk 共享_文档/白板_企业网盘 支持 支持
share_wbdoc_wb 共享_文档/白板_创建白板 支持 支持
share_media_locfile 共享_影音_影音文件 支持 支持
share_media_netfile 共享_影音_网络影音 支持 支持
invite_call 邀请_呼叫邀请 支持 支持
pstn 电话呼入 支持 不支持
confinfo_qrcode 会议信息_扫一扫邀请 支持 不支持
confinfo_confurl 会议信息_会议链接 支持 不支持
confinfo_hostpswd 会议信息_主持人密码 支持 不支持
confinfo_pswd 会议信息_会议密码 支持 不支持
confinfo_email 会议信息_邮件邀请 支持 不支持

MeetingSDK.login(account, md5_password)

  • 功能:登录, 登录结果请参见 onLoginRslt
  • 返回值:无
  • 参数:
参数 类型 含义
account String 登录的帐号
md5_password String 登录密码的md5值

MeetingSDK.logout()

  • 功能:登出
  • 返回值:无

MeetingSDK.joinMeeting(meetID, meetPswd)

  • 功能:加入会议, 入会状态请参见 onJoinMeetingState
  • 返回值:无
  • 参数:
参数 类型 含义
meetID Number 会议号
meetPswd String 会议密码,没有会议密码时不传或传空

MeetingSDK.joinMeetingWithoutLogin(meetID, meetPswd, userID, userName, asHost)

  • 功能:免登录加入会议, 入会状态请参见 onJoinMeetingState
  • 返回值:无
  • 参数:
参数 类型 含义
meetID Number 会议号
meetPswd String 会议密码,没有会议密码时请传空
userID String 入会使用的用户ID,空代表不指定userID
userName String 入会姓名
asHost Bool 是否以主持人身份入会

MeetingSDK.leaveMeeting()

  • 功能:离开当前会议
  • 返回值:无

MeetingSDK.acceptCall(callID)

  • 功能:接受会议邀请。接收邀请之后,需要调用 joinMeeting 进入指定会议。
  • 返回值:无
  • 参数:
参数 类型 含义
callID String 邀请ID

MeetingSDK.declineCall(callID)

  • 功能:拒接会议邀请
  • 返回值:无
  • 参数:
参数 类型 含义
callID String 邀请ID

MeetingSDK.setCustomInviteType(type)

  • 功能:设置自定义邀请模式

  • 返回值:无

  • 参数:

参数 类型 含义
type CUSTOM_INVITE_TYPE 自定义邀请模式,模式工作逻辑请参见会议邀请模式

MeetingSDK.setCustomOrgInfo(orgInfo)

  • 功能:设置自定义组织结构设置给SDK
  • 返回值:无
  • 参数:
参数 类型 含义
orgInfo String 自定义企业组织结构数据,json字符串

orgInfo格式举例:
"{"contactData":[{"departId":1,"userId":"100","userName":"test"}],"contactDepartsData":[{"departName":"测试部门","id":1,"pId":0}]}"

参数 类型 说明
contactData array 用户列表数据
departId Number 用户所属部门id
userId string 用户id
userName string 用户姓名
contactDepartsData array 部门列表
departName string 部门名称
id Number 部门id
pId Number 部门的上级部门id,0代表无上级部门

回调

MeetingSDK.onLoginRslt(sdkErrCode)

  • 功能:登录结果
  • 返回值:无
  • 参数:
参数 类型 含义
errCode Number 登录结果,0代表登录成功

MeetingSDK.notifyLineOff(reason)

  • 功能:掉线通知
  • 返回值:无
  • 参数:
参数 类型 含义
reason Number 掉线的原因

MeetingSDK.onJoinMeetingState(state, sdkErrCode)

  • 功能:参会状态通知
  • 返回值:无
  • 参数:
参数 类型 含义
state Number 状态
errCode Number 入会失败的原因值

MeetingSDK.notifyCallIn(callID, caller, meetInfo)

  • 功能:会议邀请通知
  • 返回值:无
  • 参数:
参数 类型 含义
callID String 邀请的唯一标识
caller String 邀请者的名称。如果是WEB API发起的邀请,此处将为会议号
meetInfo String 会议信息,json格式:"{"meetID":12345678, "pswd":"abcd"}"

MeetingSDK.notifyCallInCanceled(callID)

  • 功能:会议邀请取消通知
  • 返回值:无
  • 参数:
参数 类型 含义
callID String 邀请的唯一标识

MeetingSDK.notifyInvite(meetingNativeWID)

  • 功能:通知用户在会议中点击了邀请按钮

在邀请模式为“自定义邀请UI模式”下,用户点击了会议界面中“邀请按钮”时,sdk将回调notifyInvite;

  • 返回值:无

  • 参数:

参数 类型 含义
meetingNativeWID number 会议程序的窗口句柄。
Windows: HWND
linux:窗口ID
macOS: window number

MeetingSDK.notifyQueryOrgInfo()

  • 功能:SDK请求自定义组织结构
  • 返回值:无

MeetingSDK.notifyInviteUsers(users)

  • 功能:通知邀请的人员
  • 返回值:无
  • 参数:
参数 类型 含义
users String 邀请的用户信息,json格式:"{"users":["userID1", "userID2"]}"

MeetingSDK.notifyUserJoined(userID, userName)

  • 功能:通知有人入会
  • 返回值:无
  • 参数:
参数 类型 含义
userID String 用户ID
userName String 用户姓名

MeetingSDK.notifyUserLeft(userID, userName)

  • 功能:通知有人离会
  • 返回值:无
  • 参数:
参数 类型 含义
userID String 用户ID
userName String 用户姓名