Obtaining Meeting Details
GetConfDetail
API Description
This API is used to obtain meeting details.
Precautions
- Call this API after login.
- This API is an asynchronous API. The return value only indicates whether the API is successfully called. The actual service processing result is returned in the corresponding callback function.
Method Definition
1
|
HWM_SDK_AGENT_API hwmsdk::HwmErrCode GetConfDetail(const char confId[HWM_MAX_CONF_ID_LEN]); |
Callback Function
1
|
virtual void OnGetConfDetail(hwmsdk::HwmErrCode ret, const char* reason, const HwmConfDetail* vmrInfoList) {}; |
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
confId |
Yes |
char[] |
Meeting ID. |
Type |
Description |
---|---|
HwmErrCode |
If 0 is returned, the operation is successful. If other values are returned, the operation fails. For details about values returned upon failures, see Common Error Codes. |
Parameter |
Type |
Description |
---|---|---|
confListInfo |
HwmConfListInfo |
Meeting details. For details, see Table 3. |
vmrFlag |
bool |
Whether the meeting is held in a cloud meeting room. |
vmrId |
char[] |
Unique cloud meeting room ID. |
isRecordOn |
bool |
Whether recording is supported. |
isLiveOn |
bool |
Reserved field. This parameter is transparently transmitted during meeting modification. |
isAutoRecord |
bool |
Whether to enable automatic meeting recording. |
isGuestFreePwd |
bool |
Whether a guest can join the meeting without the password. |
isMailOn |
bool |
Whether to send email notifications. |
isSmsOn |
bool |
Whether to send SMS notifications. |
isEmailCalenderOn |
bool |
Whether to send calendar notifications. |
joinConfRestrictionType |
HwmJoinConfPermissionType |
Participants who are allowed to join the meeting. For details, see Table 3. |
attendees |
HwmAttendeeInfo* |
Participant list. For details about the fields, see Scheduling a Meeting. You can query only the participants added during meeting scheduling and the participants invited by the host during the meeting. If a participant proactively joins the meeting, this interface cannot be queried. |
attendeeLen |
unsigned int |
Number of participants. |
confServerType |
HwmConfServerType |
Meeting server type. 1: RTC. 0: MCU. |
isOpenWaitingRoom |
bool |
Whether to enable the waiting room. |
vmrConfIdType |
HwmVmrConfIdType |
Meeting ID type of the cloud meeting room. For details, see HwmVmrConfIdType. |
allowGuestStartConf |
bool |
Whether to allow guests to join the meeting ahead of the host. |
allowGuestStartConfTime |
unsigned int |
Time range for guests to join the meeting in advance, in minutes. 0: anytime before the scheduled time. n: n minutes before the scheduled time. |
concurrentParticipants |
unsigned int |
Maximum number of participants in the meeting. The value 0 indicates that the number of participants is not limited. |
defaultSummaryState |
Initial state of whether the cloud recording contains minutes. |
|
autoMuteMode |
Whether soft client guests are automatically muted when they join the meeting. |
|
hardTerminalAutoMuteMode |
Whether hard terminal guests are automatically muted when they join the meeting. |
Sample Code
1 2 3 4 5 6 7 8 |
/** * Obtain meeting details. */ int demoEditConfDlg::GetConfDetail() { int ret =hwmsdkagent::GetConfDetail(GetConfID().c_str()); // Use the meeting ID to query meeting details. return ret; } |
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