文档首页/ 华为云会议 Meeting/ 客户端SDK参考/ HarmonyOS SDK/ 接口参考/ 会议控制/ 加入会议
更新时间：2025-01-09 GMT+08:00
查看PDF
分享

加入会议

joinConf

接口描述

该接口用于通过会议ID和密码加入已经存在的会议。

注意事项

在登录后才可以调用该接口。

方法定义

1
 
joinConf(joinConfModel: HWMOpenJoinConfByIdParamModel): Promise<HWMJoinConfByIdResult>;

参数描述

参数

是否必须

类型

描述

joinConfModel

是

HWMOpenJoinConfByIdParamModel

加入会议参数。
表1 HWMOpenJoinConfByIdParamModel参数说明

参数

是否必须

类型

描述

externBaseJoinConfParam

是

HWMOpenExternBaseJoinConfParamModel

加入会议基本信息。

confPassword

否

string

会议密码。若希望以主持人身份入会，必须传入主持人密码。若希望以来宾身份入会，会议要求来宾密码时，必须传入来宾密码，会议不要求来宾密码时，可以为空字符串。

isStopConflictConf

否

bool

强制结束和当前VMR会议资源冲突的会议（必须是vmr资源的拥有者才有权限，否则无效）。
表2 HWMOpenExternBaseJoinConfParamModel参数说明

参数

是否必须

类型

描述

confId

是

string

会议ID。

nickname

否

string

会议昵称。在已登录状态下可为空，已登录时为空将使用登录的用户名作为会场名。匿名入会必须传该名字或者提前设置会场名。

isCamOn

否

boolean

是否开启摄像头。

isMicOn

否

boolean

是否开启麦克风。

isSpkOn

否

boolean

是否开启扬声器。

返回值

表3 HWMJoinConfByIdResult参数说明

参数

类型

描述

result

SDKERR

接口调用结果，HWM_SDKERR_SUCCESS表示成功，详细请参考错误码参考。

reasonDesc

string

错误描述。

示例代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
 
// 通过会议ID加入会议
handleJoinConfById() {
    const externModel: HWMOpenExternBaseJoinConfParamModel = {
      confId: this.confId,
      isCamOn: this.camOn,
      isMicOn: this.micOn,
      isSpkOn: this.spkOn,
      nickname: this.nickName
    }
    const model: HWMOpenJoinConfByIdParamModel = {
      externBaseJoinConfParam: externModel,
      confPassword: this.pwd
    }
    UISDK.getConfCtrlApi().joinConf(model).then((res: HWMJoinConfByIdResult) => {
      const message: string = res.result === SDKERR.HWM_SDKERR_SUCCESS ? '加入会议成功' : '加入会议失败' + res.result;
      console.log(message);
    })
}
父主题： 会议控制

相关文档