更新时间:2024-07-30 GMT+08:00

加入会议

接口功能

该接口用于通过会议ID和密码加入已经存在的会议。在登录和未登录状态下都可以调用该接口。

函数原型

joinConfById(joinConfByIdInfo: JoinConfByIdInfo, onJoinConfByIdResult?: (ret: SDKERR, reason: string) => void): void

请求参数

表1 入参说明
参数名称 是否必选 参数类型 参数说明
joinConfByIdInfo Y JoinConfByIdInfo id入会信息
onJoinConfByIdResult Y (ret: SDKERR, reason: string) => void 通过会议id入会回调
表2 JoinConfByIdInfo
参数名称 是否必选 参数类型 参数说明
confId Y string 会议ID。
password N string 会议密码。若希望以主持人身份入会,必须传入主持人密码。 若希望以来宾身份入会,会议要求来宾密码时,必现传入来宾密码, 会议不要求来宾密码时,可以为空字符串。
nickName N string 会议昵称。在已登录状态下可为空,已登录时为空将使用登录的用户名作为会场名。 匿名入会必须传该名字
isSpeakerOff N boolean 是否关闭扬声器,true关闭扬声器;false不关闭扬声器。
isMicOn N boolean 是否开启麦克风,true开启麦克风;false关闭麦克风。
isCameraOn N boolean 是否开启摄像头,true开启摄像头;false关闭摄像头。
isStopConflictConf N boolean 强制结束和当前VMR会议资源冲突的会议(必需是vmr资源的拥有者才有权限,否则无效)

返回值

void

回调方法参数说明:

(ret: SDKERR, reason: string) => void

表3 入参说明
参数名称 参数类型 参数说明
ret SDKERR 请参考错误码参考 错误码
reason string 错误描述