Creating a Meeting
createConf
API Description
This API is used to create an instant meeting.
Precautions
- By default, this API enables you to join a meeting as a host. During API calling, there is no need to add your information to the participant parameters.
- If other participants need to be invited, their information needs to be transferred.
- Meeting recording must be enabled if automatic recording is enabled.
- The meeting creation result can be obtained by calling the callback API.
Method Definition
1
|
- (void)createConf:(HWMCreateConfParam * _Nonnull)param callback:( _Nonnull HWMSDKCreateConfCompleteHandler)callback; |
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
subject |
Yes |
NSString * |
Definition Meeting topic. Constraints N/A Range 0 to 128 characters. Default Value N/A |
confType |
Yes |
Definition Meeting media type. Constraints N/A Default Value HWMConfTypeAudio: voice meeting. |
|
needPassword |
No |
BOOL |
Definition Whether a password is required. Constraints Valid only for meetings with a random ID. Default Value NO |
guestPwd |
No |
NSSting * |
Definition Guest password. Constraints If this parameter is left blank, the server randomly generates a value. Valid only for meetings with a random ID. Range 0 to 64 characters. Default Value N/A |
members |
No |
NSArray <HWMCreateConfMember *> * |
Definition Participant list (optional). Constraints N/A Default Value N/A |
isCameraOn |
No |
BOOL |
Definition Whether to enable the camera. Constraints N/A Default Value NO: disabled. |
isMicOn |
No |
BOOL |
Definition Whether to enable the microphone. Constraints N/A Default Value YES: enabled. |
isRecordOn |
No |
BOOL |
Definition Whether to enable recording. Constraints Valid only for cloud recording, not for local recording on clients. Default Value NO: disabled. |
isAutoRecord |
No |
BOOL |
Definition Whether to enable automatic meeting recording. Constraints Valid only for cloud recording, not for local recording on clients. Meeting recording must be enabled if automatic recording is enabled. Default Value NO: disabled. |
vmrId |
No |
NSString * |
Definition ID of the personal meeting or cloud meeting room. Constraints Required when the personal meeting is created or a cloud meeting room is used. In other cases, leave this parameter blank. Range 0 to 128 characters. Default Value N/A |
vmrIdType |
No |
Definition Type of the cloud meeting room ID (fixed/random). Constraints N/A Default Value HWMVmrIdType: fixed. |
|
joinConfRestrictionType |
No |
Definition Users who can join the meeting. Constraints N/A Default Value HWMJoinConfRestrictionAll: everyone. |
|
isOpenWaitingRoom |
No |
BOOL |
Definition Waiting room status. Constraints Takes effect only after the waiting room function is enabled. Default Value NO: disabled. |
customInfo |
No |
NSString * |
Definition User-defined information (meeting details and in-meeting chat messages). Constraints N/A Range 0 to 64 characters. Default Value N/A |
isSpeakerOff |
No |
BOOL |
Definition Whether to mute speakers. Constraints N/A Default Value NO: enabled. |
concurrentParticipants |
No |
NSUInteger |
Definition Maximum number of participants in the meeting. Constraints N/A Range N/A Default Value If this parameter is left blank, there is no restriction. |
autoMuteMode |
No |
Definition Whether to automatically mute personal client users when they join the meeting. Constraints N/A Default Value HWMAutoMuteTypeDefault: same as the default configuration. |
|
hardTerminalAutoMuteMode |
No |
Definition Whether to automatically mute meeting room device users when they join the meeting. Constraints N/A Default Value HWMAutoMuteTypeDefault: same as the default configuration. |
|
confResType |
No |
Definition Meeting resource type. Constraints N/A Default Value HWMSDKConfRestypeDefault: default type. |
|
defaultSummaryState |
No |
Definition Initial state of whether cloud recording contains minutes. Constraints Valid only when the enterprise configuration supports smart meeting minutes (corpEnableSummary). For details, see Notifications of Enterprise Configuration Information. Default Value HWMSDKSummaryStateClose: disabled. |
|
autoPublishSummary |
No |
BOOL |
Definition Whether to automatically release minutes (without manual review). Constraints N/A Default Value NO: Minutes are not automatically released. |
Enumerated Value |
Description |
---|---|
HWMConfTypeAudio |
Voice meeting. |
HWMConfTypeVideo |
Video meeting. |
HWMConfTypeAudioAndData |
Voice data meeting that supports screen sharing. |
HWMConfTypeVideoData |
Video data meeting that supports screen sharing. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
NSString * |
Definition Participant name. Constraints N/A Range 0 to 256 characters. Default Value N/A |
number |
Yes |
NSString * |
Definition Number. Constraints If this parameter is set to the SIP number (for example, +99111244216210249) allocated to the account, the Huawei Cloud Meeting app is called. If this parameter is set to a PSTN number (for example, 18700000000), the number is called through the VoIP gateway if the enterprise has enabled PSTN call. This parameter is used for account and password authentication. Either this parameter or thirdUserId must be set. Range 0 to 128 characters. Default Value N/A |
thirdUserId |
Yes |
NSString * |
Definition Third-party user ID. Constraints For app ID authentication. Either this parameter or number must be set. Range 0 to 128 characters. Default Value N/A |
accountId |
No |
NSString * |
Definition User UUID. Constraints N/A Range 0 to 128 characters. Default Value N/A |
orgId |
No |
NSString * |
Definition Enterprise ID. Constraints N/A Range 0 to 32 characters. Default Value N/A |
type |
No |
Definition User type. Constraints N/A Default Value HWMConfAttendeeTypeNormal: client. |
Enumerated Value |
Description |
---|---|
HWMAutoMuteTypeDefault |
Default. |
HWMAutoMuteTypeMute |
Mute. |
HWMAutoMuteTypeUnmute |
Unmute. |
Enumerated Value |
Description |
---|---|
HWMSDKConfRestypeDefault |
Default. |
HWMSDKConfRestypeShareVmr |
Shared cloud meeting room. |
Enumerated Value |
Description |
---|---|
HWMSDKSummaryStateClose |
Disabled. |
HWMSDKSummaryStateOpen |
Enabled. |
Return Values
None
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 |
/// Create a meeting. - (void)creatMeeting { HWMCreateConfParam *param = [[HWMCreateConfParam alloc] init]; param.subject = @"Meeting topic"; param.confType = HWMConfTypeVideoData; param.needPassword = YES; // Whether a password is required for a meeting. By default, no password is required. param.isCameraOn = YES; // Whether to turn on the camera. By default, the camera is turned off. param.isMicOn = YES; // Whether to turn on the microphone. By default, the microphone is turned on. param.isRecordOn = NO; // Whether to enable the meeting recording function. By default, this function is disabled. param.joinConfRestrictionType = HWMJoinConfRestrictionAll;// Users who are allowed to join the meeting. param.joinConfRestrictionType = NO;// Whether to enable the waiting room. // Participant list. 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(@"Create meeting failed.%@", error.localizedDescription); }else{ NSLog(@"Meeting created."); } }]; } |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot