更新时间:2024-09-13 GMT+08:00

创建会议

createConf

接口描述

该接口用于创建即时会议。

注意事项

  1. 该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息。
  2. 若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。
  3. 创会结果在callback中返回。

方法定义

1
- (void)createConf:(HWMCreateConfParam * _Nonnull)param callback:( _Nonnull HWMSDKCreateConfCompleteHandler)callback;

参数描述

表1 HWMCreateConfParam参数说明

参数

是否必须

类型

描述

subject

NSString *

会议主题。

members

NSArray <HWMAttendeeInfo*> *

成员列表,可选

isCameraOn

BOOL

是否打开摄像头,默认关闭

isMicOn

BOOL

是否打开麦克风,默认打开

isAutoRecord

BOOL

会议开始后是否自动开启录制,默认关闭。开启自动录制会议时必须开启录制会议

vmrId

NSString *

个人会议或者云会议室Id,创建个人会议或云会议室的时候传入,其它时候传入空

callInRestrictionType

HWMJoinConfRestrictionType

允许入会范围限制

noPassword

BOOL

会议是否无密码,默认为否(只针对随机VMR会议有效)

guestPwd

NSString

指定来宾入会密码,默认空表示随机生成密码(只针对随机VMR会议有效)

isVideo

BOOL

是否创建视频会议,默认是YES。选NO则创建语音会议

vmrConfIdType

HWMVmrConfIdType

云会议室的会议ID类型,默认固定类型

isOpenWaitingRoom

BOOL

是否开启等候室

说明:

需要等候室功能开通后才能生效。

customInfo

NSString *

自定义信息(会议详情、会中消息推送可以查看)

concurrentParticipants

NSUInteger

会议最大与会人数,默认0

confResType

HWMConfResType

会议资源类型

autoMuteMode

HWMAutoMuteType

来宾入会,软终端是否自动静音。

hardTerminalAutoMuteMode

HWMAutoMuteType

来宾入会,硬终端是否自动静音。

表2 HWMAttendeeInfo 参数说明

参数

是否必须

类型

描述

name

NSString

与会者名字

number

NSString

Sip呼叫号码或者电话号码(

账号、密码鉴权场景情况下必填)

thirdUserId

NSString

APPID登录场景下的第三方账号(

第三方用户账号 AppID鉴权方式下 必填

accountId

NSString

用户登录账号(

若为用户名/密*码登录场景 必填)

email

NSString

电子邮箱地址

sms

NSString

短信通知手机号码

mute

BOOL

是否闭音

role

HWMConfRoleType

会议成员角色

表3 枚举HWMConfResType说明

枚举值

描述

HWMSDKConfRestypeDefault

默认。

HWMSDKConfRestypeShareVmr

共享vmr。

表4 枚举HWMAutoMuteType说明

枚举值

描述

HWMSDKAutoMuteTypeDefault

默认。

HWMSDKAutoMuteTypeMute

静音。

HWMSDKAutoMuteTypeUnmute

非静音。

返回值

示例代码
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
/// 创建会议
- (void)creatMeeting {
    HWMCreateConfParam *param = [[HWMCreateConfParam alloc] init];
    param.subject = @"会议标题";
    param.isCameraOn = YES;// 是否打开摄像头, 默认关闭
    param.isMicOn = YES;// 是否打开麦克风, 默认打开
    param.isAutoRecord = NO;// 是否打开会议自动录制, 默认关闭
    param.joinConfRestrictionType = HWMJoinConfRestrictionAll;// 允许入会范围

    [[HWMSdk getOpenApi] createConf:param callback:^(NSError * _Nullable error, HWMCreateConfResult * _Nullable result) {
        [self hideLoading];
        if (error) {
            NSLog(@"创会失败%@", error.localizedDescription);
        }else{
            NSLog(@"创会成功");
        }
    }];
}