创建会议
createConf
接口描述
该接口用于创建即时会议。
注意事项
- 该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息。
- 若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。
- 开启自动录制会议时必须开启录制会议。
- 创会结果在callback中返回。
方法定义
1
|
- (void)createConf:(HWMCreateConfParam * _Nonnull)param callback:( _Nonnull HWMSDKCreateConfCompleteHandler)callback; |
参数描述
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
subject |
是 |
NSString * |
参数解释: 会议主题。 约束限制: 不涉及。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
confType |
是 |
参数解释: 会议媒体类型。 约束限制: 不涉及。 默认取值: HWMConfTypeAudio 语音会议。 |
|
needPassword |
否 |
BOOL |
参数解释: 会议是否需要设置密码。 约束限制: 仅对随机会议ID生效。 默认取值: NO 不需要会议密码。 |
guestPwd |
否 |
NSSting * |
参数解释: 来宾密码。 约束限制: 如果空则服务器随机生成。仅对随机会议ID生效。 取值范围: 0-64个字符。 默认取值: 不涉及。 |
members |
否 |
NSArray <HWMCreateConfMember *> * |
参数解释: 成员列表,可选。 约束限制: 不涉及。 默认取值: 不涉及。 |
isCameraOn |
否 |
BOOL |
参数解释: 是否打开摄像头。 约束限制: 不涉及。 默认取值: NO 关闭。 |
isMicOn |
否 |
BOOL |
参数解释: 是否打开麦克风。 约束限制: 不涉及。 默认取值: YES 打开。 |
isRecordOn |
否 |
BOOL |
参数解释: 录制会议开关。 约束限制: 仅对云录制生效,客户端本地录制不生效。 默认取值: NO 不开启录制。 |
isAutoRecord |
否 |
BOOL |
参数解释: 是否开启自动录制会议。 约束限制: 仅对云录制生效,客户端本地录制不生效。开启自动录制会议时必须开启录制会议。 默认取值: NO 不开启自动录制会议。 |
vmrId |
否 |
NSString * |
参数解释: 个人会议或者云会议室Id。 约束限制: 创建个人会议或云会议室的时候传入,其它时候传入空。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
vmrIdType |
否 |
参数解释: VMR ID类型(固定/随机)。 约束限制: 不涉及。 默认取值: HWMVmrIdType 固定类型。 |
|
joinConfRestrictionType |
否 |
参数解释: 允许入会范围限制。 约束限制: 不涉及。 默认取值: HWMJoinConfRestrictionAll 所有用户。 |
|
isOpenWaitingRoom |
否 |
BOOL |
参数解释: 等候室开启开关。 约束限制: 需要等候室功能开通后才能生效。 默认取值: NO 不开启等候室。 |
customInfo |
否 |
NSString * |
参数解释: 自定信息(会议详情、会中消息推送可以查看)。 约束限制: 不涉及。 取值范围: 0-64个字符。 默认取值: 不涉及。 |
isSpeakerOff |
否 |
BOOL |
参数解释: 是否关闭扬声器。 约束限制: 不涉及。 默认取值: NO 不关闭。 |
concurrentParticipants |
否 |
NSUInteger |
参数解释: 会议方数,会议最大与会人数限制。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不填则不限制 |
autoMuteMode |
否 |
参数解释: 个人客户端入会是否自动静音。 约束限制: 不涉及。 默认取值: HWMAutoMuteTypeDefault 与默认配置一致。 |
|
hardTerminalAutoMuteMode |
否 |
参数解释: 会议室设备入会是否自动静音。 约束限制: 不涉及。 默认取值: HWMAutoMuteTypeDefault 与默认配置一致。 |
|
confResType |
否 |
参数解释: 会议资源类型。 约束限制: 不涉及。 默认取值: HWMSDKConfRestypeDefault 默认。 |
|
defaultSummaryState |
否 |
参数解释: 会议云录制是否包含纪要,初始值。 约束限制: 仅企业配置支持智能会议纪要时生效(corpEnableSummary),参考企业配置信息通知。 默认取值: HWMSDKSummaryStateClose 会议纪要关闭。 |
|
autoPublishSummary |
否 |
BOOL |
参数解释: 是否自动发布纪要(免人工审核)。 约束限制: 不涉及。 默认取值: NO 不自动发布纪要。 |
枚举值 |
描述 |
---|---|
HWMConfTypeAudio |
音频会议。 |
HWMConfTypeVideo |
视频会议。 |
HWMConfTypeAudioAndData |
音频数据会议,支持屏幕共享能力。 |
HWMConfTypeVideoData |
视频数据会议, 支持屏幕共享能力。 |
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
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 * |
参数解释: 用户UUID。 约束限制: 不涉及。 取值范围: 0-128个字符。 默认取值: 不涉及。 |
orgId |
否 |
NSString * |
参数解释: 企业id。 约束限制: 不涉及。 取值范围: 0-32个字符。 默认取值: 不涉及。 |
type |
否 |
参数解释: 用户类型。 约束限制: 不涉及。 默认取值: HWMConfAttendeeTypeNormal 会议软终端用户。 |
枚举值 |
描述 |
---|---|
HWMAutoMuteTypeDefault |
默认 |
HWMAutoMuteTypeMute |
静音 |
HWMAutoMuteTypeUnmute |
非静音 |
返回值
无
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
/// 创建会议 - (void)creatMeeting { HWMCreateConfParam *param = [[HWMCreateConfParam alloc] init]; param.subject = @"会议标题"; param.confType = HWMConfTypeVideoData; param.needPassword = YES;// 会议是否需要设置密码,默认不需要 param.isCameraOn = YES;// 是否打开摄像头, 默认关闭 param.isMicOn = YES;// 是否打开麦克风, 默认打开 param.isRecordOn = NO;// 是否打开会议录制, 默认关闭 param.joinConfRestrictionType = HWMJoinConfRestrictionAll;// 允许入会范围 param.joinConfRestrictionType = NO;// 是否开启等候室 // 与会者列表 if (self.selectedMemebrs) { __block NSMutableArray *members = [[NSMutableArray alloc] init]; [self.selectedMemebrs enumerateObjectsUsingBlock:^(HWMContactSelectedModel * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) { HWMCreateConfMember *member = [[HWMCreateConfMember alloc] init]; member.accoundId = obj.accountId; member.number = obj.number; member.name = obj.name; member.thirdUserId = obj.thirdUserId; [members addObject:member]; }]; param.members = members; } [[HWMSdk getOpenApi] createConf:param callback:^(NSError * _Nullable error, HWMCreateConfResult * _Nullable result) { [self hideLoading]; if (error) { NSLog(@"创会失败%@", error.localizedDescription); }else{ NSLog(@"创会成功"); } }]; } |