创建会议
createConf
接口描述
该接口用于创建即时会议。
注意事项
- 该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息。
- 若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。
- 创会结果在callback中返回。
方法定义
1
|
- (void)createConf:(HWMCreateConfParam * _Nonnull)param callback:( _Nonnull HWMSDKCreateConfCompleteHandler)callback; |
参数描述
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
subject |
是 |
NSString * |
参数解释: 会议主题。 约束限制: 不涉及。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
members |
否 |
NSArray <HWMAttendeeInfo*> * |
参数解释: 成员列表,可选。 约束限制: 不涉及。 默认取值: 不涉及。 |
isCameraOn |
否 |
BOOL |
参数解释: 是否打开摄像头。 约束限制: 不涉及。 默认取值: NO 关闭。 |
isMicOn |
否 |
BOOL |
参数解释: 是否打开麦克风。 约束限制: 不涉及。 默认取值: YES 打开。 |
isAutoRecord |
否 |
BOOL |
参数解释: 是否开启自动录制会议。 约束限制: 仅对云录制生效,客户端本地录制不生效。开启自动录制会议时必须开启录制会议。 默认取值: NO 关闭。 |
isRecordOn |
否 |
BOOL |
参数解释: 是否开启录制会议。 约束限制: 仅对云录制生效,客户端本地录制不生效。 默认取值: NO 关闭。 |
vmrId |
否 |
NSString * |
参数解释: 个人会议或者云会议室Id。 约束限制: 创建个人会议或云会议室的时候传入,其它时候传入空。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
callInRestrictionType |
否 |
参数解释: 允许入会范围限制。 约束限制: 不涉及。 默认取值: HWMJoinConfRestrictionAll 所有用户。 |
|
noPassword |
否 |
BOOL |
参数解释: 会议是否无密码。 约束限制: 仅对随机会议ID生效。 默认取值: NO 有密码。 |
guestPwd |
否 |
NSString |
参数解释: 来宾密码。 约束限制: 如果空则服务器随机生成。仅对随机会议ID生效。 取值范围: 0-64个字符。 默认取值: 不涉及。 |
isVideo |
否 |
BOOL |
参数解释: 是否创建视频会议。 约束限制: 不涉及。 默认取值: YES 视频会议。 |
vmrConfIdType |
否 |
参数解释: 云会议室的会议ID类型。 约束限制: 不涉及。 默认取值: HWMVmrConfIdTypeFixed 默认固定类型。 |
|
isOpenWaitingRoom |
否 |
BOOL |
参数解释: 是否开启等候室。 约束限制: 需要等候室功能开通后才能生效。 默认取值: NO 不开启等候室。 |
customInfo |
否 |
NSString * |
参数解释: 自定信息(会议详情、会中消息推送可以查看)。 约束限制: 不涉及。 取值范围: 0-64个字符。 默认取值: 不涉及。 |
concurrentParticipants |
否 |
NSUInteger |
参数解释: 会议方数,会议最大与会人数限制。 约束限制: 不涉及。 取值范围:
默认取值: 不填则不限制。 |
confResType |
否 |
参数解释: 会议资源类型。 约束限制: 不涉及。 默认取值: HWMSDKConfRestypeDefault 默认。 |
|
autoMuteMode |
否 |
参数解释: 来宾入会,软终端是否自动静音。 约束限制: 不涉及。 默认取值: HWMSDKAutoMuteTypeDefault 与默认配置一致。 |
|
hardTerminalAutoMuteMode |
否 |
参数解释: 来宾入会,硬终端是否自动静音。 约束限制: 不涉及。 默认取值: HWMSDKAutoMuteTypeDefault 与默认配置一致。 |
|
defaultSummaryState |
否 |
参数解释: 会议云录制是否包含纪要,初始值。 约束限制: 仅企业配置支持智能会议纪要时生效(corpEnableSummary),参考企业配置信息。 默认取值: HWMSDKSummaryStateClose 会议纪要关闭。 |
|
autoPublishSummary |
否 |
BOOL |
参数解释: 是否自动发布纪要(免人工审核)。 约束限制: 不涉及。 默认取值: NO 不自动发布纪要。 |
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
name |
是 |
NSString |
参数解释: 与会者名称。 约束限制: 不涉及。 取值范围: 0-256个字符。 默认取值: 不涉及。 |
number |
否 |
NSString |
参数解释: 号码。 约束限制: 如果填分配给账号的sip号码(如+99111244216210249)则呼叫该账号的App;如果填PSTN号码(如18700000000),则通过VoIP网关呼叫该号码,前提是该企业已开通PSTN呼叫权限。与thirdUserId二选一,账号密码鉴权时使用。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
thirdUserId |
否 |
NSString |
参数解释: 第三方用户ID。 约束限制: 与number二选一,App ID鉴权时使用。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
accountId |
否 |
NSString |
参数解释: 用户登录账号。 约束限制: 若为用户名/密码登录场景 必填。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
|
否 |
NSString |
参数解释: 电子邮箱地址,用于发送邮件通知。 约束限制: 不涉及。 取值范围: 0-256个字符。 默认取值: 不涉及。 |
sms |
否 |
NSString |
参数解释: 短信通知手机号码,用于发送短信通知。 约束限制: 不涉及。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
mute |
否 |
BOOL |
参数解释: 是否闭音。 约束限制: 不涉及。 默认取值: NO 不静音。 |
role |
否 |
参数解释: 会议角色。 约束限制: 不涉及。 默认取值: HWMConfRoleTypeAttendee 普通与会者。 |
|
orgId |
否 |
NSString |
参数解释: 用于识别是否是本企业账号(仅用于获取与会者列表使用)。 |
枚举值 |
描述 |
---|---|
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(@"创会成功"); } }]; } |